diff --git a/CHANGELOG.md b/CHANGELOG.md index a9faf2b24..f7447fdc7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,16 @@ Change Log ========== +## Version 0.28.0 +_2018-06-12_ + +This release regenerates all services. It includes updates to the documentation and some minor new service features. + +This release includes the following new features and bug fixes: + +- Adds support for the new Language Translator V3 service and deprecates Language Translator V2 +- Fix for issue 833 + ## Version 0.27.0 _2018-05-28_ diff --git a/README.md b/README.md index 5255833dc..ed6dc38da 100755 --- a/README.md +++ b/README.md @@ -37,7 +37,8 @@ There are many resources to help you build your first cognitive application with * [Assistant](#assistant) * [Discovery](#discovery) -* [Language Translator](#language-translator) +* [Language Translator V2](#language-translator-v2) +* [Language Translator V3](#language-translator-v3) * [Natural Language Classifier](#natural-language-classifier) * [Natural Language Understanding](#natural-language-understanding) * [Personality Insights](#personality-insights) @@ -93,7 +94,7 @@ Add the following to your `Package.swift` file to identify the Swift SDK as a de ```swift dependencies: [ - .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0") + .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0") ] ``` @@ -404,7 +405,7 @@ The following links provide more information about the IBM Discovery service: * [IBM Discovery - Documentation](https://console.bluemix.net/docs/services/discovery/index.html) * [IBM Discovery - Demo](https://discovery-news-demo.ng.bluemix.net/) -## Language Translator +## Language Translator V2 The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another. @@ -425,6 +426,28 @@ languageTranslator.translate(request: request, failure: failure) { } ``` +## Language Translator V3 + +The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another. + +The following example demonstrates how to use the Language Translator service: + +```swift +import LanguageTranslatorV3 + +let username = "your-username-here" +let password = "your-password-here" +let version = "yyyy-mm-dd" // use today's date for the most recent version +let languageTranslator = LanguageTranslator(username: username, password: password, version: version) + +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} +``` + The following links provide more information about the IBM Watson Language Translator service: * [IBM Watson Language Translator - Service Page](https://www.ibm.com/watson/services/language-translator/) diff --git a/Source/AssistantV1/Assistant.swift b/Source/AssistantV1/Assistant.swift index 52faf7a19..2084d7590 100644 --- a/Source/AssistantV1/Assistant.swift +++ b/Source/AssistantV1/Assistant.swift @@ -17,8 +17,8 @@ import Foundation /** - The IBM Watson Assistant service combines machine learning, natural language understanding, and integrated dialog tools - to create conversation flows between your apps and your users. + The IBM Watson™ Assistant service combines machine learning, natural language understanding, and integrated + dialog tools to create conversation flows between your apps and your users. */ public class Assistant { @@ -116,13 +116,14 @@ public class Assistant { /** Get response to user input. - Get a response to a user's input. There is no rate limit for this operation. + Get a response to a user's input. + There is no rate limit for this operation. - parameter workspaceID: Unique identifier of the workspace. - - parameter request: The message to be sent. This includes the user's input, along with optional intents, entities, and context from the - last response. - - parameter nodesVisitedDetails: Whether to include additional diagnostic information about the dialog nodes that were visited during processing of - the message. + - parameter request: The message to be sent. This includes the user's input, along with optional intents, entities, and context from + the last response. + - parameter nodesVisitedDetails: Whether to include additional diagnostic information about the dialog nodes that were visited during processing + of the message. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -185,13 +186,13 @@ public class Assistant { /** List workspaces. - List the workspaces associated with a Watson Assistant service instance. This operation is limited to 500 - requests per 30 minutes. For more information, see **Rate limiting**. + List the workspaces associated with a Watson Assistant service instance. + This operation is limited to 500 requests per 30 minutes. For more information, see **Rate limiting**. - parameter pageLimit: The number of records to return in each page of results. - parameter includeCount: Whether to include information about the number of records returned. - parameter sort: The attribute by which returned results will be sorted. To reverse the sort order, prefix the value with a minus - sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. + sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. - parameter cursor: A token identifying the page of results to retrieve. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. @@ -262,11 +263,12 @@ public class Assistant { Create workspace. Create a workspace based on component objects. You must provide workspace components defining the content of the - new workspace. This operation is limited to 30 requests per 30 minutes. For more information, see **Rate - limiting**. + new workspace. + This operation is limited to 30 requests per 30 minutes. For more information, see **Rate limiting**. - - parameter properties: The content of the new workspace. The maximum size for this data is 50MB. If you need to import a larger - workspace, consider importing the workspace without intents and entities and then adding them separately. + - parameter properties: The content of the new workspace. + The maximum size for this data is 50MB. If you need to import a larger workspace, consider importing the + workspace without intents and entities and then adding them separately. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -318,13 +320,13 @@ public class Assistant { /** Get information about a workspace. - Get information about a workspace, optionally including all workspace content. With **export**=`false`, this - operation is limited to 6000 requests per 5 minutes. With **export**=`true`, the limit is 20 requests per 30 - minutes. For more information, see **Rate limiting**. + Get information about a workspace, optionally including all workspace content. + With **export**=`false`, this operation is limited to 6000 requests per 5 minutes. With **export**=`true`, the + limit is 20 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only - information about the element itself. If **export**=`true`, all content, including subelements, is included. + - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes + only information about the element itself. If **export**=`true`, all content, including subelements, is included. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. @@ -385,18 +387,19 @@ public class Assistant { Update workspace. Update an existing workspace with new or modified data. You must provide component objects defining the content of - the updated workspace. This operation is limited to 30 request per 30 minutes. For more information, see **Rate - limiting**. + the updated workspace. + This operation is limited to 30 request per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - - parameter properties: Valid data defining the new and updated workspace content. The maximum size for this data is 50MB. If you need - to import a larger amount of workspace data, consider importing components such as intents and entities using - separate operations. + - parameter properties: Valid data defining the new and updated workspace content. + The maximum size for this data is 50MB. If you need to import a larger amount of workspace data, consider + importing components such as intents and entities using separate operations. - parameter append: Whether the new data is to be appended to the existing data in the workspace. If **append**=`false`, elements - included in the new data completely replace the corresponding existing elements, including all subelements. For - example, if the new data includes **entities** and **append**=`false`, all existing entities in the workspace are - discarded and replaced with the new entities. If **append**=`true`, existing elements are preserved, and the new - elements are added. If any elements in the new data collide with existing elements, the update request fails. + included in the new data completely replace the corresponding existing elements, including all subelements. For + example, if the new data includes **entities** and **append**=`false`, all existing entities in the workspace are + discarded and replaced with the new entities. + If **append**=`true`, existing elements are preserved, and the new elements are added. If any elements in the new + data collide with existing elements, the update request fails. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -459,8 +462,8 @@ public class Assistant { /** Delete workspace. - Delete a workspace from the service instance. This operation is limited to 30 requests per 30 minutes. For more - information, see **Rate limiting**. + Delete a workspace from the service instance. + This operation is limited to 30 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter headers: A dictionary of request headers to be sent with this request. @@ -511,17 +514,17 @@ public class Assistant { /** List intents. - List the intents for a workspace. With **export**=`false`, this operation is limited to 2000 requests per 30 - minutes. With **export**=`true`, the limit is 400 requests per 30 minutes. For more information, see **Rate - limiting**. + List the intents for a workspace. + With **export**=`false`, this operation is limited to 2000 requests per 30 minutes. With **export**=`true`, the + limit is 400 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only - information about the element itself. If **export**=`true`, all content, including subelements, is included. + - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes + only information about the element itself. If **export**=`true`, all content, including subelements, is included. - parameter pageLimit: The number of records to return in each page of results. - parameter includeCount: Whether to include information about the number of records returned. - parameter sort: The attribute by which returned results will be sorted. To reverse the sort order, prefix the value with a minus - sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. + sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. - parameter cursor: A token identifying the page of results to retrieve. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. @@ -602,15 +605,16 @@ public class Assistant { /** Create intent. - Create a new intent. This operation is limited to 2000 requests per 30 minutes. For more information, see **Rate - limiting**. + Create a new intent. + This operation is limited to 2000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - - parameter intent: The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode - alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix `sys-`. - It - must be no longer than 128 characters. - - parameter description: The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must - be no longer than 128 characters. + - parameter intent: The name of the intent. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. + - It cannot begin with the reserved prefix `sys-`. + - It must be no longer than 128 characters. + - parameter description: The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it + must be no longer than 128 characters. - parameter examples: An array of user input examples for the intent. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. @@ -672,14 +676,14 @@ public class Assistant { /** Get intent. - Get information about an intent, optionally including all intent content. With **export**=`false`, this - operation is limited to 6000 requests per 5 minutes. With **export**=`true`, the limit is 400 requests per 30 - minutes. For more information, see **Rate limiting**. + Get information about an intent, optionally including all intent content. + With **export**=`false`, this operation is limited to 6000 requests per 5 minutes. With **export**=`true`, the + limit is 400 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter intent: The intent name. - - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only - information about the element itself. If **export**=`true`, all content, including subelements, is included. + - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes + only information about the element itself. If **export**=`true`, all content, including subelements, is included. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. @@ -741,14 +745,15 @@ public class Assistant { Update intent. Update an existing intent with new or modified data. You must provide component objects defining the content of the - updated intent. This operation is limited to 2000 requests per 30 minutes. For more information, see **Rate - limiting**. + updated intent. + This operation is limited to 2000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter intent: The intent name. - - parameter newIntent: The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode - alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix `sys-`. - It - must be no longer than 128 characters. + - parameter newIntent: The name of the intent. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. + - It cannot begin with the reserved prefix `sys-`. + - It must be no longer than 128 characters. - parameter newDescription: The description of the intent. - parameter newExamples: An array of user input examples for the intent. - parameter headers: A dictionary of request headers to be sent with this request. @@ -812,8 +817,8 @@ public class Assistant { /** Delete intent. - Delete an intent from a workspace. This operation is limited to 2000 requests per 30 minutes. For more - information, see **Rate limiting**. + Delete an intent from a workspace. + This operation is limited to 2000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter intent: The intent name. @@ -866,15 +871,15 @@ public class Assistant { /** List user input examples. - List the user input examples for an intent. This operation is limited to 2500 requests per 30 minutes. For more - information, see **Rate limiting**. + List the user input examples for an intent. + This operation is limited to 2500 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter intent: The intent name. - parameter pageLimit: The number of records to return in each page of results. - parameter includeCount: Whether to include information about the number of records returned. - parameter sort: The attribute by which returned results will be sorted. To reverse the sort order, prefix the value with a minus - sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. + sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. - parameter cursor: A token identifying the page of results to retrieve. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. @@ -951,14 +956,15 @@ public class Assistant { /** Create user input example. - Add a new user input example to an intent. This operation is limited to 1000 requests per 30 minutes. For more - information, see **Rate limiting**. + Add a new user input example to an intent. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter intent: The intent name. - - parameter text: The text of a user input example. This string must conform to the following restrictions: - It cannot contain - carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no - longer than 1024 characters. + - parameter text: The text of a user input example. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 1024 characters. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1018,8 +1024,8 @@ public class Assistant { /** Get user input example. - Get information about a user input example. This operation is limited to 6000 requests per 5 minutes. For more - information, see **Rate limiting**. + Get information about a user input example. + This operation is limited to 6000 requests per 5 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter intent: The intent name. @@ -1080,15 +1086,16 @@ public class Assistant { /** Update user input example. - Update the text of a user input example. This operation is limited to 1000 requests per 30 minutes. For more - information, see **Rate limiting**. + Update the text of a user input example. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter intent: The intent name. - parameter text: The text of the user input example. - - parameter newText: The text of the user input example. This string must conform to the following restrictions: - It cannot contain - carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no - longer than 1024 characters. + - parameter newText: The text of the user input example. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 1024 characters. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1149,8 +1156,8 @@ public class Assistant { /** Delete user input example. - Delete a user input example from an intent. This operation is limited to 1000 requests per 30 minutes. For more - information, see **Rate limiting**. + Delete a user input example from an intent. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter intent: The intent name. @@ -1206,13 +1213,13 @@ public class Assistant { List counterexamples. List the counterexamples for a workspace. Counterexamples are examples that have been marked as irrelevant input. - This operation is limited to 2500 requests per 30 minutes. For more information, see **Rate limiting**. + This operation is limited to 2500 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter pageLimit: The number of records to return in each page of results. - parameter includeCount: Whether to include information about the number of records returned. - parameter sort: The attribute by which returned results will be sorted. To reverse the sort order, prefix the value with a minus - sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. + sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. - parameter cursor: A token identifying the page of results to retrieve. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. @@ -1292,9 +1299,10 @@ public class Assistant { This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - - parameter text: The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It - cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It - must be no longer than 1024 characters. + - parameter text: The text of a user input marked as irrelevant input. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters + - It cannot consist of only whitespace characters + - It must be no longer than 1024 characters. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1479,7 +1487,7 @@ public class Assistant { Delete counterexample. Delete a counterexample from a workspace. Counterexamples are examples that have been marked as irrelevant input. - This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter text: The text of a user input counterexample (for example, `What are you wearing?`). @@ -1532,17 +1540,17 @@ public class Assistant { /** List entities. - List the entities for a workspace. With **export**=`false`, this operation is limited to 1000 requests per 30 - minutes. With **export**=`true`, the limit is 200 requests per 30 minutes. For more information, see **Rate - limiting**. + List the entities for a workspace. + With **export**=`false`, this operation is limited to 1000 requests per 30 minutes. With **export**=`true`, the + limit is 200 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only - information about the element itself. If **export**=`true`, all content, including subelements, is included. + - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes + only information about the element itself. If **export**=`true`, all content, including subelements, is included. - parameter pageLimit: The number of records to return in each page of results. - parameter includeCount: Whether to include information about the number of records returned. - parameter sort: The attribute by which returned results will be sorted. To reverse the sort order, prefix the value with a minus - sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. + sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. - parameter cursor: A token identifying the page of results to retrieve. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. @@ -1623,8 +1631,8 @@ public class Assistant { /** Create entity. - Create a new entity. This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate - limiting**. + Create a new entity. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter properties: The content of the new entity. @@ -1685,14 +1693,14 @@ public class Assistant { /** Get entity. - Get information about an entity, optionally including all entity content. With **export**=`false`, this - operation is limited to 6000 requests per 5 minutes. With **export**=`true`, the limit is 200 requests per 30 - minutes. For more information, see **Rate limiting**. + Get information about an entity, optionally including all entity content. + With **export**=`false`, this operation is limited to 6000 requests per 5 minutes. With **export**=`true`, the + limit is 200 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. - - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only - information about the element itself. If **export**=`true`, all content, including subelements, is included. + - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes + only information about the element itself. If **export**=`true`, all content, including subelements, is included. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. @@ -1754,15 +1762,15 @@ public class Assistant { Update entity. Update an existing entity with new or modified data. You must provide component objects defining the content of the - updated entity. This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate - limiting**. + updated entity. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. - parameter properties: The updated content of the entity. Any elements included in the new data will completely replace the equivalent - existing elements, including all subelements. (Previously existing subelements are not retained unless they are - also included in the new data.) For example, if you update the values for an entity, the previously existing values - are discarded and replaced with the new values specified in the update. + existing elements, including all subelements. (Previously existing subelements are not retained unless they are + also included in the new data.) For example, if you update the values for an entity, the previously existing + values are discarded and replaced with the new values specified in the update. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1821,8 +1829,8 @@ public class Assistant { /** Delete entity. - Delete an entity from a workspace. This operation is limited to 1000 requests per 30 minutes. For more - information, see **Rate limiting**. + Delete an entity from a workspace. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. @@ -1875,17 +1883,17 @@ public class Assistant { /** List entity values. - List the values for an entity. This operation is limited to 2500 requests per 30 minutes. For more information, - see **Rate limiting**. + List the values for an entity. + This operation is limited to 2500 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. - - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only - information about the element itself. If **export**=`true`, all content, including subelements, is included. + - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes + only information about the element itself. If **export**=`true`, all content, including subelements, is included. - parameter pageLimit: The number of records to return in each page of results. - parameter includeCount: Whether to include information about the number of records returned. - parameter sort: The attribute by which returned results will be sorted. To reverse the sort order, prefix the value with a minus - sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. + sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. - parameter cursor: A token identifying the page of results to retrieve. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. @@ -1967,8 +1975,8 @@ public class Assistant { /** Add entity value. - Create a new value for an entity. This operation is limited to 1000 requests per 30 minutes. For more - information, see **Rate limiting**. + Create a new value for an entity. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. @@ -2031,14 +2039,14 @@ public class Assistant { /** Get entity value. - Get information about an entity value. This operation is limited to 6000 requests per 5 minutes. For more - information, see **Rate limiting**. + Get information about an entity value. + This operation is limited to 6000 requests per 5 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. - parameter value: The text of the entity value. - - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only - information about the element itself. If **export**=`true`, all content, including subelements, is included. + - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes + only information about the element itself. If **export**=`true`, all content, including subelements, is included. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. @@ -2101,16 +2109,17 @@ public class Assistant { Update entity value. Update an existing entity value with new or modified data. You must provide component objects defining the content - of the updated entity value. This operation is limited to 1000 requests per 30 minutes. For more information, - see **Rate limiting**. + of the updated entity value. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. - parameter value: The text of the entity value. - - parameter properties: The updated content of the entity value. Any elements included in the new data will completely replace the - equivalent existing elements, including all subelements. (Previously existing subelements are not retained unless - they are also included in the new data.) For example, if you update the synonyms for an entity value, the - previously existing synonyms are discarded and replaced with the new synonyms specified in the update. + - parameter properties: The updated content of the entity value. + Any elements included in the new data will completely replace the equivalent existing elements, including all + subelements. (Previously existing subelements are not retained unless they are also included in the new data.) + For example, if you update the synonyms for an entity value, the previously existing synonyms are discarded and + replaced with the new synonyms specified in the update. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2170,8 +2179,8 @@ public class Assistant { /** Delete entity value. - Delete a value from an entity. This operation is limited to 1000 requests per 30 minutes. For more information, - see **Rate limiting**. + Delete a value from an entity. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. @@ -2226,8 +2235,8 @@ public class Assistant { /** List entity value synonyms. - List the synonyms for an entity value. This operation is limited to 2500 requests per 30 minutes. For more - information, see **Rate limiting**. + List the synonyms for an entity value. + This operation is limited to 2500 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. @@ -2235,7 +2244,7 @@ public class Assistant { - parameter pageLimit: The number of records to return in each page of results. - parameter includeCount: Whether to include information about the number of records returned. - parameter sort: The attribute by which returned results will be sorted. To reverse the sort order, prefix the value with a minus - sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. + sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. - parameter cursor: A token identifying the page of results to retrieve. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. @@ -2313,15 +2322,16 @@ public class Assistant { /** Add entity value synonym. - Add a new synonym to an entity value. This operation is limited to 1000 requests per 30 minutes. For more - information, see **Rate limiting**. + Add a new synonym to an entity value. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. - parameter value: The text of the entity value. - - parameter synonym: The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage - return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer - than 64 characters. + - parameter synonym: The text of the synonym. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2382,8 +2392,8 @@ public class Assistant { /** Get entity value synonym. - Get information about a synonym of an entity value. This operation is limited to 6000 requests per 5 minutes. - For more information, see **Rate limiting**. + Get information about a synonym of an entity value. + This operation is limited to 6000 requests per 5 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. @@ -2446,16 +2456,17 @@ public class Assistant { /** Update entity value synonym. - Update an existing entity value synonym with new text. This operation is limited to 1000 requests per 30 - minutes. For more information, see **Rate limiting**. + Update an existing entity value synonym with new text. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. - parameter value: The text of the entity value. - parameter synonym: The text of the synonym. - - parameter newSynonym: The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage - return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer - than 64 characters. + - parameter newSynonym: The text of the synonym. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2517,8 +2528,8 @@ public class Assistant { /** Delete entity value synonym. - Delete a synonym from an entity value. This operation is limited to 1000 requests per 30 minutes. For more - information, see **Rate limiting**. + Delete a synonym from an entity value. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. @@ -2575,14 +2586,14 @@ public class Assistant { /** List dialog nodes. - List the dialog nodes for a workspace. This operation is limited to 2500 requests per 30 minutes. For more - information, see **Rate limiting**. + List the dialog nodes for a workspace. + This operation is limited to 2500 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter pageLimit: The number of records to return in each page of results. - parameter includeCount: Whether to include information about the number of records returned. - parameter sort: The attribute by which returned results will be sorted. To reverse the sort order, prefix the value with a minus - sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. + sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. - parameter cursor: A token identifying the page of results to retrieve. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. @@ -2658,8 +2669,8 @@ public class Assistant { /** Create dialog node. - Create a new dialog node. This operation is limited to 500 requests per 30 minutes. For more information, see - **Rate limiting**. + Create a new dialog node. + This operation is limited to 500 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter properties: A CreateDialogNode object defining the content of the new dialog node. @@ -2720,8 +2731,8 @@ public class Assistant { /** Get dialog node. - Get information about a dialog node. This operation is limited to 6000 requests per 5 minutes. For more - information, see **Rate limiting**. + Get information about a dialog node. + This operation is limited to 6000 requests per 5 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter dialogNode: The dialog node ID (for example, `get_order`). @@ -2780,15 +2791,16 @@ public class Assistant { /** Update dialog node. - Update an existing dialog node with new or modified data. This operation is limited to 500 requests per 30 - minutes. For more information, see **Rate limiting**. + Update an existing dialog node with new or modified data. + This operation is limited to 500 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter dialogNode: The dialog node ID (for example, `get_order`). - - parameter properties: The updated content of the dialog node. Any elements included in the new data will completely replace the - equivalent existing elements, including all subelements. (Previously existing subelements are not retained unless - they are also included in the new data.) For example, if you update the actions for a dialog node, the previously - existing actions are discarded and replaced with the new actions specified in the update. + - parameter properties: The updated content of the dialog node. + Any elements included in the new data will completely replace the equivalent existing elements, including all + subelements. (Previously existing subelements are not retained unless they are also included in the new data.) + For example, if you update the actions for a dialog node, the previously existing actions are discarded and + replaced with the new actions specified in the update. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2847,8 +2859,8 @@ public class Assistant { /** Delete dialog node. - Delete a dialog node from a workspace. This operation is limited to 500 requests per 30 minutes. For more - information, see **Rate limiting**. + Delete a dialog node from a workspace. + This operation is limited to 500 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter dialogNode: The dialog node ID (for example, `get_order`). @@ -2901,15 +2913,16 @@ public class Assistant { /** List log events in a workspace. - List the events from the log of a specific workspace. If **cursor** is not specified, this operation is limited - to 40 requests per 30 minutes. If **cursor** is specified, the limit is 120 requests per minute. For more - information, see **Rate limiting**. + List the events from the log of a specific workspace. + If **cursor** is not specified, this operation is limited to 40 requests per 30 minutes. If **cursor** is + specified, the limit is 120 requests per minute. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter sort: The attribute by which returned results will be sorted. To reverse the sort order, prefix the value with a minus - sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. - - parameter filter: A cacheable parameter that limits the results to those matching the specified filter. For more information, see the - [documentation](https://console.bluemix.net/docs/services/conversation/filter-reference.html#filter-query-syntax). + sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. + - parameter filter: A cacheable parameter that limits the results to those matching the specified filter. For more information, see + the + [documentation](https://console.bluemix.net/docs/services/conversation/filter-reference.html#filter-query-syntax). - parameter pageLimit: The number of records to return in each page of results. - parameter cursor: A token identifying the page of results to retrieve. - parameter headers: A dictionary of request headers to be sent with this request. @@ -2980,16 +2993,16 @@ public class Assistant { /** List log events in all workspaces. - List the events from the logs of all workspaces in the service instance. If **cursor** is not specified, this - operation is limited to 40 requests per 30 minutes. If **cursor** is specified, the limit is 120 requests per - minute. For more information, see **Rate limiting**. + List the events from the logs of all workspaces in the service instance. + If **cursor** is not specified, this operation is limited to 40 requests per 30 minutes. If **cursor** is + specified, the limit is 120 requests per minute. For more information, see **Rate limiting**. - parameter filter: A cacheable parameter that limits the results to those matching the specified filter. You must specify a filter - query that includes a value for `language`, as well as a value for `workspace_id` or - `request.context.metadata.deployment`. For more information, see the - [documentation](https://console.bluemix.net/docs/services/conversation/filter-reference.html#filter-query-syntax). + query that includes a value for `language`, as well as a value for `workspace_id` or + `request.context.metadata.deployment`. For more information, see the + [documentation](https://console.bluemix.net/docs/services/conversation/filter-reference.html#filter-query-syntax). - parameter sort: The attribute by which returned results will be sorted. To reverse the sort order, prefix the value with a minus - sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. + sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. - parameter pageLimit: The number of records to return in each page of results. - parameter cursor: A token identifying the page of results to retrieve. - parameter headers: A dictionary of request headers to be sent with this request. @@ -3052,8 +3065,9 @@ public class Assistant { Delete labeled data. Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with - the customer ID. You associate a customer ID with data by passing the `X-Watson-Metadata` header with a request - that passes data. For more information about personal data and customer IDs, see [Information + the customer ID. + You associate a customer ID with data by passing the `X-Watson-Metadata` header with a request that passes data. + For more information about personal data and customer IDs, see [Information security](https://console.bluemix.net/docs/services/conversation/information-security.html). - parameter customerID: The customer ID for which all data is to be deleted. diff --git a/Source/AssistantV1/Models/CaptureGroup.swift b/Source/AssistantV1/Models/CaptureGroup.swift index 0cf551276..e35e3d7df 100644 --- a/Source/AssistantV1/Models/CaptureGroup.swift +++ b/Source/AssistantV1/Models/CaptureGroup.swift @@ -19,10 +19,14 @@ import Foundation /** CaptureGroup. */ public struct CaptureGroup: Codable { - /// A recognized capture group for the entity. + /** + A recognized capture group for the entity. + */ public var group: String - /// Zero-based character offsets that indicate where the entity value begins and ends in the input text. + /** + Zero-based character offsets that indicate where the entity value begins and ends in the input text. + */ public var location: [Int]? // Map each property name to the key that shall be used for encoding/decoding. @@ -39,7 +43,11 @@ public struct CaptureGroup: Codable { - returns: An initialized `CaptureGroup`. */ - public init(group: String, location: [Int]? = nil) { + public init( + group: String, + location: [Int]? = nil + ) + { self.group = group self.location = location } diff --git a/Source/AssistantV1/Models/Context.swift b/Source/AssistantV1/Models/Context.swift index 1b25725d6..1961f6ec1 100644 --- a/Source/AssistantV1/Models/Context.swift +++ b/Source/AssistantV1/Models/Context.swift @@ -19,10 +19,14 @@ import Foundation /** State information for the conversation. To maintain state, include the context from the previous response. */ public struct Context: Codable { - /// The unique identifier of the conversation. + /** + The unique identifier of the conversation. + */ public var conversationID: String? - /// For internal use only. + /** + For internal use only. + */ public var system: SystemResponse? /// Additional properties associated with this model. @@ -43,7 +47,12 @@ public struct Context: Codable { - returns: An initialized `Context`. */ - public init(conversationID: String? = nil, system: SystemResponse? = nil, additionalProperties: [String: JSON] = [:]) { + public init( + conversationID: String? = nil, + system: SystemResponse? = nil, + additionalProperties: [String: JSON] = [:] + ) + { self.conversationID = conversationID self.system = system self.additionalProperties = additionalProperties diff --git a/Source/AssistantV1/Models/Counterexample.swift b/Source/AssistantV1/Models/Counterexample.swift index 0a61c9687..a61f0c408 100644 --- a/Source/AssistantV1/Models/Counterexample.swift +++ b/Source/AssistantV1/Models/Counterexample.swift @@ -19,13 +19,19 @@ import Foundation /** Counterexample. */ public struct Counterexample: Decodable { - /// The text of the counterexample. + /** + The text of the counterexample. + */ public var text: String - /// The timestamp for creation of the counterexample. + /** + The timestamp for creation of the counterexample. + */ public var created: String? - /// The timestamp for the last update to the counterexample. + /** + The timestamp for the last update to the counterexample. + */ public var updated: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/CounterexampleCollection.swift b/Source/AssistantV1/Models/CounterexampleCollection.swift index 52d8a8666..87269f749 100644 --- a/Source/AssistantV1/Models/CounterexampleCollection.swift +++ b/Source/AssistantV1/Models/CounterexampleCollection.swift @@ -19,10 +19,14 @@ import Foundation /** CounterexampleCollection. */ public struct CounterexampleCollection: Decodable { - /// An array of objects describing the examples marked as irrelevant input. + /** + An array of objects describing the examples marked as irrelevant input. + */ public var counterexamples: [Counterexample] - /// The pagination data for the returned objects. + /** + The pagination data for the returned objects. + */ public var pagination: Pagination // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/CreateCounterexample.swift b/Source/AssistantV1/Models/CreateCounterexample.swift index 2f14c148a..ac6cea9c7 100644 --- a/Source/AssistantV1/Models/CreateCounterexample.swift +++ b/Source/AssistantV1/Models/CreateCounterexample.swift @@ -19,7 +19,12 @@ import Foundation /** CreateCounterexample. */ public struct CreateCounterexample: Encodable { - /// The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It must be no longer than 1024 characters. + /** + The text of a user input marked as irrelevant input. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters + - It cannot consist of only whitespace characters + - It must be no longer than 1024 characters. + */ public var text: String // Map each property name to the key that shall be used for encoding/decoding. @@ -30,11 +35,17 @@ public struct CreateCounterexample: Encodable { /** Initialize a `CreateCounterexample` with member variables. - - parameter text: The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It must be no longer than 1024 characters. + - parameter text: The text of a user input marked as irrelevant input. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters + - It cannot consist of only whitespace characters + - It must be no longer than 1024 characters. - returns: An initialized `CreateCounterexample`. */ - public init(text: String) { + public init( + text: String + ) + { self.text = text } diff --git a/Source/AssistantV1/Models/CreateDialogNode.swift b/Source/AssistantV1/Models/CreateDialogNode.swift index add80f23d..1aebab09d 100644 --- a/Source/AssistantV1/Models/CreateDialogNode.swift +++ b/Source/AssistantV1/Models/CreateDialogNode.swift @@ -19,7 +19,9 @@ import Foundation /** CreateDialogNode. */ public struct CreateDialogNode: Encodable { - /// How the dialog node is processed. + /** + How the dialog node is processed. + */ public enum NodeType: String { case standard = "standard" case eventHandler = "event_handler" @@ -29,7 +31,9 @@ public struct CreateDialogNode: Encodable { case folder = "folder" } - /// How an `event_handler` node is processed. + /** + How an `event_handler` node is processed. + */ public enum EventName: String { case focus = "focus" case input = "input" @@ -42,76 +46,123 @@ public struct CreateDialogNode: Encodable { case digressionReturnPrompt = "digression_return_prompt" } - /// Whether this top-level dialog node can be digressed into. + /** + Whether this top-level dialog node can be digressed into. + */ public enum DigressIn: String { case notAvailable = "not_available" case returns = "returns" case doesNotReturn = "does_not_return" } - /// Whether this dialog node can be returned to after a digression. + /** + Whether this dialog node can be returned to after a digression. + */ public enum DigressOut: String { case returning = "allow_returning" case all = "allow_all" case allNeverReturn = "allow_all_never_return" } - /// Whether the user can digress to top-level nodes while filling out slots. + /** + Whether the user can digress to top-level nodes while filling out slots. + */ public enum DigressOutSlots: String { case notAllowed = "not_allowed" case allowReturning = "allow_returning" case allowAll = "allow_all" } - /// The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters. + /** + The dialog node ID. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. + - It must be no longer than 1024 characters. + */ public var dialogNode: String - /// The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + /** + The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it + must be no longer than 128 characters. + */ public var description: String? - /// The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters. + /** + The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab + characters, and it must be no longer than 2048 characters. + */ public var conditions: String? - /// The ID of the parent dialog node. + /** + The ID of the parent dialog node. + */ public var parent: String? - /// The ID of the previous dialog node. + /** + The ID of the previous dialog node. + */ public var previousSibling: String? - /// The output of the dialog node. For more information about how to specify dialog node output, see the [documentation](https://console.bluemix.net/docs/services/conversation/dialog-overview.html#complex). + /** + The output of the dialog node. For more information about how to specify dialog node output, see the + [documentation](https://console.bluemix.net/docs/services/conversation/dialog-overview.html#complex). + */ public var output: [String: JSON]? - /// The context for the dialog node. + /** + The context for the dialog node. + */ public var context: [String: JSON]? - /// The metadata for the dialog node. + /** + The metadata for the dialog node. + */ public var metadata: [String: JSON]? - /// The next step to be executed in dialog processing. + /** + The next step to be executed in dialog processing. + */ public var nextStep: DialogNodeNextStep? - /// An array of objects describing any actions to be invoked by the dialog node. + /** + An array of objects describing any actions to be invoked by the dialog node. + */ public var actions: [DialogNodeAction]? - /// The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters. + /** + The alias used to identify the dialog node. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. + - It must be no longer than 64 characters. + */ public var title: String? - /// How the dialog node is processed. + /** + How the dialog node is processed. + */ public var nodeType: String? - /// How an `event_handler` node is processed. + /** + How an `event_handler` node is processed. + */ public var eventName: String? - /// The location in the dialog context where output is stored. + /** + The location in the dialog context where output is stored. + */ public var variable: String? - /// Whether this top-level dialog node can be digressed into. + /** + Whether this top-level dialog node can be digressed into. + */ public var digressIn: String? - /// Whether this dialog node can be returned to after a digression. + /** + Whether this dialog node can be returned to after a digression. + */ public var digressOut: String? - /// Whether the user can digress to top-level nodes while filling out slots. + /** + Whether the user can digress to top-level nodes while filling out slots. + */ public var digressOutSlots: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -138,17 +189,24 @@ public struct CreateDialogNode: Encodable { /** Initialize a `CreateDialogNode` with member variables. - - parameter dialogNode: The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters. - - parameter description: The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. - - parameter conditions: The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters. + - parameter dialogNode: The dialog node ID. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. + - It must be no longer than 1024 characters. + - parameter description: The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and + it must be no longer than 128 characters. + - parameter conditions: The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab + characters, and it must be no longer than 2048 characters. - parameter parent: The ID of the parent dialog node. - parameter previousSibling: The ID of the previous dialog node. - - parameter output: The output of the dialog node. For more information about how to specify dialog node output, see the [documentation](https://console.bluemix.net/docs/services/conversation/dialog-overview.html#complex). + - parameter output: The output of the dialog node. For more information about how to specify dialog node output, see the + [documentation](https://console.bluemix.net/docs/services/conversation/dialog-overview.html#complex). - parameter context: The context for the dialog node. - parameter metadata: The metadata for the dialog node. - parameter nextStep: The next step to be executed in dialog processing. - parameter actions: An array of objects describing any actions to be invoked by the dialog node. - - parameter title: The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters. + - parameter title: The alias used to identify the dialog node. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. + - It must be no longer than 64 characters. - parameter nodeType: How the dialog node is processed. - parameter eventName: How an `event_handler` node is processed. - parameter variable: The location in the dialog context where output is stored. @@ -158,7 +216,26 @@ public struct CreateDialogNode: Encodable { - returns: An initialized `CreateDialogNode`. */ - public init(dialogNode: String, description: String? = nil, conditions: String? = nil, parent: String? = nil, previousSibling: String? = nil, output: [String: JSON]? = nil, context: [String: JSON]? = nil, metadata: [String: JSON]? = nil, nextStep: DialogNodeNextStep? = nil, actions: [DialogNodeAction]? = nil, title: String? = nil, nodeType: String? = nil, eventName: String? = nil, variable: String? = nil, digressIn: String? = nil, digressOut: String? = nil, digressOutSlots: String? = nil) { + public init( + dialogNode: String, + description: String? = nil, + conditions: String? = nil, + parent: String? = nil, + previousSibling: String? = nil, + output: [String: JSON]? = nil, + context: [String: JSON]? = nil, + metadata: [String: JSON]? = nil, + nextStep: DialogNodeNextStep? = nil, + actions: [DialogNodeAction]? = nil, + title: String? = nil, + nodeType: String? = nil, + eventName: String? = nil, + variable: String? = nil, + digressIn: String? = nil, + digressOut: String? = nil, + digressOutSlots: String? = nil + ) + { self.dialogNode = dialogNode self.description = description self.conditions = conditions diff --git a/Source/AssistantV1/Models/CreateEntity.swift b/Source/AssistantV1/Models/CreateEntity.swift index a98f8087b..9e294bbeb 100644 --- a/Source/AssistantV1/Models/CreateEntity.swift +++ b/Source/AssistantV1/Models/CreateEntity.swift @@ -19,19 +19,33 @@ import Foundation /** CreateEntity. */ public struct CreateEntity: Encodable { - /// The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix `sys-`. - It must be no longer than 64 characters. + /** + The name of the entity. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, underscore, and hyphen characters. + - It cannot begin with the reserved prefix `sys-`. + - It must be no longer than 64 characters. + */ public var entity: String - /// The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + /** + The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must + be no longer than 128 characters. + */ public var description: String? - /// Any metadata related to the value. + /** + Any metadata related to the value. + */ public var metadata: [String: JSON]? - /// An array of objects describing the entity values. + /** + An array of objects describing the entity values. + */ public var values: [CreateValue]? - /// Whether to use fuzzy matching for the entity. + /** + Whether to use fuzzy matching for the entity. + */ public var fuzzyMatch: Bool? // Map each property name to the key that shall be used for encoding/decoding. @@ -46,15 +60,26 @@ public struct CreateEntity: Encodable { /** Initialize a `CreateEntity` with member variables. - - parameter entity: The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix `sys-`. - It must be no longer than 64 characters. - - parameter description: The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + - parameter entity: The name of the entity. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, underscore, and hyphen characters. + - It cannot begin with the reserved prefix `sys-`. + - It must be no longer than 64 characters. + - parameter description: The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it + must be no longer than 128 characters. - parameter metadata: Any metadata related to the value. - parameter values: An array of objects describing the entity values. - parameter fuzzyMatch: Whether to use fuzzy matching for the entity. - returns: An initialized `CreateEntity`. */ - public init(entity: String, description: String? = nil, metadata: [String: JSON]? = nil, values: [CreateValue]? = nil, fuzzyMatch: Bool? = nil) { + public init( + entity: String, + description: String? = nil, + metadata: [String: JSON]? = nil, + values: [CreateValue]? = nil, + fuzzyMatch: Bool? = nil + ) + { self.entity = entity self.description = description self.metadata = metadata diff --git a/Source/AssistantV1/Models/CreateExample.swift b/Source/AssistantV1/Models/CreateExample.swift index c367c47e3..68627199c 100644 --- a/Source/AssistantV1/Models/CreateExample.swift +++ b/Source/AssistantV1/Models/CreateExample.swift @@ -19,7 +19,12 @@ import Foundation /** CreateExample. */ public struct CreateExample: Encodable { - /// The text of a user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters. + /** + The text of a user input example. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 1024 characters. + */ public var text: String // Map each property name to the key that shall be used for encoding/decoding. @@ -30,11 +35,17 @@ public struct CreateExample: Encodable { /** Initialize a `CreateExample` with member variables. - - parameter text: The text of a user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters. + - parameter text: The text of a user input example. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 1024 characters. - returns: An initialized `CreateExample`. */ - public init(text: String) { + public init( + text: String + ) + { self.text = text } diff --git a/Source/AssistantV1/Models/CreateIntent.swift b/Source/AssistantV1/Models/CreateIntent.swift index 36e37d9f9..48cf9af85 100644 --- a/Source/AssistantV1/Models/CreateIntent.swift +++ b/Source/AssistantV1/Models/CreateIntent.swift @@ -19,13 +19,23 @@ import Foundation /** CreateIntent. */ public struct CreateIntent: Encodable { - /// The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix `sys-`. - It must be no longer than 128 characters. + /** + The name of the intent. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. + - It cannot begin with the reserved prefix `sys-`. + - It must be no longer than 128 characters. + */ public var intent: String - /// The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + /** + The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must + be no longer than 128 characters. + */ public var description: String? - /// An array of user input examples for the intent. + /** + An array of user input examples for the intent. + */ public var examples: [CreateExample]? // Map each property name to the key that shall be used for encoding/decoding. @@ -38,13 +48,22 @@ public struct CreateIntent: Encodable { /** Initialize a `CreateIntent` with member variables. - - parameter intent: The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix `sys-`. - It must be no longer than 128 characters. - - parameter description: The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + - parameter intent: The name of the intent. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. + - It cannot begin with the reserved prefix `sys-`. + - It must be no longer than 128 characters. + - parameter description: The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it + must be no longer than 128 characters. - parameter examples: An array of user input examples for the intent. - returns: An initialized `CreateIntent`. */ - public init(intent: String, description: String? = nil, examples: [CreateExample]? = nil) { + public init( + intent: String, + description: String? = nil, + examples: [CreateExample]? = nil + ) + { self.intent = intent self.description = description self.examples = examples diff --git a/Source/AssistantV1/Models/CreateSynonym.swift b/Source/AssistantV1/Models/CreateSynonym.swift index dbfcdd4c0..8c6f7cb5e 100644 --- a/Source/AssistantV1/Models/CreateSynonym.swift +++ b/Source/AssistantV1/Models/CreateSynonym.swift @@ -19,7 +19,12 @@ import Foundation /** CreateSynonym. */ public struct CreateSynonym: Encodable { - /// The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. + /** + The text of the synonym. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. + */ public var synonym: String // Map each property name to the key that shall be used for encoding/decoding. @@ -30,11 +35,17 @@ public struct CreateSynonym: Encodable { /** Initialize a `CreateSynonym` with member variables. - - parameter synonym: The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. + - parameter synonym: The text of the synonym. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. - returns: An initialized `CreateSynonym`. */ - public init(synonym: String) { + public init( + synonym: String + ) + { self.synonym = synonym } diff --git a/Source/AssistantV1/Models/CreateValue.swift b/Source/AssistantV1/Models/CreateValue.swift index f3abc1286..5c9f73f7b 100644 --- a/Source/AssistantV1/Models/CreateValue.swift +++ b/Source/AssistantV1/Models/CreateValue.swift @@ -19,25 +19,47 @@ import Foundation /** CreateValue. */ public struct CreateValue: Encodable { - /// Specifies the type of value. + /** + Specifies the type of value. + */ public enum ValueType: String { case synonyms = "synonyms" case patterns = "patterns" } - /// The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. + /** + The text of the entity value. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. + */ public var value: String - /// Any metadata related to the entity value. + /** + Any metadata related to the entity value. + */ public var metadata: [String: JSON]? - /// An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by **type**), but not both. A synonym must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. + /** + An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by + **type**), but not both. A synonym must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. + */ public var synonyms: [String]? - /// An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by **type**), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities). + /** + An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by **type**), + but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to + specify a pattern, see the + [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities). + */ public var patterns: [String]? - /// Specifies the type of value. + /** + Specifies the type of value. + */ public var valueType: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -52,15 +74,32 @@ public struct CreateValue: Encodable { /** Initialize a `CreateValue` with member variables. - - parameter value: The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. + - parameter value: The text of the entity value. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. - parameter metadata: Any metadata related to the entity value. - - parameter synonyms: An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by **type**), but not both. A synonym must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. - - parameter patterns: An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by **type**), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities). + - parameter synonyms: An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated + by **type**), but not both. A synonym must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. + - parameter patterns: An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by + **type**), but not both. A pattern is a regular expression no longer than 128 characters. For more information + about how to specify a pattern, see the + [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities). - parameter valueType: Specifies the type of value. - returns: An initialized `CreateValue`. */ - public init(value: String, metadata: [String: JSON]? = nil, synonyms: [String]? = nil, patterns: [String]? = nil, valueType: String? = nil) { + public init( + value: String, + metadata: [String: JSON]? = nil, + synonyms: [String]? = nil, + patterns: [String]? = nil, + valueType: String? = nil + ) + { self.value = value self.metadata = metadata self.synonyms = synonyms diff --git a/Source/AssistantV1/Models/CreateWorkspace.swift b/Source/AssistantV1/Models/CreateWorkspace.swift index 4753009e7..7251e1669 100644 --- a/Source/AssistantV1/Models/CreateWorkspace.swift +++ b/Source/AssistantV1/Models/CreateWorkspace.swift @@ -19,31 +19,52 @@ import Foundation /** CreateWorkspace. */ public struct CreateWorkspace: Encodable { - /// The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters. + /** + The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be + no longer than 64 characters. + */ public var name: String? - /// The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + /** + The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it + must be no longer than 128 characters. + */ public var description: String? - /// The language of the workspace. + /** + The language of the workspace. + */ public var language: String? - /// An array of objects defining the intents for the workspace. + /** + An array of objects defining the intents for the workspace. + */ public var intents: [CreateIntent]? - /// An array of objects defining the entities for the workspace. + /** + An array of objects defining the entities for the workspace. + */ public var entities: [CreateEntity]? - /// An array of objects defining the nodes in the workspace dialog. + /** + An array of objects defining the nodes in the workspace dialog. + */ public var dialogNodes: [CreateDialogNode]? - /// An array of objects defining input examples that have been marked as irrelevant input. + /** + An array of objects defining input examples that have been marked as irrelevant input. + */ public var counterexamples: [CreateCounterexample]? - /// Any metadata related to the workspace. + /** + Any metadata related to the workspace. + */ public var metadata: [String: JSON]? - /// Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates that workspace training data is not to be used. + /** + Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates that + workspace training data is not to be used. + */ public var learningOptOut: Bool? // Map each property name to the key that shall be used for encoding/decoding. @@ -62,19 +83,33 @@ public struct CreateWorkspace: Encodable { /** Initialize a `CreateWorkspace` with member variables. - - parameter name: The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters. - - parameter description: The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + - parameter name: The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be + no longer than 64 characters. + - parameter description: The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it + must be no longer than 128 characters. - parameter language: The language of the workspace. - parameter intents: An array of objects defining the intents for the workspace. - parameter entities: An array of objects defining the entities for the workspace. - parameter dialogNodes: An array of objects defining the nodes in the workspace dialog. - parameter counterexamples: An array of objects defining input examples that have been marked as irrelevant input. - parameter metadata: Any metadata related to the workspace. - - parameter learningOptOut: Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates that workspace training data is not to be used. + - parameter learningOptOut: Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates + that workspace training data is not to be used. - returns: An initialized `CreateWorkspace`. */ - public init(name: String? = nil, description: String? = nil, language: String? = nil, intents: [CreateIntent]? = nil, entities: [CreateEntity]? = nil, dialogNodes: [CreateDialogNode]? = nil, counterexamples: [CreateCounterexample]? = nil, metadata: [String: JSON]? = nil, learningOptOut: Bool? = nil) { + public init( + name: String? = nil, + description: String? = nil, + language: String? = nil, + intents: [CreateIntent]? = nil, + entities: [CreateEntity]? = nil, + dialogNodes: [CreateDialogNode]? = nil, + counterexamples: [CreateCounterexample]? = nil, + metadata: [String: JSON]? = nil, + learningOptOut: Bool? = nil + ) + { self.name = name self.description = description self.language = language diff --git a/Source/AssistantV1/Models/DialogNode.swift b/Source/AssistantV1/Models/DialogNode.swift index e9b0924e8..8076e5c50 100644 --- a/Source/AssistantV1/Models/DialogNode.swift +++ b/Source/AssistantV1/Models/DialogNode.swift @@ -19,7 +19,9 @@ import Foundation /** DialogNode. */ public struct DialogNode: Decodable { - /// How the dialog node is processed. + /** + How the dialog node is processed. + */ public enum NodeType: String { case standard = "standard" case eventHandler = "event_handler" @@ -29,7 +31,9 @@ public struct DialogNode: Decodable { case folder = "folder" } - /// How an `event_handler` node is processed. + /** + How an `event_handler` node is processed. + */ public enum EventName: String { case focus = "focus" case input = "input" @@ -42,82 +46,127 @@ public struct DialogNode: Decodable { case digressionReturnPrompt = "digression_return_prompt" } - /// Whether this top-level dialog node can be digressed into. + /** + Whether this top-level dialog node can be digressed into. + */ public enum DigressIn: String { case notAvailable = "not_available" case returns = "returns" case doesNotReturn = "does_not_return" } - /// Whether this dialog node can be returned to after a digression. + /** + Whether this dialog node can be returned to after a digression. + */ public enum DigressOut: String { case returning = "allow_returning" case all = "allow_all" case allNeverReturn = "allow_all_never_return" } - /// Whether the user can digress to top-level nodes while filling out slots. + /** + Whether the user can digress to top-level nodes while filling out slots. + */ public enum DigressOutSlots: String { case notAllowed = "not_allowed" case allowReturning = "allow_returning" case allowAll = "allow_all" } - /// The dialog node ID. + /** + The dialog node ID. + */ public var dialogNodeID: String - /// The description of the dialog node. + /** + The description of the dialog node. + */ public var description: String? - /// The condition that triggers the dialog node. + /** + The condition that triggers the dialog node. + */ public var conditions: String? - /// The ID of the parent dialog node. This property is not returned if the dialog node has no parent. + /** + The ID of the parent dialog node. This property is not returned if the dialog node has no parent. + */ public var parent: String? - /// The ID of the previous sibling dialog node. This property is not returned if the dialog node has no previous sibling. + /** + The ID of the previous sibling dialog node. This property is not returned if the dialog node has no previous + sibling. + */ public var previousSibling: String? - /// The output of the dialog node. + /** + The output of the dialog node. + */ public var output: [String: JSON]? - /// The context (if defined) for the dialog node. + /** + The context (if defined) for the dialog node. + */ public var context: [String: JSON]? - /// Any metadata for the dialog node. + /** + Any metadata for the dialog node. + */ public var metadata: [String: JSON]? - /// The next step to execute following this dialog node. + /** + The next step to execute following this dialog node. + */ public var nextStep: DialogNodeNextStep? - /// The timestamp for creation of the dialog node. + /** + The timestamp for creation of the dialog node. + */ public var created: String? - /// The timestamp for the most recent update to the dialog node. + /** + The timestamp for the most recent update to the dialog node. + */ public var updated: String? - /// The actions for the dialog node. + /** + The actions for the dialog node. + */ public var actions: [DialogNodeAction]? - /// The alias used to identify the dialog node. + /** + The alias used to identify the dialog node. + */ public var title: String? - /// How the dialog node is processed. + /** + How the dialog node is processed. + */ public var nodeType: String? - /// How an `event_handler` node is processed. + /** + How an `event_handler` node is processed. + */ public var eventName: String? - /// The location in the dialog context where output is stored. + /** + The location in the dialog context where output is stored. + */ public var variable: String? - /// Whether this top-level dialog node can be digressed into. + /** + Whether this top-level dialog node can be digressed into. + */ public var digressIn: String? - /// Whether this dialog node can be returned to after a digression. + /** + Whether this dialog node can be returned to after a digression. + */ public var digressOut: String? - /// Whether the user can digress to top-level nodes while filling out slots. + /** + Whether the user can digress to top-level nodes while filling out slots. + */ public var digressOutSlots: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/DialogNodeAction.swift b/Source/AssistantV1/Models/DialogNodeAction.swift index 7a84095ed..3713c941d 100644 --- a/Source/AssistantV1/Models/DialogNodeAction.swift +++ b/Source/AssistantV1/Models/DialogNodeAction.swift @@ -19,25 +19,37 @@ import Foundation /** DialogNodeAction. */ public struct DialogNodeAction: Codable { - /// The type of action to invoke. + /** + The type of action to invoke. + */ public enum ActionType: String { case client = "client" case server = "server" } - /// The name of the action. + /** + The name of the action. + */ public var name: String - /// The type of action to invoke. + /** + The type of action to invoke. + */ public var actionType: String? - /// A map of key/value pairs to be provided to the action. + /** + A map of key/value pairs to be provided to the action. + */ public var parameters: [String: JSON]? - /// The location in the dialog context where the result of the action is stored. + /** + The location in the dialog context where the result of the action is stored. + */ public var resultVariable: String - /// The name of the context variable that the client application will use to pass in credentials for the action. + /** + The name of the context variable that the client application will use to pass in credentials for the action. + */ public var credentials: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -60,7 +72,14 @@ public struct DialogNodeAction: Codable { - returns: An initialized `DialogNodeAction`. */ - public init(name: String, resultVariable: String, actionType: String? = nil, parameters: [String: JSON]? = nil, credentials: String? = nil) { + public init( + name: String, + resultVariable: String, + actionType: String? = nil, + parameters: [String: JSON]? = nil, + credentials: String? = nil + ) + { self.name = name self.resultVariable = resultVariable self.actionType = actionType diff --git a/Source/AssistantV1/Models/DialogNodeCollection.swift b/Source/AssistantV1/Models/DialogNodeCollection.swift index 742ae3f4e..546884dc8 100644 --- a/Source/AssistantV1/Models/DialogNodeCollection.swift +++ b/Source/AssistantV1/Models/DialogNodeCollection.swift @@ -19,10 +19,14 @@ import Foundation /** An array of dialog nodes. */ public struct DialogNodeCollection: Decodable { - /// An array of objects describing the dialog nodes defined for the workspace. + /** + An array of objects describing the dialog nodes defined for the workspace. + */ public var dialogNodes: [DialogNode] - /// The pagination data for the returned objects. + /** + The pagination data for the returned objects. + */ public var pagination: Pagination // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/DialogNodeNextStep.swift b/Source/AssistantV1/Models/DialogNodeNextStep.swift index 7beeaddd6..237c8372e 100644 --- a/Source/AssistantV1/Models/DialogNodeNextStep.swift +++ b/Source/AssistantV1/Models/DialogNodeNextStep.swift @@ -19,7 +19,27 @@ import Foundation /** The next step to execute following this dialog node. */ public struct DialogNodeNextStep: Codable { - /// What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - `get_user_input` - `skip_user_input` - `jump_to` - If the node is of type `event_handler` and its parent node is of type `slot` or `frame`, additional values are also valid: - if **event_name**=`filled` and the type of the parent node is `slot`: - `reprompt` - `skip_all_slots` - if **event_name**=`nomatch` and the type of the parent node is `slot`: - `reprompt` - `skip_slot` - `skip_all_slots` - if **event_name**=`generic` and the type of the parent node is `frame`: - `reprompt` - `skip_slot` - `skip_all_slots` If you specify `jump_to`, then you must also specify a value for the `dialog_node` property. + /** + What happens after the dialog node completes. The valid values depend on the node type: + - The following values are valid for any node: + - `get_user_input` + - `skip_user_input` + - `jump_to` + - If the node is of type `event_handler` and its parent node is of type `slot` or `frame`, additional values are + also valid: + - if **event_name**=`filled` and the type of the parent node is `slot`: + - `reprompt` + - `skip_all_slots` + - if **event_name**=`nomatch` and the type of the parent node is `slot`: + - `reprompt` + - `skip_slot` + - `skip_all_slots` + - if **event_name**=`generic` and the type of the parent node is `frame`: + - `reprompt` + - `skip_slot` + - `skip_all_slots` + If you specify `jump_to`, then you must also specify a value for the `dialog_node` property. + */ public enum Behavior: String { case getUserInput = "get_user_input" case skipUserInput = "skip_user_input" @@ -29,7 +49,9 @@ public struct DialogNodeNextStep: Codable { case skipAllSlots = "skip_all_slots" } - /// Which part of the dialog node to process next. + /** + Which part of the dialog node to process next. + */ public enum Selector: String { case condition = "condition" case client = "client" @@ -37,13 +59,37 @@ public struct DialogNodeNextStep: Codable { case body = "body" } - /// What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - `get_user_input` - `skip_user_input` - `jump_to` - If the node is of type `event_handler` and its parent node is of type `slot` or `frame`, additional values are also valid: - if **event_name**=`filled` and the type of the parent node is `slot`: - `reprompt` - `skip_all_slots` - if **event_name**=`nomatch` and the type of the parent node is `slot`: - `reprompt` - `skip_slot` - `skip_all_slots` - if **event_name**=`generic` and the type of the parent node is `frame`: - `reprompt` - `skip_slot` - `skip_all_slots` If you specify `jump_to`, then you must also specify a value for the `dialog_node` property. + /** + What happens after the dialog node completes. The valid values depend on the node type: + - The following values are valid for any node: + - `get_user_input` + - `skip_user_input` + - `jump_to` + - If the node is of type `event_handler` and its parent node is of type `slot` or `frame`, additional values are + also valid: + - if **event_name**=`filled` and the type of the parent node is `slot`: + - `reprompt` + - `skip_all_slots` + - if **event_name**=`nomatch` and the type of the parent node is `slot`: + - `reprompt` + - `skip_slot` + - `skip_all_slots` + - if **event_name**=`generic` and the type of the parent node is `frame`: + - `reprompt` + - `skip_slot` + - `skip_all_slots` + If you specify `jump_to`, then you must also specify a value for the `dialog_node` property. + */ public var behavior: String - /// The ID of the dialog node to process next. This parameter is required if **behavior**=`jump_to`. + /** + The ID of the dialog node to process next. This parameter is required if **behavior**=`jump_to`. + */ public var dialogNode: String? - /// Which part of the dialog node to process next. + /** + Which part of the dialog node to process next. + */ public var selector: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -56,13 +102,36 @@ public struct DialogNodeNextStep: Codable { /** Initialize a `DialogNodeNextStep` with member variables. - - parameter behavior: What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - `get_user_input` - `skip_user_input` - `jump_to` - If the node is of type `event_handler` and its parent node is of type `slot` or `frame`, additional values are also valid: - if **event_name**=`filled` and the type of the parent node is `slot`: - `reprompt` - `skip_all_slots` - if **event_name**=`nomatch` and the type of the parent node is `slot`: - `reprompt` - `skip_slot` - `skip_all_slots` - if **event_name**=`generic` and the type of the parent node is `frame`: - `reprompt` - `skip_slot` - `skip_all_slots` If you specify `jump_to`, then you must also specify a value for the `dialog_node` property. + - parameter behavior: What happens after the dialog node completes. The valid values depend on the node type: + - The following values are valid for any node: + - `get_user_input` + - `skip_user_input` + - `jump_to` + - If the node is of type `event_handler` and its parent node is of type `slot` or `frame`, additional values are + also valid: + - if **event_name**=`filled` and the type of the parent node is `slot`: + - `reprompt` + - `skip_all_slots` + - if **event_name**=`nomatch` and the type of the parent node is `slot`: + - `reprompt` + - `skip_slot` + - `skip_all_slots` + - if **event_name**=`generic` and the type of the parent node is `frame`: + - `reprompt` + - `skip_slot` + - `skip_all_slots` + If you specify `jump_to`, then you must also specify a value for the `dialog_node` property. - parameter dialogNode: The ID of the dialog node to process next. This parameter is required if **behavior**=`jump_to`. - parameter selector: Which part of the dialog node to process next. - returns: An initialized `DialogNodeNextStep`. */ - public init(behavior: String, dialogNode: String? = nil, selector: String? = nil) { + public init( + behavior: String, + dialogNode: String? = nil, + selector: String? = nil + ) + { self.behavior = behavior self.dialogNode = dialogNode self.selector = selector diff --git a/Source/AssistantV1/Models/DialogNodeVisitedDetails.swift b/Source/AssistantV1/Models/DialogNodeVisitedDetails.swift index 89bca323d..d0a33d8ec 100644 --- a/Source/AssistantV1/Models/DialogNodeVisitedDetails.swift +++ b/Source/AssistantV1/Models/DialogNodeVisitedDetails.swift @@ -19,13 +19,19 @@ import Foundation /** DialogNodeVisitedDetails. */ public struct DialogNodeVisitedDetails: Codable { - /// A dialog node that was triggered during processing of the input message. + /** + A dialog node that was triggered during processing of the input message. + */ public var dialogNode: String? - /// The title of the dialog node. + /** + The title of the dialog node. + */ public var title: String? - /// The conditions that trigger the dialog node. + /** + The conditions that trigger the dialog node. + */ public var conditions: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -44,7 +50,12 @@ public struct DialogNodeVisitedDetails: Codable { - returns: An initialized `DialogNodeVisitedDetails`. */ - public init(dialogNode: String? = nil, title: String? = nil, conditions: String? = nil) { + public init( + dialogNode: String? = nil, + title: String? = nil, + conditions: String? = nil + ) + { self.dialogNode = dialogNode self.title = title self.conditions = conditions diff --git a/Source/AssistantV1/Models/Entity.swift b/Source/AssistantV1/Models/Entity.swift index b43cfd881..eea7733ab 100644 --- a/Source/AssistantV1/Models/Entity.swift +++ b/Source/AssistantV1/Models/Entity.swift @@ -19,22 +19,34 @@ import Foundation /** Entity. */ public struct Entity: Decodable { - /// The name of the entity. + /** + The name of the entity. + */ public var entityName: String - /// The timestamp for creation of the entity. + /** + The timestamp for creation of the entity. + */ public var created: String? - /// The timestamp for the last update to the entity. + /** + The timestamp for the last update to the entity. + */ public var updated: String? - /// The description of the entity. + /** + The description of the entity. + */ public var description: String? - /// Any metadata related to the entity. + /** + Any metadata related to the entity. + */ public var metadata: [String: JSON]? - /// Whether fuzzy matching is used for the entity. + /** + Whether fuzzy matching is used for the entity. + */ public var fuzzyMatch: Bool? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/EntityCollection.swift b/Source/AssistantV1/Models/EntityCollection.swift index 169088e16..95c058650 100644 --- a/Source/AssistantV1/Models/EntityCollection.swift +++ b/Source/AssistantV1/Models/EntityCollection.swift @@ -19,10 +19,14 @@ import Foundation /** An array of entities. */ public struct EntityCollection: Decodable { - /// An array of objects describing the entities defined for the workspace. + /** + An array of objects describing the entities defined for the workspace. + */ public var entities: [EntityExport] - /// The pagination data for the returned objects. + /** + The pagination data for the returned objects. + */ public var pagination: Pagination // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/EntityExport.swift b/Source/AssistantV1/Models/EntityExport.swift index 01c880577..ce0a41053 100644 --- a/Source/AssistantV1/Models/EntityExport.swift +++ b/Source/AssistantV1/Models/EntityExport.swift @@ -19,25 +19,39 @@ import Foundation /** EntityExport. */ public struct EntityExport: Decodable { - /// The name of the entity. + /** + The name of the entity. + */ public var entityName: String - /// The timestamp for creation of the entity. + /** + The timestamp for creation of the entity. + */ public var created: String? - /// The timestamp for the last update to the entity. + /** + The timestamp for the last update to the entity. + */ public var updated: String? - /// The description of the entity. + /** + The description of the entity. + */ public var description: String? - /// Any metadata related to the entity. + /** + Any metadata related to the entity. + */ public var metadata: [String: JSON]? - /// Whether fuzzy matching is used for the entity. + /** + Whether fuzzy matching is used for the entity. + */ public var fuzzyMatch: Bool? - /// An array objects describing the entity values. + /** + An array objects describing the entity values. + */ public var values: [ValueExport]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/Example.swift b/Source/AssistantV1/Models/Example.swift index 0d34e47dd..2e7ad8afb 100644 --- a/Source/AssistantV1/Models/Example.swift +++ b/Source/AssistantV1/Models/Example.swift @@ -19,13 +19,19 @@ import Foundation /** Example. */ public struct Example: Decodable { - /// The text of the user input example. + /** + The text of the user input example. + */ public var exampleText: String - /// The timestamp for creation of the example. + /** + The timestamp for creation of the example. + */ public var created: String? - /// The timestamp for the last update to the example. + /** + The timestamp for the last update to the example. + */ public var updated: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/ExampleCollection.swift b/Source/AssistantV1/Models/ExampleCollection.swift index a56bb883c..cd40cb86c 100644 --- a/Source/AssistantV1/Models/ExampleCollection.swift +++ b/Source/AssistantV1/Models/ExampleCollection.swift @@ -19,10 +19,14 @@ import Foundation /** ExampleCollection. */ public struct ExampleCollection: Decodable { - /// An array of objects describing the examples defined for the intent. + /** + An array of objects describing the examples defined for the intent. + */ public var examples: [Example] - /// The pagination data for the returned objects. + /** + The pagination data for the returned objects. + */ public var pagination: Pagination // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/InputData.swift b/Source/AssistantV1/Models/InputData.swift index 8e47dbb4e..4860c5e4f 100644 --- a/Source/AssistantV1/Models/InputData.swift +++ b/Source/AssistantV1/Models/InputData.swift @@ -19,7 +19,10 @@ import Foundation /** The user input. */ public struct InputData: Codable { - /// The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters. + /** + The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be + no longer than 2048 characters. + */ public var text: String // Map each property name to the key that shall be used for encoding/decoding. @@ -30,11 +33,15 @@ public struct InputData: Codable { /** Initialize a `InputData` with member variables. - - parameter text: The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters. + - parameter text: The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must + be no longer than 2048 characters. - returns: An initialized `InputData`. */ - public init(text: String) { + public init( + text: String + ) + { self.text = text } diff --git a/Source/AssistantV1/Models/Intent.swift b/Source/AssistantV1/Models/Intent.swift index 8638ff8e2..088f4e18e 100644 --- a/Source/AssistantV1/Models/Intent.swift +++ b/Source/AssistantV1/Models/Intent.swift @@ -19,16 +19,24 @@ import Foundation /** Intent. */ public struct Intent: Decodable { - /// The name of the intent. + /** + The name of the intent. + */ public var intentName: String - /// The timestamp for creation of the intent. + /** + The timestamp for creation of the intent. + */ public var created: String? - /// The timestamp for the last update to the intent. + /** + The timestamp for the last update to the intent. + */ public var updated: String? - /// The description of the intent. + /** + The description of the intent. + */ public var description: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/IntentCollection.swift b/Source/AssistantV1/Models/IntentCollection.swift index 700882af7..7df66ea61 100644 --- a/Source/AssistantV1/Models/IntentCollection.swift +++ b/Source/AssistantV1/Models/IntentCollection.swift @@ -19,10 +19,14 @@ import Foundation /** IntentCollection. */ public struct IntentCollection: Decodable { - /// An array of objects describing the intents defined for the workspace. + /** + An array of objects describing the intents defined for the workspace. + */ public var intents: [IntentExport] - /// The pagination data for the returned objects. + /** + The pagination data for the returned objects. + */ public var pagination: Pagination // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/IntentExport.swift b/Source/AssistantV1/Models/IntentExport.swift index 4b370dd29..b80fe44a7 100644 --- a/Source/AssistantV1/Models/IntentExport.swift +++ b/Source/AssistantV1/Models/IntentExport.swift @@ -19,19 +19,29 @@ import Foundation /** IntentExport. */ public struct IntentExport: Decodable { - /// The name of the intent. + /** + The name of the intent. + */ public var intentName: String - /// The timestamp for creation of the intent. + /** + The timestamp for creation of the intent. + */ public var created: String? - /// The timestamp for the last update to the intent. + /** + The timestamp for the last update to the intent. + */ public var updated: String? - /// The description of the intent. + /** + The description of the intent. + */ public var description: String? - /// An array of objects describing the user input examples for the intent. + /** + An array of objects describing the user input examples for the intent. + */ public var examples: [Example]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/LogCollection.swift b/Source/AssistantV1/Models/LogCollection.swift index 296766c2c..792002b20 100644 --- a/Source/AssistantV1/Models/LogCollection.swift +++ b/Source/AssistantV1/Models/LogCollection.swift @@ -19,10 +19,14 @@ import Foundation /** LogCollection. */ public struct LogCollection: Decodable { - /// An array of objects describing log events. + /** + An array of objects describing log events. + */ public var logs: [LogExport] - /// The pagination data for the returned objects. + /** + The pagination data for the returned objects. + */ public var pagination: LogPagination // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/LogExport.swift b/Source/AssistantV1/Models/LogExport.swift index adc47ca15..34f51da97 100644 --- a/Source/AssistantV1/Models/LogExport.swift +++ b/Source/AssistantV1/Models/LogExport.swift @@ -19,25 +19,39 @@ import Foundation /** LogExport. */ public struct LogExport: Decodable { - /// A request received by the workspace, including the user input and context. + /** + A request received by the workspace, including the user input and context. + */ public var request: MessageRequest - /// The response sent by the workspace, including the output text, detected intents and entities, and context. + /** + The response sent by the workspace, including the output text, detected intents and entities, and context. + */ public var response: MessageResponse - /// A unique identifier for the logged event. + /** + A unique identifier for the logged event. + */ public var logID: String - /// The timestamp for receipt of the message. + /** + The timestamp for receipt of the message. + */ public var requestTimestamp: String - /// The timestamp for the system response to the message. + /** + The timestamp for the system response to the message. + */ public var responseTimestamp: String - /// The unique identifier of the workspace where the request was made. + /** + The unique identifier of the workspace where the request was made. + */ public var workspaceID: String - /// The language of the workspace where the message request was made. + /** + The language of the workspace where the message request was made. + */ public var language: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/LogMessage.swift b/Source/AssistantV1/Models/LogMessage.swift index 1820936ec..7c23e9ca6 100644 --- a/Source/AssistantV1/Models/LogMessage.swift +++ b/Source/AssistantV1/Models/LogMessage.swift @@ -19,17 +19,23 @@ import Foundation /** Log message details. */ public struct LogMessage: Codable { - /// The severity of the log message. + /** + The severity of the log message. + */ public enum Level: String { case info = "info" case error = "error" case warn = "warn" } - /// The severity of the log message. + /** + The severity of the log message. + */ public var level: String - /// The text of the log message. + /** + The text of the log message. + */ public var msg: String /// Additional properties associated with this model. @@ -50,7 +56,12 @@ public struct LogMessage: Codable { - returns: An initialized `LogMessage`. */ - public init(level: String, msg: String, additionalProperties: [String: JSON] = [:]) { + public init( + level: String, + msg: String, + additionalProperties: [String: JSON] = [:] + ) + { self.level = level self.msg = msg self.additionalProperties = additionalProperties diff --git a/Source/AssistantV1/Models/LogPagination.swift b/Source/AssistantV1/Models/LogPagination.swift index b251d0986..a3a869137 100644 --- a/Source/AssistantV1/Models/LogPagination.swift +++ b/Source/AssistantV1/Models/LogPagination.swift @@ -19,13 +19,19 @@ import Foundation /** The pagination data for the returned objects. */ public struct LogPagination: Decodable { - /// The URL that will return the next page of results, if any. + /** + The URL that will return the next page of results, if any. + */ public var nextUrl: String? - /// Reserved for future use. + /** + Reserved for future use. + */ public var matched: Int? - /// A token identifying the next page of results. + /** + A token identifying the next page of results. + */ public var nextCursor: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/MessageInput.swift b/Source/AssistantV1/Models/MessageInput.swift index 58139d4c2..a68bb6eda 100644 --- a/Source/AssistantV1/Models/MessageInput.swift +++ b/Source/AssistantV1/Models/MessageInput.swift @@ -19,7 +19,9 @@ import Foundation /** The text of the user input. */ public struct MessageInput: Decodable { - /// The user's input. + /** + The user's input. + */ public var text: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/MessageRequest.swift b/Source/AssistantV1/Models/MessageRequest.swift index f0d72278d..7bb4eafe5 100644 --- a/Source/AssistantV1/Models/MessageRequest.swift +++ b/Source/AssistantV1/Models/MessageRequest.swift @@ -19,22 +19,38 @@ import Foundation /** A request formatted for the Watson Assistant service. */ public struct MessageRequest: Codable { - /// An input object that includes the input text. + /** + An input object that includes the input text. + */ public var input: InputData? - /// Whether to return more than one intent. Set to `true` to return all matching intents. + /** + Whether to return more than one intent. Set to `true` to return all matching intents. + */ public var alternateIntents: Bool? - /// State information for the conversation. Continue a conversation by including the context object from the previous response. + /** + State information for the conversation. Continue a conversation by including the context object from the previous + response. + */ public var context: Context? - /// Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input. + /** + Entities to use when evaluating the message. Include entities from the previous response to continue using those + entities rather than detecting entities in the new input. + */ public var entities: [RuntimeEntity]? - /// Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input. + /** + Intents to use when evaluating the user input. Include intents from the previous response to continue using those + intents rather than trying to recognize intents in the new input. + */ public var intents: [RuntimeIntent]? - /// System output. Include the output from the previous response to maintain intermediate information over multiple requests. + /** + System output. Include the output from the previous response to maintain intermediate information over multiple + requests. + */ public var output: OutputData? // Map each property name to the key that shall be used for encoding/decoding. @@ -52,14 +68,26 @@ public struct MessageRequest: Codable { - parameter input: An input object that includes the input text. - parameter alternateIntents: Whether to return more than one intent. Set to `true` to return all matching intents. - - parameter context: State information for the conversation. Continue a conversation by including the context object from the previous response. - - parameter entities: Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input. - - parameter intents: Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input. - - parameter output: System output. Include the output from the previous response to maintain intermediate information over multiple requests. + - parameter context: State information for the conversation. Continue a conversation by including the context object from the previous + response. + - parameter entities: Entities to use when evaluating the message. Include entities from the previous response to continue using those + entities rather than detecting entities in the new input. + - parameter intents: Intents to use when evaluating the user input. Include intents from the previous response to continue using those + intents rather than trying to recognize intents in the new input. + - parameter output: System output. Include the output from the previous response to maintain intermediate information over multiple + requests. - returns: An initialized `MessageRequest`. */ - public init(input: InputData? = nil, alternateIntents: Bool? = nil, context: Context? = nil, entities: [RuntimeEntity]? = nil, intents: [RuntimeIntent]? = nil, output: OutputData? = nil) { + public init( + input: InputData? = nil, + alternateIntents: Bool? = nil, + context: Context? = nil, + entities: [RuntimeEntity]? = nil, + intents: [RuntimeIntent]? = nil, + output: OutputData? = nil + ) + { self.input = input self.alternateIntents = alternateIntents self.context = context diff --git a/Source/AssistantV1/Models/MessageResponse.swift b/Source/AssistantV1/Models/MessageResponse.swift index 538938e0a..227a9e2c7 100644 --- a/Source/AssistantV1/Models/MessageResponse.swift +++ b/Source/AssistantV1/Models/MessageResponse.swift @@ -19,22 +19,34 @@ import Foundation /** A response from the Watson Assistant service. */ public struct MessageResponse: Decodable { - /// The user input from the request. + /** + The user input from the request. + */ public var input: MessageInput? - /// An array of intents recognized in the user input, sorted in descending order of confidence. + /** + An array of intents recognized in the user input, sorted in descending order of confidence. + */ public var intents: [RuntimeIntent] - /// An array of entities identified in the user input. + /** + An array of entities identified in the user input. + */ public var entities: [RuntimeEntity] - /// Whether to return more than one intent. A value of `true` indicates that all matching intents are returned. + /** + Whether to return more than one intent. A value of `true` indicates that all matching intents are returned. + */ public var alternateIntents: Bool? - /// State information for the conversation. + /** + State information for the conversation. + */ public var context: Context - /// Output from the dialog, including the response to the user, the nodes that were triggered, and log messages. + /** + Output from the dialog, including the response to the user, the nodes that were triggered, and log messages. + */ public var output: OutputData /// Additional properties associated with this model. diff --git a/Source/AssistantV1/Models/OutputData.swift b/Source/AssistantV1/Models/OutputData.swift index 67e0e94a1..f59b3ba79 100644 --- a/Source/AssistantV1/Models/OutputData.swift +++ b/Source/AssistantV1/Models/OutputData.swift @@ -19,16 +19,27 @@ import Foundation /** An output object that includes the response to the user, the nodes that were hit, and messages from the log. */ public struct OutputData: Codable { - /// An array of up to 50 messages logged with the request. + /** + An array of up to 50 messages logged with the request. + */ public var logMessages: [LogMessage] - /// An array of responses to the user. + /** + An array of responses to the user. + */ public var text: [String] - /// An array of the nodes that were triggered to create the response, in the order in which they were visited. This information is useful for debugging and for tracing the path taken through the node tree. + /** + An array of the nodes that were triggered to create the response, in the order in which they were visited. This + information is useful for debugging and for tracing the path taken through the node tree. + */ public var nodesVisited: [String]? - /// An array of objects containing detailed diagnostic information about the nodes that were triggered during processing of the input message. Included only if **nodes_visited_details** is set to `true` in the message request. + /** + An array of objects containing detailed diagnostic information about the nodes that were triggered during + processing of the input message. Included only if **nodes_visited_details** is set to `true` in the message + request. + */ public var nodesVisitedDetails: [DialogNodeVisitedDetails]? /// Additional properties associated with this model. @@ -48,12 +59,22 @@ public struct OutputData: Codable { - parameter logMessages: An array of up to 50 messages logged with the request. - parameter text: An array of responses to the user. - - parameter nodesVisited: An array of the nodes that were triggered to create the response, in the order in which they were visited. This information is useful for debugging and for tracing the path taken through the node tree. - - parameter nodesVisitedDetails: An array of objects containing detailed diagnostic information about the nodes that were triggered during processing of the input message. Included only if **nodes_visited_details** is set to `true` in the message request. + - parameter nodesVisited: An array of the nodes that were triggered to create the response, in the order in which they were visited. This + information is useful for debugging and for tracing the path taken through the node tree. + - parameter nodesVisitedDetails: An array of objects containing detailed diagnostic information about the nodes that were triggered during + processing of the input message. Included only if **nodes_visited_details** is set to `true` in the message + request. - returns: An initialized `OutputData`. */ - public init(logMessages: [LogMessage], text: [String], nodesVisited: [String]? = nil, nodesVisitedDetails: [DialogNodeVisitedDetails]? = nil, additionalProperties: [String: JSON] = [:]) { + public init( + logMessages: [LogMessage], + text: [String], + nodesVisited: [String]? = nil, + nodesVisitedDetails: [DialogNodeVisitedDetails]? = nil, + additionalProperties: [String: JSON] = [:] + ) + { self.logMessages = logMessages self.text = text self.nodesVisited = nodesVisited diff --git a/Source/AssistantV1/Models/Pagination.swift b/Source/AssistantV1/Models/Pagination.swift index ac814c407..72ae1c002 100644 --- a/Source/AssistantV1/Models/Pagination.swift +++ b/Source/AssistantV1/Models/Pagination.swift @@ -19,22 +19,34 @@ import Foundation /** The pagination data for the returned objects. */ public struct Pagination: Decodable { - /// The URL that will return the same page of results. + /** + The URL that will return the same page of results. + */ public var refreshUrl: String - /// The URL that will return the next page of results. + /** + The URL that will return the next page of results. + */ public var nextUrl: String? - /// Reserved for future use. + /** + Reserved for future use. + */ public var total: Int? - /// Reserved for future use. + /** + Reserved for future use. + */ public var matched: Int? - /// A token identifying the current page of results. + /** + A token identifying the current page of results. + */ public var refreshCursor: String? - /// A token identifying the next page of results. + /** + A token identifying the next page of results. + */ public var nextCursor: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/RuntimeEntity.swift b/Source/AssistantV1/Models/RuntimeEntity.swift index badce31fc..2d8a7adc0 100644 --- a/Source/AssistantV1/Models/RuntimeEntity.swift +++ b/Source/AssistantV1/Models/RuntimeEntity.swift @@ -19,22 +19,35 @@ import Foundation /** A term from the request that was identified as an entity. */ public struct RuntimeEntity: Codable { - /// An entity detected in the input. + /** + An entity detected in the input. + */ public var entity: String - /// An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text. + /** + An array of zero-based character offsets that indicate where the detected entity values begin and end in the input + text. + */ public var location: [Int] - /// The term in the input text that was recognized as an entity value. + /** + The term in the input text that was recognized as an entity value. + */ public var value: String - /// A decimal percentage that represents Watson's confidence in the entity. + /** + A decimal percentage that represents Watson's confidence in the entity. + */ public var confidence: Double? - /// Any metadata for the entity. + /** + Any metadata for the entity. + */ public var metadata: [String: JSON]? - /// The recognized capture groups for the entity, as defined by the entity pattern. + /** + The recognized capture groups for the entity, as defined by the entity pattern. + */ public var groups: [CaptureGroup]? /// Additional properties associated with this model. @@ -55,7 +68,8 @@ public struct RuntimeEntity: Codable { Initialize a `RuntimeEntity` with member variables. - parameter entity: An entity detected in the input. - - parameter location: An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text. + - parameter location: An array of zero-based character offsets that indicate where the detected entity values begin and end in the + input text. - parameter value: The term in the input text that was recognized as an entity value. - parameter confidence: A decimal percentage that represents Watson's confidence in the entity. - parameter metadata: Any metadata for the entity. @@ -63,7 +77,16 @@ public struct RuntimeEntity: Codable { - returns: An initialized `RuntimeEntity`. */ - public init(entity: String, location: [Int], value: String, confidence: Double? = nil, metadata: [String: JSON]? = nil, groups: [CaptureGroup]? = nil, additionalProperties: [String: JSON] = [:]) { + public init( + entity: String, + location: [Int], + value: String, + confidence: Double? = nil, + metadata: [String: JSON]? = nil, + groups: [CaptureGroup]? = nil, + additionalProperties: [String: JSON] = [:] + ) + { self.entity = entity self.location = location self.value = value diff --git a/Source/AssistantV1/Models/RuntimeIntent.swift b/Source/AssistantV1/Models/RuntimeIntent.swift index 462053998..bc0495e35 100644 --- a/Source/AssistantV1/Models/RuntimeIntent.swift +++ b/Source/AssistantV1/Models/RuntimeIntent.swift @@ -19,10 +19,14 @@ import Foundation /** An intent identified in the user input. */ public struct RuntimeIntent: Codable { - /// The name of the recognized intent. + /** + The name of the recognized intent. + */ public var intent: String - /// A decimal percentage that represents Watson's confidence in the intent. + /** + A decimal percentage that represents Watson's confidence in the intent. + */ public var confidence: Double /// Additional properties associated with this model. @@ -43,7 +47,12 @@ public struct RuntimeIntent: Codable { - returns: An initialized `RuntimeIntent`. */ - public init(intent: String, confidence: Double, additionalProperties: [String: JSON] = [:]) { + public init( + intent: String, + confidence: Double, + additionalProperties: [String: JSON] = [:] + ) + { self.intent = intent self.confidence = confidence self.additionalProperties = additionalProperties diff --git a/Source/AssistantV1/Models/Synonym.swift b/Source/AssistantV1/Models/Synonym.swift index bd15b321d..327b8fa0c 100644 --- a/Source/AssistantV1/Models/Synonym.swift +++ b/Source/AssistantV1/Models/Synonym.swift @@ -19,13 +19,19 @@ import Foundation /** Synonym. */ public struct Synonym: Decodable { - /// The text of the synonym. + /** + The text of the synonym. + */ public var synonymText: String - /// The timestamp for creation of the synonym. + /** + The timestamp for creation of the synonym. + */ public var created: String? - /// The timestamp for the most recent update to the synonym. + /** + The timestamp for the most recent update to the synonym. + */ public var updated: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/SynonymCollection.swift b/Source/AssistantV1/Models/SynonymCollection.swift index 37bb38fa5..baa5bc53e 100644 --- a/Source/AssistantV1/Models/SynonymCollection.swift +++ b/Source/AssistantV1/Models/SynonymCollection.swift @@ -19,10 +19,14 @@ import Foundation /** SynonymCollection. */ public struct SynonymCollection: Decodable { - /// An array of synonyms. + /** + An array of synonyms. + */ public var synonyms: [Synonym] - /// The pagination data for the returned objects. + /** + The pagination data for the returned objects. + */ public var pagination: Pagination // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/SystemResponse.swift b/Source/AssistantV1/Models/SystemResponse.swift index a6d8bba71..316141d8f 100644 --- a/Source/AssistantV1/Models/SystemResponse.swift +++ b/Source/AssistantV1/Models/SystemResponse.swift @@ -27,7 +27,10 @@ public struct SystemResponse: Codable { - returns: An initialized `SystemResponse`. */ - public init(additionalProperties: [String: JSON] = [:]) { + public init( + additionalProperties: [String: JSON] = [:] + ) + { self.additionalProperties = additionalProperties } diff --git a/Source/AssistantV1/Models/UpdateCounterexample.swift b/Source/AssistantV1/Models/UpdateCounterexample.swift index f2c79c170..7357e823d 100644 --- a/Source/AssistantV1/Models/UpdateCounterexample.swift +++ b/Source/AssistantV1/Models/UpdateCounterexample.swift @@ -19,7 +19,9 @@ import Foundation /** UpdateCounterexample. */ public struct UpdateCounterexample: Encodable { - /// The text of a user input counterexample. + /** + The text of a user input counterexample. + */ public var text: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -34,7 +36,10 @@ public struct UpdateCounterexample: Encodable { - returns: An initialized `UpdateCounterexample`. */ - public init(text: String? = nil) { + public init( + text: String? = nil + ) + { self.text = text } diff --git a/Source/AssistantV1/Models/UpdateDialogNode.swift b/Source/AssistantV1/Models/UpdateDialogNode.swift index d24d461d3..9d3d19b0f 100644 --- a/Source/AssistantV1/Models/UpdateDialogNode.swift +++ b/Source/AssistantV1/Models/UpdateDialogNode.swift @@ -19,7 +19,9 @@ import Foundation /** UpdateDialogNode. */ public struct UpdateDialogNode: Encodable { - /// How the dialog node is processed. + /** + How the dialog node is processed. + */ public enum NodeType: String { case standard = "standard" case eventHandler = "event_handler" @@ -29,7 +31,9 @@ public struct UpdateDialogNode: Encodable { case folder = "folder" } - /// How an `event_handler` node is processed. + /** + How an `event_handler` node is processed. + */ public enum EventName: String { case focus = "focus" case input = "input" @@ -42,76 +46,123 @@ public struct UpdateDialogNode: Encodable { case digressionReturnPrompt = "digression_return_prompt" } - /// Whether this top-level dialog node can be digressed into. + /** + Whether this top-level dialog node can be digressed into. + */ public enum DigressIn: String { case notAvailable = "not_available" case returns = "returns" case doesNotReturn = "does_not_return" } - /// Whether this dialog node can be returned to after a digression. + /** + Whether this dialog node can be returned to after a digression. + */ public enum DigressOut: String { case returning = "allow_returning" case all = "allow_all" case allNeverReturn = "allow_all_never_return" } - /// Whether the user can digress to top-level nodes while filling out slots. + /** + Whether the user can digress to top-level nodes while filling out slots. + */ public enum DigressOutSlots: String { case notAllowed = "not_allowed" case allowReturning = "allow_returning" case allowAll = "allow_all" } - /// The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters. + /** + The dialog node ID. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. + - It must be no longer than 1024 characters. + */ public var dialogNode: String? - /// The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + /** + The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it + must be no longer than 128 characters. + */ public var description: String? - /// The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters. + /** + The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab + characters, and it must be no longer than 2048 characters. + */ public var conditions: String? - /// The ID of the parent dialog node. + /** + The ID of the parent dialog node. + */ public var parent: String? - /// The ID of the previous sibling dialog node. + /** + The ID of the previous sibling dialog node. + */ public var previousSibling: String? - /// The output of the dialog node. For more information about how to specify dialog node output, see the [documentation](https://console.bluemix.net/docs/services/conversation/dialog-overview.html#complex). + /** + The output of the dialog node. For more information about how to specify dialog node output, see the + [documentation](https://console.bluemix.net/docs/services/conversation/dialog-overview.html#complex). + */ public var output: [String: JSON]? - /// The context for the dialog node. + /** + The context for the dialog node. + */ public var context: [String: JSON]? - /// The metadata for the dialog node. + /** + The metadata for the dialog node. + */ public var metadata: [String: JSON]? - /// The next step to be executed in dialog processing. + /** + The next step to be executed in dialog processing. + */ public var nextStep: DialogNodeNextStep? - /// The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters. + /** + The alias used to identify the dialog node. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. + - It must be no longer than 64 characters. + */ public var title: String? - /// How the dialog node is processed. + /** + How the dialog node is processed. + */ public var nodeType: String? - /// How an `event_handler` node is processed. + /** + How an `event_handler` node is processed. + */ public var eventName: String? - /// The location in the dialog context where output is stored. + /** + The location in the dialog context where output is stored. + */ public var variable: String? - /// An array of objects describing any actions to be invoked by the dialog node. + /** + An array of objects describing any actions to be invoked by the dialog node. + */ public var actions: [DialogNodeAction]? - /// Whether this top-level dialog node can be digressed into. + /** + Whether this top-level dialog node can be digressed into. + */ public var digressIn: String? - /// Whether this dialog node can be returned to after a digression. + /** + Whether this dialog node can be returned to after a digression. + */ public var digressOut: String? - /// Whether the user can digress to top-level nodes while filling out slots. + /** + Whether the user can digress to top-level nodes while filling out slots. + */ public var digressOutSlots: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -138,16 +189,23 @@ public struct UpdateDialogNode: Encodable { /** Initialize a `UpdateDialogNode` with member variables. - - parameter dialogNode: The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters. - - parameter description: The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. - - parameter conditions: The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters. + - parameter dialogNode: The dialog node ID. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. + - It must be no longer than 1024 characters. + - parameter description: The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and + it must be no longer than 128 characters. + - parameter conditions: The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab + characters, and it must be no longer than 2048 characters. - parameter parent: The ID of the parent dialog node. - parameter previousSibling: The ID of the previous sibling dialog node. - - parameter output: The output of the dialog node. For more information about how to specify dialog node output, see the [documentation](https://console.bluemix.net/docs/services/conversation/dialog-overview.html#complex). + - parameter output: The output of the dialog node. For more information about how to specify dialog node output, see the + [documentation](https://console.bluemix.net/docs/services/conversation/dialog-overview.html#complex). - parameter context: The context for the dialog node. - parameter metadata: The metadata for the dialog node. - parameter nextStep: The next step to be executed in dialog processing. - - parameter title: The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters. + - parameter title: The alias used to identify the dialog node. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. + - It must be no longer than 64 characters. - parameter nodeType: How the dialog node is processed. - parameter eventName: How an `event_handler` node is processed. - parameter variable: The location in the dialog context where output is stored. @@ -158,7 +216,26 @@ public struct UpdateDialogNode: Encodable { - returns: An initialized `UpdateDialogNode`. */ - public init(dialogNode: String? = nil, description: String? = nil, conditions: String? = nil, parent: String? = nil, previousSibling: String? = nil, output: [String: JSON]? = nil, context: [String: JSON]? = nil, metadata: [String: JSON]? = nil, nextStep: DialogNodeNextStep? = nil, title: String? = nil, nodeType: String? = nil, eventName: String? = nil, variable: String? = nil, actions: [DialogNodeAction]? = nil, digressIn: String? = nil, digressOut: String? = nil, digressOutSlots: String? = nil) { + public init( + dialogNode: String? = nil, + description: String? = nil, + conditions: String? = nil, + parent: String? = nil, + previousSibling: String? = nil, + output: [String: JSON]? = nil, + context: [String: JSON]? = nil, + metadata: [String: JSON]? = nil, + nextStep: DialogNodeNextStep? = nil, + title: String? = nil, + nodeType: String? = nil, + eventName: String? = nil, + variable: String? = nil, + actions: [DialogNodeAction]? = nil, + digressIn: String? = nil, + digressOut: String? = nil, + digressOutSlots: String? = nil + ) + { self.dialogNode = dialogNode self.description = description self.conditions = conditions diff --git a/Source/AssistantV1/Models/UpdateEntity.swift b/Source/AssistantV1/Models/UpdateEntity.swift index be273e3bd..8ed767cee 100644 --- a/Source/AssistantV1/Models/UpdateEntity.swift +++ b/Source/AssistantV1/Models/UpdateEntity.swift @@ -19,19 +19,33 @@ import Foundation /** UpdateEntity. */ public struct UpdateEntity: Encodable { - /// The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix `sys-`. - It must be no longer than 64 characters. + /** + The name of the entity. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, underscore, and hyphen characters. + - It cannot begin with the reserved prefix `sys-`. + - It must be no longer than 64 characters. + */ public var entity: String? - /// The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + /** + The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must + be no longer than 128 characters. + */ public var description: String? - /// Any metadata related to the entity. + /** + Any metadata related to the entity. + */ public var metadata: [String: JSON]? - /// Whether to use fuzzy matching for the entity. + /** + Whether to use fuzzy matching for the entity. + */ public var fuzzyMatch: Bool? - /// An array of entity values. + /** + An array of entity values. + */ public var values: [CreateValue]? // Map each property name to the key that shall be used for encoding/decoding. @@ -46,15 +60,26 @@ public struct UpdateEntity: Encodable { /** Initialize a `UpdateEntity` with member variables. - - parameter entity: The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix `sys-`. - It must be no longer than 64 characters. - - parameter description: The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + - parameter entity: The name of the entity. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, underscore, and hyphen characters. + - It cannot begin with the reserved prefix `sys-`. + - It must be no longer than 64 characters. + - parameter description: The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it + must be no longer than 128 characters. - parameter metadata: Any metadata related to the entity. - parameter fuzzyMatch: Whether to use fuzzy matching for the entity. - parameter values: An array of entity values. - returns: An initialized `UpdateEntity`. */ - public init(entity: String? = nil, description: String? = nil, metadata: [String: JSON]? = nil, fuzzyMatch: Bool? = nil, values: [CreateValue]? = nil) { + public init( + entity: String? = nil, + description: String? = nil, + metadata: [String: JSON]? = nil, + fuzzyMatch: Bool? = nil, + values: [CreateValue]? = nil + ) + { self.entity = entity self.description = description self.metadata = metadata diff --git a/Source/AssistantV1/Models/UpdateExample.swift b/Source/AssistantV1/Models/UpdateExample.swift index f2fd9beb6..8f064169d 100644 --- a/Source/AssistantV1/Models/UpdateExample.swift +++ b/Source/AssistantV1/Models/UpdateExample.swift @@ -19,7 +19,12 @@ import Foundation /** UpdateExample. */ public struct UpdateExample: Encodable { - /// The text of the user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters. + /** + The text of the user input example. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 1024 characters. + */ public var text: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -30,11 +35,17 @@ public struct UpdateExample: Encodable { /** Initialize a `UpdateExample` with member variables. - - parameter text: The text of the user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters. + - parameter text: The text of the user input example. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 1024 characters. - returns: An initialized `UpdateExample`. */ - public init(text: String? = nil) { + public init( + text: String? = nil + ) + { self.text = text } diff --git a/Source/AssistantV1/Models/UpdateIntent.swift b/Source/AssistantV1/Models/UpdateIntent.swift index 96d9e52c0..ea350b2ae 100644 --- a/Source/AssistantV1/Models/UpdateIntent.swift +++ b/Source/AssistantV1/Models/UpdateIntent.swift @@ -19,13 +19,22 @@ import Foundation /** UpdateIntent. */ public struct UpdateIntent: Encodable { - /// The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix `sys-`. - It must be no longer than 128 characters. + /** + The name of the intent. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. + - It cannot begin with the reserved prefix `sys-`. + - It must be no longer than 128 characters. + */ public var intent: String? - /// The description of the intent. + /** + The description of the intent. + */ public var description: String? - /// An array of user input examples for the intent. + /** + An array of user input examples for the intent. + */ public var examples: [CreateExample]? // Map each property name to the key that shall be used for encoding/decoding. @@ -38,13 +47,21 @@ public struct UpdateIntent: Encodable { /** Initialize a `UpdateIntent` with member variables. - - parameter intent: The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix `sys-`. - It must be no longer than 128 characters. + - parameter intent: The name of the intent. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. + - It cannot begin with the reserved prefix `sys-`. + - It must be no longer than 128 characters. - parameter description: The description of the intent. - parameter examples: An array of user input examples for the intent. - returns: An initialized `UpdateIntent`. */ - public init(intent: String? = nil, description: String? = nil, examples: [CreateExample]? = nil) { + public init( + intent: String? = nil, + description: String? = nil, + examples: [CreateExample]? = nil + ) + { self.intent = intent self.description = description self.examples = examples diff --git a/Source/AssistantV1/Models/UpdateSynonym.swift b/Source/AssistantV1/Models/UpdateSynonym.swift index 3532ab38a..b5342ce27 100644 --- a/Source/AssistantV1/Models/UpdateSynonym.swift +++ b/Source/AssistantV1/Models/UpdateSynonym.swift @@ -19,7 +19,12 @@ import Foundation /** UpdateSynonym. */ public struct UpdateSynonym: Encodable { - /// The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. + /** + The text of the synonym. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. + */ public var synonym: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -30,11 +35,17 @@ public struct UpdateSynonym: Encodable { /** Initialize a `UpdateSynonym` with member variables. - - parameter synonym: The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. + - parameter synonym: The text of the synonym. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. - returns: An initialized `UpdateSynonym`. */ - public init(synonym: String? = nil) { + public init( + synonym: String? = nil + ) + { self.synonym = synonym } diff --git a/Source/AssistantV1/Models/UpdateValue.swift b/Source/AssistantV1/Models/UpdateValue.swift index fe3562a98..362ef978b 100644 --- a/Source/AssistantV1/Models/UpdateValue.swift +++ b/Source/AssistantV1/Models/UpdateValue.swift @@ -19,25 +19,47 @@ import Foundation /** UpdateValue. */ public struct UpdateValue: Encodable { - /// Specifies the type of value. + /** + Specifies the type of value. + */ public enum ValueType: String { case synonyms = "synonyms" case patterns = "patterns" } - /// The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. + /** + The text of the entity value. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. + */ public var value: String? - /// Any metadata related to the entity value. + /** + Any metadata related to the entity value. + */ public var metadata: [String: JSON]? - /// Specifies the type of value. + /** + Specifies the type of value. + */ public var valueType: String? - /// An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by **type**), but not both. A synonym must conform to the following resrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. + /** + An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by **type**), + but not both. A synonym must conform to the following resrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. + */ public var synonyms: [String]? - /// An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by **type**), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities). + /** + An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by **type**), + but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to + specify a pattern, see the + [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities). + */ public var patterns: [String]? // Map each property name to the key that shall be used for encoding/decoding. @@ -52,15 +74,32 @@ public struct UpdateValue: Encodable { /** Initialize a `UpdateValue` with member variables. - - parameter value: The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. + - parameter value: The text of the entity value. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. - parameter metadata: Any metadata related to the entity value. - parameter valueType: Specifies the type of value. - - parameter synonyms: An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by **type**), but not both. A synonym must conform to the following resrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. - - parameter patterns: An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by **type**), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities). + - parameter synonyms: An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by + **type**), but not both. A synonym must conform to the following resrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. + - parameter patterns: An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by + **type**), but not both. A pattern is a regular expression no longer than 128 characters. For more information + about how to specify a pattern, see the + [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities). - returns: An initialized `UpdateValue`. */ - public init(value: String? = nil, metadata: [String: JSON]? = nil, valueType: String? = nil, synonyms: [String]? = nil, patterns: [String]? = nil) { + public init( + value: String? = nil, + metadata: [String: JSON]? = nil, + valueType: String? = nil, + synonyms: [String]? = nil, + patterns: [String]? = nil + ) + { self.value = value self.metadata = metadata self.valueType = valueType diff --git a/Source/AssistantV1/Models/UpdateWorkspace.swift b/Source/AssistantV1/Models/UpdateWorkspace.swift index 06a935d0e..dec2167d9 100644 --- a/Source/AssistantV1/Models/UpdateWorkspace.swift +++ b/Source/AssistantV1/Models/UpdateWorkspace.swift @@ -19,31 +19,52 @@ import Foundation /** UpdateWorkspace. */ public struct UpdateWorkspace: Encodable { - /// The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters. + /** + The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be + no longer than 64 characters. + */ public var name: String? - /// The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + /** + The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it + must be no longer than 128 characters. + */ public var description: String? - /// The language of the workspace. + /** + The language of the workspace. + */ public var language: String? - /// An array of objects defining the intents for the workspace. + /** + An array of objects defining the intents for the workspace. + */ public var intents: [CreateIntent]? - /// An array of objects defining the entities for the workspace. + /** + An array of objects defining the entities for the workspace. + */ public var entities: [CreateEntity]? - /// An array of objects defining the nodes in the workspace dialog. + /** + An array of objects defining the nodes in the workspace dialog. + */ public var dialogNodes: [CreateDialogNode]? - /// An array of objects defining input examples that have been marked as irrelevant input. + /** + An array of objects defining input examples that have been marked as irrelevant input. + */ public var counterexamples: [CreateCounterexample]? - /// Any metadata related to the workspace. + /** + Any metadata related to the workspace. + */ public var metadata: [String: JSON]? - /// Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates that workspace training data is not to be used. + /** + Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates that + workspace training data is not to be used. + */ public var learningOptOut: Bool? // Map each property name to the key that shall be used for encoding/decoding. @@ -62,19 +83,33 @@ public struct UpdateWorkspace: Encodable { /** Initialize a `UpdateWorkspace` with member variables. - - parameter name: The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters. - - parameter description: The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + - parameter name: The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be + no longer than 64 characters. + - parameter description: The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it + must be no longer than 128 characters. - parameter language: The language of the workspace. - parameter intents: An array of objects defining the intents for the workspace. - parameter entities: An array of objects defining the entities for the workspace. - parameter dialogNodes: An array of objects defining the nodes in the workspace dialog. - parameter counterexamples: An array of objects defining input examples that have been marked as irrelevant input. - parameter metadata: Any metadata related to the workspace. - - parameter learningOptOut: Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates that workspace training data is not to be used. + - parameter learningOptOut: Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates + that workspace training data is not to be used. - returns: An initialized `UpdateWorkspace`. */ - public init(name: String? = nil, description: String? = nil, language: String? = nil, intents: [CreateIntent]? = nil, entities: [CreateEntity]? = nil, dialogNodes: [CreateDialogNode]? = nil, counterexamples: [CreateCounterexample]? = nil, metadata: [String: JSON]? = nil, learningOptOut: Bool? = nil) { + public init( + name: String? = nil, + description: String? = nil, + language: String? = nil, + intents: [CreateIntent]? = nil, + entities: [CreateEntity]? = nil, + dialogNodes: [CreateDialogNode]? = nil, + counterexamples: [CreateCounterexample]? = nil, + metadata: [String: JSON]? = nil, + learningOptOut: Bool? = nil + ) + { self.name = name self.description = description self.language = language diff --git a/Source/AssistantV1/Models/Value.swift b/Source/AssistantV1/Models/Value.swift index 47dafbcd6..1208b83b1 100644 --- a/Source/AssistantV1/Models/Value.swift +++ b/Source/AssistantV1/Models/Value.swift @@ -19,31 +19,47 @@ import Foundation /** Value. */ public struct Value: Decodable { - /// Specifies the type of value. + /** + Specifies the type of value. + */ public enum ValueType: String { case synonyms = "synonyms" case patterns = "patterns" } - /// The text of the entity value. + /** + The text of the entity value. + */ public var valueText: String - /// Any metadata related to the entity value. + /** + Any metadata related to the entity value. + */ public var metadata: [String: JSON]? - /// The timestamp for creation of the entity value. + /** + The timestamp for creation of the entity value. + */ public var created: String? - /// The timestamp for the last update to the entity value. + /** + The timestamp for the last update to the entity value. + */ public var updated: String? - /// An array containing any synonyms for the entity value. + /** + An array containing any synonyms for the entity value. + */ public var synonyms: [String]? - /// An array containing any patterns for the entity value. + /** + An array containing any patterns for the entity value. + */ public var patterns: [String]? - /// Specifies the type of value. + /** + Specifies the type of value. + */ public var valueType: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/ValueCollection.swift b/Source/AssistantV1/Models/ValueCollection.swift index ee6c8de38..9fcff5f6c 100644 --- a/Source/AssistantV1/Models/ValueCollection.swift +++ b/Source/AssistantV1/Models/ValueCollection.swift @@ -19,10 +19,14 @@ import Foundation /** ValueCollection. */ public struct ValueCollection: Decodable { - /// An array of entity values. + /** + An array of entity values. + */ public var values: [ValueExport] - /// An object defining the pagination data for the returned objects. + /** + An object defining the pagination data for the returned objects. + */ public var pagination: Pagination // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/ValueExport.swift b/Source/AssistantV1/Models/ValueExport.swift index 521c14312..f9b199d57 100644 --- a/Source/AssistantV1/Models/ValueExport.swift +++ b/Source/AssistantV1/Models/ValueExport.swift @@ -19,31 +19,47 @@ import Foundation /** ValueExport. */ public struct ValueExport: Decodable { - /// Specifies the type of value. + /** + Specifies the type of value. + */ public enum ValueType: String { case synonyms = "synonyms" case patterns = "patterns" } - /// The text of the entity value. + /** + The text of the entity value. + */ public var valueText: String - /// Any metadata related to the entity value. + /** + Any metadata related to the entity value. + */ public var metadata: [String: JSON]? - /// The timestamp for creation of the entity value. + /** + The timestamp for creation of the entity value. + */ public var created: String? - /// The timestamp for the last update to the entity value. + /** + The timestamp for the last update to the entity value. + */ public var updated: String? - /// An array containing any synonyms for the entity value. + /** + An array containing any synonyms for the entity value. + */ public var synonyms: [String]? - /// An array containing any patterns for the entity value. + /** + An array containing any patterns for the entity value. + */ public var patterns: [String]? - /// Specifies the type of value. + /** + Specifies the type of value. + */ public var valueType: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/Workspace.swift b/Source/AssistantV1/Models/Workspace.swift index 985136ee8..55e43fc1f 100644 --- a/Source/AssistantV1/Models/Workspace.swift +++ b/Source/AssistantV1/Models/Workspace.swift @@ -19,28 +19,45 @@ import Foundation /** Workspace. */ public struct Workspace: Decodable { - /// The name of the workspace. + /** + The name of the workspace. + */ public var name: String - /// The language of the workspace. + /** + The language of the workspace. + */ public var language: String - /// The timestamp for creation of the workspace. + /** + The timestamp for creation of the workspace. + */ public var created: String? - /// The timestamp for the last update to the workspace. + /** + The timestamp for the last update to the workspace. + */ public var updated: String? - /// The workspace ID. + /** + The workspace ID. + */ public var workspaceID: String - /// The description of the workspace. + /** + The description of the workspace. + */ public var description: String? - /// Any metadata related to the workspace. + /** + Any metadata related to the workspace. + */ public var metadata: [String: JSON]? - /// Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for general service improvements. `true` indicates that workspace training data is not to be used. + /** + Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for + general service improvements. `true` indicates that workspace training data is not to be used. + */ public var learningOptOut: Bool? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/WorkspaceCollection.swift b/Source/AssistantV1/Models/WorkspaceCollection.swift index 5fd10e6ba..a90f2aa54 100644 --- a/Source/AssistantV1/Models/WorkspaceCollection.swift +++ b/Source/AssistantV1/Models/WorkspaceCollection.swift @@ -19,10 +19,14 @@ import Foundation /** WorkspaceCollection. */ public struct WorkspaceCollection: Decodable { - /// An array of objects describing the workspaces associated with the service instance. + /** + An array of objects describing the workspaces associated with the service instance. + */ public var workspaces: [Workspace] - /// An object defining the pagination data for the returned objects. + /** + An object defining the pagination data for the returned objects. + */ public var pagination: Pagination // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/AssistantV1/Models/WorkspaceExport.swift b/Source/AssistantV1/Models/WorkspaceExport.swift index 574f7e0b0..fd1590e44 100644 --- a/Source/AssistantV1/Models/WorkspaceExport.swift +++ b/Source/AssistantV1/Models/WorkspaceExport.swift @@ -19,7 +19,9 @@ import Foundation /** WorkspaceExport. */ public struct WorkspaceExport: Decodable { - /// The current status of the workspace. + /** + The current status of the workspace. + */ public enum Status: String { case nonExistent = "Non Existent" case training = "Training" @@ -28,43 +30,70 @@ public struct WorkspaceExport: Decodable { case unavailable = "Unavailable" } - /// The name of the workspace. + /** + The name of the workspace. + */ public var name: String - /// The description of the workspace. + /** + The description of the workspace. + */ public var description: String - /// The language of the workspace. + /** + The language of the workspace. + */ public var language: String - /// Any metadata that is required by the workspace. + /** + Any metadata that is required by the workspace. + */ public var metadata: [String: JSON] - /// The timestamp for creation of the workspace. + /** + The timestamp for creation of the workspace. + */ public var created: String? - /// The timestamp for the last update to the workspace. + /** + The timestamp for the last update to the workspace. + */ public var updated: String? - /// The workspace ID. + /** + The workspace ID. + */ public var workspaceID: String - /// The current status of the workspace. + /** + The current status of the workspace. + */ public var status: String - /// Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates that workspace training data is not to be used. + /** + Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates that + workspace training data is not to be used. + */ public var learningOptOut: Bool - /// An array of intents. + /** + An array of intents. + */ public var intents: [IntentExport]? - /// An array of entities. + /** + An array of entities. + */ public var entities: [EntityExport]? - /// An array of counterexamples. + /** + An array of counterexamples. + */ public var counterexamples: [Counterexample]? - /// An array of objects describing the dialog nodes in the workspace. + /** + An array of objects describing the dialog nodes in the workspace. + */ public var dialogNodes: [DialogNode]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Conversation.swift b/Source/ConversationV1/Conversation.swift index 3236d890f..5c18dc61e 100644 --- a/Source/ConversationV1/Conversation.swift +++ b/Source/ConversationV1/Conversation.swift @@ -17,8 +17,8 @@ import Foundation /** - The IBM Watson Conversation service combines machine learning, natural language understanding, and integrated dialog - tools to create conversation flows between your apps and your users. + The IBM Watson™ Conversation service combines machine learning, natural language understanding, and integrated + dialog tools to create conversation flows between your apps and your users. */ @available(*, deprecated, message: "The IBM Watson Conversation service has been renamed to Assistant. Please use the `Assistant` class instead of `Conversation`. The `Conversation` class will be removed in a future release.") public class Conversation { @@ -117,13 +117,14 @@ public class Conversation { /** Get response to user input. - Get a response to a user's input. There is no rate limit for this operation. + Get a response to a user's input. + There is no rate limit for this operation. - parameter workspaceID: Unique identifier of the workspace. - - parameter request: The message to be sent. This includes the user's input, along with optional intents, entities, and context from the - last response. - - parameter nodesVisitedDetails: Whether to include additional diagnostic information about the dialog nodes that were visited during processing of - the message. + - parameter request: The message to be sent. This includes the user's input, along with optional intents, entities, and context from + the last response. + - parameter nodesVisitedDetails: Whether to include additional diagnostic information about the dialog nodes that were visited during processing + of the message. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -186,13 +187,13 @@ public class Conversation { /** List workspaces. - List the workspaces associated with a Conversation service instance. This operation is limited to 500 requests - per 30 minutes. For more information, see **Rate limiting**. + List the workspaces associated with a Conversation service instance. + This operation is limited to 500 requests per 30 minutes. For more information, see **Rate limiting**. - parameter pageLimit: The number of records to return in each page of results. - parameter includeCount: Whether to include information about the number of records returned. - parameter sort: The attribute by which returned results will be sorted. To reverse the sort order, prefix the value with a minus - sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. + sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. - parameter cursor: A token identifying the page of results to retrieve. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. @@ -263,11 +264,12 @@ public class Conversation { Create workspace. Create a workspace based on component objects. You must provide workspace components defining the content of the - new workspace. This operation is limited to 30 requests per 30 minutes. For more information, see **Rate - limiting**. + new workspace. + This operation is limited to 30 requests per 30 minutes. For more information, see **Rate limiting**. - - parameter properties: The content of the new workspace. The maximum size for this data is 50MB. If you need to import a larger - workspace, consider importing the workspace without intents and entities and then adding them separately. + - parameter properties: The content of the new workspace. + The maximum size for this data is 50MB. If you need to import a larger workspace, consider importing the + workspace without intents and entities and then adding them separately. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -319,13 +321,13 @@ public class Conversation { /** Get information about a workspace. - Get information about a workspace, optionally including all workspace content. With **export**=`false`, this - operation is limited to 6000 requests per 5 minutes. With **export**=`true`, the limit is 20 requests per 30 - minutes. For more information, see **Rate limiting**. + Get information about a workspace, optionally including all workspace content. + With **export**=`false`, this operation is limited to 6000 requests per 5 minutes. With **export**=`true`, the + limit is 20 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only - information about the element itself. If **export**=`true`, all content, including subelements, is included. + - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes + only information about the element itself. If **export**=`true`, all content, including subelements, is included. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. @@ -386,18 +388,19 @@ public class Conversation { Update workspace. Update an existing workspace with new or modified data. You must provide component objects defining the content of - the updated workspace. This operation is limited to 30 request per 30 minutes. For more information, see **Rate - limiting**. + the updated workspace. + This operation is limited to 30 request per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - - parameter properties: Valid data defining the new and updated workspace content. The maximum size for this data is 50MB. If you need - to import a larger amount of workspace data, consider importing components such as intents and entities using - separate operations. + - parameter properties: Valid data defining the new and updated workspace content. + The maximum size for this data is 50MB. If you need to import a larger amount of workspace data, consider + importing components such as intents and entities using separate operations. - parameter append: Whether the new data is to be appended to the existing data in the workspace. If **append**=`false`, elements - included in the new data completely replace the corresponding existing elements, including all subelements. For - example, if the new data includes **entities** and **append**=`false`, all existing entities in the workspace are - discarded and replaced with the new entities. If **append**=`true`, existing elements are preserved, and the new - elements are added. If any elements in the new data collide with existing elements, the update request fails. + included in the new data completely replace the corresponding existing elements, including all subelements. For + example, if the new data includes **entities** and **append**=`false`, all existing entities in the workspace are + discarded and replaced with the new entities. + If **append**=`true`, existing elements are preserved, and the new elements are added. If any elements in the new + data collide with existing elements, the update request fails. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -460,8 +463,8 @@ public class Conversation { /** Delete workspace. - Delete a workspace from the service instance. This operation is limited to 30 requests per 30 minutes. For more - information, see **Rate limiting**. + Delete a workspace from the service instance. + This operation is limited to 30 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter headers: A dictionary of request headers to be sent with this request. @@ -512,17 +515,17 @@ public class Conversation { /** List intents. - List the intents for a workspace. With **export**=`false`, this operation is limited to 2000 requests per 30 - minutes. With **export**=`true`, the limit is 400 requests per 30 minutes. For more information, see **Rate - limiting**. + List the intents for a workspace. + With **export**=`false`, this operation is limited to 2000 requests per 30 minutes. With **export**=`true`, the + limit is 400 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only - information about the element itself. If **export**=`true`, all content, including subelements, is included. + - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes + only information about the element itself. If **export**=`true`, all content, including subelements, is included. - parameter pageLimit: The number of records to return in each page of results. - parameter includeCount: Whether to include information about the number of records returned. - parameter sort: The attribute by which returned results will be sorted. To reverse the sort order, prefix the value with a minus - sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. + sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. - parameter cursor: A token identifying the page of results to retrieve. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. @@ -603,15 +606,16 @@ public class Conversation { /** Create intent. - Create a new intent. This operation is limited to 2000 requests per 30 minutes. For more information, see **Rate - limiting**. + Create a new intent. + This operation is limited to 2000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - - parameter intent: The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode - alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix `sys-`. - It - must be no longer than 128 characters. - - parameter description: The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must - be no longer than 128 characters. + - parameter intent: The name of the intent. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. + - It cannot begin with the reserved prefix `sys-`. + - It must be no longer than 128 characters. + - parameter description: The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it + must be no longer than 128 characters. - parameter examples: An array of user input examples for the intent. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. @@ -673,14 +677,14 @@ public class Conversation { /** Get intent. - Get information about an intent, optionally including all intent content. With **export**=`false`, this - operation is limited to 6000 requests per 5 minutes. With **export**=`true`, the limit is 400 requests per 30 - minutes. For more information, see **Rate limiting**. + Get information about an intent, optionally including all intent content. + With **export**=`false`, this operation is limited to 6000 requests per 5 minutes. With **export**=`true`, the + limit is 400 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter intent: The intent name. - - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only - information about the element itself. If **export**=`true`, all content, including subelements, is included. + - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes + only information about the element itself. If **export**=`true`, all content, including subelements, is included. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. @@ -742,14 +746,15 @@ public class Conversation { Update intent. Update an existing intent with new or modified data. You must provide component objects defining the content of the - updated intent. This operation is limited to 2000 requests per 30 minutes. For more information, see **Rate - limiting**. + updated intent. + This operation is limited to 2000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter intent: The intent name. - - parameter newIntent: The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode - alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix `sys-`. - It - must be no longer than 128 characters. + - parameter newIntent: The name of the intent. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. + - It cannot begin with the reserved prefix `sys-`. + - It must be no longer than 128 characters. - parameter newDescription: The description of the intent. - parameter newExamples: An array of user input examples for the intent. - parameter headers: A dictionary of request headers to be sent with this request. @@ -813,8 +818,8 @@ public class Conversation { /** Delete intent. - Delete an intent from a workspace. This operation is limited to 2000 requests per 30 minutes. For more - information, see **Rate limiting**. + Delete an intent from a workspace. + This operation is limited to 2000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter intent: The intent name. @@ -867,15 +872,15 @@ public class Conversation { /** List user input examples. - List the user input examples for an intent. This operation is limited to 2500 requests per 30 minutes. For more - information, see **Rate limiting**. + List the user input examples for an intent. + This operation is limited to 2500 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter intent: The intent name. - parameter pageLimit: The number of records to return in each page of results. - parameter includeCount: Whether to include information about the number of records returned. - parameter sort: The attribute by which returned results will be sorted. To reverse the sort order, prefix the value with a minus - sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. + sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. - parameter cursor: A token identifying the page of results to retrieve. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. @@ -952,14 +957,15 @@ public class Conversation { /** Create user input example. - Add a new user input example to an intent. This operation is limited to 1000 requests per 30 minutes. For more - information, see **Rate limiting**. + Add a new user input example to an intent. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter intent: The intent name. - - parameter text: The text of a user input example. This string must conform to the following restrictions: - It cannot contain - carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no - longer than 1024 characters. + - parameter text: The text of a user input example. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 1024 characters. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1019,8 +1025,8 @@ public class Conversation { /** Get user input example. - Get information about a user input example. This operation is limited to 6000 requests per 5 minutes. For more - information, see **Rate limiting**. + Get information about a user input example. + This operation is limited to 6000 requests per 5 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter intent: The intent name. @@ -1081,15 +1087,16 @@ public class Conversation { /** Update user input example. - Update the text of a user input example. This operation is limited to 1000 requests per 30 minutes. For more - information, see **Rate limiting**. + Update the text of a user input example. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter intent: The intent name. - parameter text: The text of the user input example. - - parameter newText: The text of the user input example. This string must conform to the following restrictions: - It cannot contain - carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no - longer than 1024 characters. + - parameter newText: The text of the user input example. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 1024 characters. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1150,8 +1157,8 @@ public class Conversation { /** Delete user input example. - Delete a user input example from an intent. This operation is limited to 1000 requests per 30 minutes. For more - information, see **Rate limiting**. + Delete a user input example from an intent. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter intent: The intent name. @@ -1207,13 +1214,13 @@ public class Conversation { List counterexamples. List the counterexamples for a workspace. Counterexamples are examples that have been marked as irrelevant input. - This operation is limited to 2500 requests per 30 minutes. For more information, see **Rate limiting**. + This operation is limited to 2500 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter pageLimit: The number of records to return in each page of results. - parameter includeCount: Whether to include information about the number of records returned. - parameter sort: The attribute by which returned results will be sorted. To reverse the sort order, prefix the value with a minus - sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. + sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. - parameter cursor: A token identifying the page of results to retrieve. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. @@ -1293,9 +1300,10 @@ public class Conversation { This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - - parameter text: The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It - cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It - must be no longer than 1024 characters. + - parameter text: The text of a user input marked as irrelevant input. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters + - It cannot consist of only whitespace characters + - It must be no longer than 1024 characters. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1480,7 +1488,7 @@ public class Conversation { Delete counterexample. Delete a counterexample from a workspace. Counterexamples are examples that have been marked as irrelevant input. - This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter text: The text of a user input counterexample (for example, `What are you wearing?`). @@ -1533,17 +1541,17 @@ public class Conversation { /** List entities. - List the entities for a workspace. With **export**=`false`, this operation is limited to 1000 requests per 30 - minutes. With **export**=`true`, the limit is 200 requests per 30 minutes. For more information, see **Rate - limiting**. + List the entities for a workspace. + With **export**=`false`, this operation is limited to 1000 requests per 30 minutes. With **export**=`true`, the + limit is 200 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only - information about the element itself. If **export**=`true`, all content, including subelements, is included. + - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes + only information about the element itself. If **export**=`true`, all content, including subelements, is included. - parameter pageLimit: The number of records to return in each page of results. - parameter includeCount: Whether to include information about the number of records returned. - parameter sort: The attribute by which returned results will be sorted. To reverse the sort order, prefix the value with a minus - sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. + sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. - parameter cursor: A token identifying the page of results to retrieve. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. @@ -1624,8 +1632,8 @@ public class Conversation { /** Create entity. - Create a new entity. This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate - limiting**. + Create a new entity. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter properties: The content of the new entity. @@ -1686,14 +1694,14 @@ public class Conversation { /** Get entity. - Get information about an entity, optionally including all entity content. With **export**=`false`, this - operation is limited to 6000 requests per 5 minutes. With **export**=`true`, the limit is 200 requests per 30 - minutes. For more information, see **Rate limiting**. + Get information about an entity, optionally including all entity content. + With **export**=`false`, this operation is limited to 6000 requests per 5 minutes. With **export**=`true`, the + limit is 200 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. - - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only - information about the element itself. If **export**=`true`, all content, including subelements, is included. + - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes + only information about the element itself. If **export**=`true`, all content, including subelements, is included. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. @@ -1755,15 +1763,15 @@ public class Conversation { Update entity. Update an existing entity with new or modified data. You must provide component objects defining the content of the - updated entity. This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate - limiting**. + updated entity. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. - parameter properties: The updated content of the entity. Any elements included in the new data will completely replace the equivalent - existing elements, including all subelements. (Previously existing subelements are not retained unless they are - also included in the new data.) For example, if you update the values for an entity, the previously existing values - are discarded and replaced with the new values specified in the update. + existing elements, including all subelements. (Previously existing subelements are not retained unless they are + also included in the new data.) For example, if you update the values for an entity, the previously existing + values are discarded and replaced with the new values specified in the update. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1822,8 +1830,8 @@ public class Conversation { /** Delete entity. - Delete an entity from a workspace. This operation is limited to 1000 requests per 30 minutes. For more - information, see **Rate limiting**. + Delete an entity from a workspace. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. @@ -1876,17 +1884,17 @@ public class Conversation { /** List entity values. - List the values for an entity. This operation is limited to 2500 requests per 30 minutes. For more information, - see **Rate limiting**. + List the values for an entity. + This operation is limited to 2500 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. - - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only - information about the element itself. If **export**=`true`, all content, including subelements, is included. + - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes + only information about the element itself. If **export**=`true`, all content, including subelements, is included. - parameter pageLimit: The number of records to return in each page of results. - parameter includeCount: Whether to include information about the number of records returned. - parameter sort: The attribute by which returned results will be sorted. To reverse the sort order, prefix the value with a minus - sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. + sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. - parameter cursor: A token identifying the page of results to retrieve. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. @@ -1968,8 +1976,8 @@ public class Conversation { /** Add entity value. - Create a new value for an entity. This operation is limited to 1000 requests per 30 minutes. For more - information, see **Rate limiting**. + Create a new value for an entity. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. @@ -2032,14 +2040,14 @@ public class Conversation { /** Get entity value. - Get information about an entity value. This operation is limited to 6000 requests per 5 minutes. For more - information, see **Rate limiting**. + Get information about an entity value. + This operation is limited to 6000 requests per 5 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. - parameter value: The text of the entity value. - - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only - information about the element itself. If **export**=`true`, all content, including subelements, is included. + - parameter export: Whether to include all element content in the returned data. If **export**=`false`, the returned data includes + only information about the element itself. If **export**=`true`, all content, including subelements, is included. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. @@ -2102,16 +2110,17 @@ public class Conversation { Update entity value. Update an existing entity value with new or modified data. You must provide component objects defining the content - of the updated entity value. This operation is limited to 1000 requests per 30 minutes. For more information, - see **Rate limiting**. + of the updated entity value. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. - parameter value: The text of the entity value. - - parameter properties: The updated content of the entity value. Any elements included in the new data will completely replace the - equivalent existing elements, including all subelements. (Previously existing subelements are not retained unless - they are also included in the new data.) For example, if you update the synonyms for an entity value, the - previously existing synonyms are discarded and replaced with the new synonyms specified in the update. + - parameter properties: The updated content of the entity value. + Any elements included in the new data will completely replace the equivalent existing elements, including all + subelements. (Previously existing subelements are not retained unless they are also included in the new data.) + For example, if you update the synonyms for an entity value, the previously existing synonyms are discarded and + replaced with the new synonyms specified in the update. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2171,8 +2180,8 @@ public class Conversation { /** Delete entity value. - Delete a value from an entity. This operation is limited to 1000 requests per 30 minutes. For more information, - see **Rate limiting**. + Delete a value from an entity. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. @@ -2227,8 +2236,8 @@ public class Conversation { /** List entity value synonyms. - List the synonyms for an entity value. This operation is limited to 2500 requests per 30 minutes. For more - information, see **Rate limiting**. + List the synonyms for an entity value. + This operation is limited to 2500 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. @@ -2236,7 +2245,7 @@ public class Conversation { - parameter pageLimit: The number of records to return in each page of results. - parameter includeCount: Whether to include information about the number of records returned. - parameter sort: The attribute by which returned results will be sorted. To reverse the sort order, prefix the value with a minus - sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. + sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. - parameter cursor: A token identifying the page of results to retrieve. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. @@ -2314,15 +2323,16 @@ public class Conversation { /** Add entity value synonym. - Add a new synonym to an entity value. This operation is limited to 1000 requests per 30 minutes. For more - information, see **Rate limiting**. + Add a new synonym to an entity value. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. - parameter value: The text of the entity value. - - parameter synonym: The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage - return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer - than 64 characters. + - parameter synonym: The text of the synonym. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2383,8 +2393,8 @@ public class Conversation { /** Get entity value synonym. - Get information about a synonym of an entity value. This operation is limited to 6000 requests per 5 minutes. - For more information, see **Rate limiting**. + Get information about a synonym of an entity value. + This operation is limited to 6000 requests per 5 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. @@ -2447,16 +2457,17 @@ public class Conversation { /** Update entity value synonym. - Update an existing entity value synonym with new text. This operation is limited to 1000 requests per 30 - minutes. For more information, see **Rate limiting**. + Update an existing entity value synonym with new text. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. - parameter value: The text of the entity value. - parameter synonym: The text of the synonym. - - parameter newSynonym: The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage - return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer - than 64 characters. + - parameter newSynonym: The text of the synonym. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2518,8 +2529,8 @@ public class Conversation { /** Delete entity value synonym. - Delete a synonym from an entity value. This operation is limited to 1000 requests per 30 minutes. For more - information, see **Rate limiting**. + Delete a synonym from an entity value. + This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter entity: The name of the entity. @@ -2576,14 +2587,14 @@ public class Conversation { /** List dialog nodes. - List the dialog nodes for a workspace. This operation is limited to 2500 requests per 30 minutes. For more - information, see **Rate limiting**. + List the dialog nodes for a workspace. + This operation is limited to 2500 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter pageLimit: The number of records to return in each page of results. - parameter includeCount: Whether to include information about the number of records returned. - parameter sort: The attribute by which returned results will be sorted. To reverse the sort order, prefix the value with a minus - sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. + sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. - parameter cursor: A token identifying the page of results to retrieve. - parameter includeAudit: Whether to include the audit properties (`created` and `updated` timestamps) in the response. - parameter headers: A dictionary of request headers to be sent with this request. @@ -2659,8 +2670,8 @@ public class Conversation { /** Create dialog node. - Create a new dialog node. This operation is limited to 500 requests per 30 minutes. For more information, see - **Rate limiting**. + Create a new dialog node. + This operation is limited to 500 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter properties: A CreateDialogNode object defining the content of the new dialog node. @@ -2721,8 +2732,8 @@ public class Conversation { /** Get dialog node. - Get information about a dialog node. This operation is limited to 6000 requests per 5 minutes. For more - information, see **Rate limiting**. + Get information about a dialog node. + This operation is limited to 6000 requests per 5 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter dialogNode: The dialog node ID (for example, `get_order`). @@ -2781,15 +2792,16 @@ public class Conversation { /** Update dialog node. - Update an existing dialog node with new or modified data. This operation is limited to 500 requests per 30 - minutes. For more information, see **Rate limiting**. + Update an existing dialog node with new or modified data. + This operation is limited to 500 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter dialogNode: The dialog node ID (for example, `get_order`). - - parameter properties: The updated content of the dialog node. Any elements included in the new data will completely replace the - equivalent existing elements, including all subelements. (Previously existing subelements are not retained unless - they are also included in the new data.) For example, if you update the actions for a dialog node, the previously - existing actions are discarded and replaced with the new actions specified in the update. + - parameter properties: The updated content of the dialog node. + Any elements included in the new data will completely replace the equivalent existing elements, including all + subelements. (Previously existing subelements are not retained unless they are also included in the new data.) + For example, if you update the actions for a dialog node, the previously existing actions are discarded and + replaced with the new actions specified in the update. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2848,8 +2860,8 @@ public class Conversation { /** Delete dialog node. - Delete a dialog node from a workspace. This operation is limited to 500 requests per 30 minutes. For more - information, see **Rate limiting**. + Delete a dialog node from a workspace. + This operation is limited to 500 requests per 30 minutes. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter dialogNode: The dialog node ID (for example, `get_order`). @@ -2902,15 +2914,16 @@ public class Conversation { /** List log events in a workspace. - List the events from the log of a specific workspace. If **cursor** is not specified, this operation is limited - to 40 requests per 30 minutes. If **cursor** is specified, the limit is 120 requests per minute. For more - information, see **Rate limiting**. + List the events from the log of a specific workspace. + If **cursor** is not specified, this operation is limited to 40 requests per 30 minutes. If **cursor** is + specified, the limit is 120 requests per minute. For more information, see **Rate limiting**. - parameter workspaceID: Unique identifier of the workspace. - parameter sort: The attribute by which returned results will be sorted. To reverse the sort order, prefix the value with a minus - sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. - - parameter filter: A cacheable parameter that limits the results to those matching the specified filter. For more information, see the - [documentation](https://console.bluemix.net/docs/services/conversation/filter-reference.html#filter-query-syntax). + sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. + - parameter filter: A cacheable parameter that limits the results to those matching the specified filter. For more information, see + the + [documentation](https://console.bluemix.net/docs/services/conversation/filter-reference.html#filter-query-syntax). - parameter pageLimit: The number of records to return in each page of results. - parameter cursor: A token identifying the page of results to retrieve. - parameter headers: A dictionary of request headers to be sent with this request. @@ -2981,16 +2994,16 @@ public class Conversation { /** List log events in all workspaces. - List the events from the logs of all workspaces in the service instance. If **cursor** is not specified, this - operation is limited to 40 requests per 30 minutes. If **cursor** is specified, the limit is 120 requests per - minute. For more information, see **Rate limiting**. + List the events from the logs of all workspaces in the service instance. + If **cursor** is not specified, this operation is limited to 40 requests per 30 minutes. If **cursor** is + specified, the limit is 120 requests per minute. For more information, see **Rate limiting**. - parameter filter: A cacheable parameter that limits the results to those matching the specified filter. You must specify a filter - query that includes a value for `language`, as well as a value for `workspace_id` or - `request.context.metadata.deployment`. For more information, see the - [documentation](https://console.bluemix.net/docs/services/conversation/filter-reference.html#filter-query-syntax). + query that includes a value for `language`, as well as a value for `workspace_id` or + `request.context.metadata.deployment`. For more information, see the + [documentation](https://console.bluemix.net/docs/services/conversation/filter-reference.html#filter-query-syntax). - parameter sort: The attribute by which returned results will be sorted. To reverse the sort order, prefix the value with a minus - sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. + sign (`-`). Supported values are `name`, `updated`, and `workspace_id`. - parameter pageLimit: The number of records to return in each page of results. - parameter cursor: A token identifying the page of results to retrieve. - parameter headers: A dictionary of request headers to be sent with this request. @@ -3053,8 +3066,9 @@ public class Conversation { Delete labeled data. Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with - the customer ID. You associate a customer ID with data by passing the `X-Watson-Metadata` header with a request - that passes data. For more information about personal data and customer IDs, see [Information + the customer ID. + You associate a customer ID with data by passing the `X-Watson-Metadata` header with a request that passes data. + For more information about personal data and customer IDs, see [Information security](https://console.bluemix.net/docs/services/conversation/information-security.html). - parameter customerID: The customer ID for which all data is to be deleted. diff --git a/Source/ConversationV1/Models/CaptureGroup.swift b/Source/ConversationV1/Models/CaptureGroup.swift index 0cf551276..e35e3d7df 100644 --- a/Source/ConversationV1/Models/CaptureGroup.swift +++ b/Source/ConversationV1/Models/CaptureGroup.swift @@ -19,10 +19,14 @@ import Foundation /** CaptureGroup. */ public struct CaptureGroup: Codable { - /// A recognized capture group for the entity. + /** + A recognized capture group for the entity. + */ public var group: String - /// Zero-based character offsets that indicate where the entity value begins and ends in the input text. + /** + Zero-based character offsets that indicate where the entity value begins and ends in the input text. + */ public var location: [Int]? // Map each property name to the key that shall be used for encoding/decoding. @@ -39,7 +43,11 @@ public struct CaptureGroup: Codable { - returns: An initialized `CaptureGroup`. */ - public init(group: String, location: [Int]? = nil) { + public init( + group: String, + location: [Int]? = nil + ) + { self.group = group self.location = location } diff --git a/Source/ConversationV1/Models/Context.swift b/Source/ConversationV1/Models/Context.swift index 1b25725d6..1961f6ec1 100644 --- a/Source/ConversationV1/Models/Context.swift +++ b/Source/ConversationV1/Models/Context.swift @@ -19,10 +19,14 @@ import Foundation /** State information for the conversation. To maintain state, include the context from the previous response. */ public struct Context: Codable { - /// The unique identifier of the conversation. + /** + The unique identifier of the conversation. + */ public var conversationID: String? - /// For internal use only. + /** + For internal use only. + */ public var system: SystemResponse? /// Additional properties associated with this model. @@ -43,7 +47,12 @@ public struct Context: Codable { - returns: An initialized `Context`. */ - public init(conversationID: String? = nil, system: SystemResponse? = nil, additionalProperties: [String: JSON] = [:]) { + public init( + conversationID: String? = nil, + system: SystemResponse? = nil, + additionalProperties: [String: JSON] = [:] + ) + { self.conversationID = conversationID self.system = system self.additionalProperties = additionalProperties diff --git a/Source/ConversationV1/Models/Counterexample.swift b/Source/ConversationV1/Models/Counterexample.swift index 0a61c9687..a61f0c408 100644 --- a/Source/ConversationV1/Models/Counterexample.swift +++ b/Source/ConversationV1/Models/Counterexample.swift @@ -19,13 +19,19 @@ import Foundation /** Counterexample. */ public struct Counterexample: Decodable { - /// The text of the counterexample. + /** + The text of the counterexample. + */ public var text: String - /// The timestamp for creation of the counterexample. + /** + The timestamp for creation of the counterexample. + */ public var created: String? - /// The timestamp for the last update to the counterexample. + /** + The timestamp for the last update to the counterexample. + */ public var updated: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/CounterexampleCollection.swift b/Source/ConversationV1/Models/CounterexampleCollection.swift index 52d8a8666..87269f749 100644 --- a/Source/ConversationV1/Models/CounterexampleCollection.swift +++ b/Source/ConversationV1/Models/CounterexampleCollection.swift @@ -19,10 +19,14 @@ import Foundation /** CounterexampleCollection. */ public struct CounterexampleCollection: Decodable { - /// An array of objects describing the examples marked as irrelevant input. + /** + An array of objects describing the examples marked as irrelevant input. + */ public var counterexamples: [Counterexample] - /// The pagination data for the returned objects. + /** + The pagination data for the returned objects. + */ public var pagination: Pagination // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/CreateCounterexample.swift b/Source/ConversationV1/Models/CreateCounterexample.swift index 2f14c148a..ac6cea9c7 100644 --- a/Source/ConversationV1/Models/CreateCounterexample.swift +++ b/Source/ConversationV1/Models/CreateCounterexample.swift @@ -19,7 +19,12 @@ import Foundation /** CreateCounterexample. */ public struct CreateCounterexample: Encodable { - /// The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It must be no longer than 1024 characters. + /** + The text of a user input marked as irrelevant input. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters + - It cannot consist of only whitespace characters + - It must be no longer than 1024 characters. + */ public var text: String // Map each property name to the key that shall be used for encoding/decoding. @@ -30,11 +35,17 @@ public struct CreateCounterexample: Encodable { /** Initialize a `CreateCounterexample` with member variables. - - parameter text: The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It must be no longer than 1024 characters. + - parameter text: The text of a user input marked as irrelevant input. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters + - It cannot consist of only whitespace characters + - It must be no longer than 1024 characters. - returns: An initialized `CreateCounterexample`. */ - public init(text: String) { + public init( + text: String + ) + { self.text = text } diff --git a/Source/ConversationV1/Models/CreateDialogNode.swift b/Source/ConversationV1/Models/CreateDialogNode.swift index add80f23d..1aebab09d 100644 --- a/Source/ConversationV1/Models/CreateDialogNode.swift +++ b/Source/ConversationV1/Models/CreateDialogNode.swift @@ -19,7 +19,9 @@ import Foundation /** CreateDialogNode. */ public struct CreateDialogNode: Encodable { - /// How the dialog node is processed. + /** + How the dialog node is processed. + */ public enum NodeType: String { case standard = "standard" case eventHandler = "event_handler" @@ -29,7 +31,9 @@ public struct CreateDialogNode: Encodable { case folder = "folder" } - /// How an `event_handler` node is processed. + /** + How an `event_handler` node is processed. + */ public enum EventName: String { case focus = "focus" case input = "input" @@ -42,76 +46,123 @@ public struct CreateDialogNode: Encodable { case digressionReturnPrompt = "digression_return_prompt" } - /// Whether this top-level dialog node can be digressed into. + /** + Whether this top-level dialog node can be digressed into. + */ public enum DigressIn: String { case notAvailable = "not_available" case returns = "returns" case doesNotReturn = "does_not_return" } - /// Whether this dialog node can be returned to after a digression. + /** + Whether this dialog node can be returned to after a digression. + */ public enum DigressOut: String { case returning = "allow_returning" case all = "allow_all" case allNeverReturn = "allow_all_never_return" } - /// Whether the user can digress to top-level nodes while filling out slots. + /** + Whether the user can digress to top-level nodes while filling out slots. + */ public enum DigressOutSlots: String { case notAllowed = "not_allowed" case allowReturning = "allow_returning" case allowAll = "allow_all" } - /// The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters. + /** + The dialog node ID. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. + - It must be no longer than 1024 characters. + */ public var dialogNode: String - /// The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + /** + The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it + must be no longer than 128 characters. + */ public var description: String? - /// The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters. + /** + The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab + characters, and it must be no longer than 2048 characters. + */ public var conditions: String? - /// The ID of the parent dialog node. + /** + The ID of the parent dialog node. + */ public var parent: String? - /// The ID of the previous dialog node. + /** + The ID of the previous dialog node. + */ public var previousSibling: String? - /// The output of the dialog node. For more information about how to specify dialog node output, see the [documentation](https://console.bluemix.net/docs/services/conversation/dialog-overview.html#complex). + /** + The output of the dialog node. For more information about how to specify dialog node output, see the + [documentation](https://console.bluemix.net/docs/services/conversation/dialog-overview.html#complex). + */ public var output: [String: JSON]? - /// The context for the dialog node. + /** + The context for the dialog node. + */ public var context: [String: JSON]? - /// The metadata for the dialog node. + /** + The metadata for the dialog node. + */ public var metadata: [String: JSON]? - /// The next step to be executed in dialog processing. + /** + The next step to be executed in dialog processing. + */ public var nextStep: DialogNodeNextStep? - /// An array of objects describing any actions to be invoked by the dialog node. + /** + An array of objects describing any actions to be invoked by the dialog node. + */ public var actions: [DialogNodeAction]? - /// The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters. + /** + The alias used to identify the dialog node. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. + - It must be no longer than 64 characters. + */ public var title: String? - /// How the dialog node is processed. + /** + How the dialog node is processed. + */ public var nodeType: String? - /// How an `event_handler` node is processed. + /** + How an `event_handler` node is processed. + */ public var eventName: String? - /// The location in the dialog context where output is stored. + /** + The location in the dialog context where output is stored. + */ public var variable: String? - /// Whether this top-level dialog node can be digressed into. + /** + Whether this top-level dialog node can be digressed into. + */ public var digressIn: String? - /// Whether this dialog node can be returned to after a digression. + /** + Whether this dialog node can be returned to after a digression. + */ public var digressOut: String? - /// Whether the user can digress to top-level nodes while filling out slots. + /** + Whether the user can digress to top-level nodes while filling out slots. + */ public var digressOutSlots: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -138,17 +189,24 @@ public struct CreateDialogNode: Encodable { /** Initialize a `CreateDialogNode` with member variables. - - parameter dialogNode: The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters. - - parameter description: The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. - - parameter conditions: The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters. + - parameter dialogNode: The dialog node ID. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. + - It must be no longer than 1024 characters. + - parameter description: The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and + it must be no longer than 128 characters. + - parameter conditions: The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab + characters, and it must be no longer than 2048 characters. - parameter parent: The ID of the parent dialog node. - parameter previousSibling: The ID of the previous dialog node. - - parameter output: The output of the dialog node. For more information about how to specify dialog node output, see the [documentation](https://console.bluemix.net/docs/services/conversation/dialog-overview.html#complex). + - parameter output: The output of the dialog node. For more information about how to specify dialog node output, see the + [documentation](https://console.bluemix.net/docs/services/conversation/dialog-overview.html#complex). - parameter context: The context for the dialog node. - parameter metadata: The metadata for the dialog node. - parameter nextStep: The next step to be executed in dialog processing. - parameter actions: An array of objects describing any actions to be invoked by the dialog node. - - parameter title: The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters. + - parameter title: The alias used to identify the dialog node. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. + - It must be no longer than 64 characters. - parameter nodeType: How the dialog node is processed. - parameter eventName: How an `event_handler` node is processed. - parameter variable: The location in the dialog context where output is stored. @@ -158,7 +216,26 @@ public struct CreateDialogNode: Encodable { - returns: An initialized `CreateDialogNode`. */ - public init(dialogNode: String, description: String? = nil, conditions: String? = nil, parent: String? = nil, previousSibling: String? = nil, output: [String: JSON]? = nil, context: [String: JSON]? = nil, metadata: [String: JSON]? = nil, nextStep: DialogNodeNextStep? = nil, actions: [DialogNodeAction]? = nil, title: String? = nil, nodeType: String? = nil, eventName: String? = nil, variable: String? = nil, digressIn: String? = nil, digressOut: String? = nil, digressOutSlots: String? = nil) { + public init( + dialogNode: String, + description: String? = nil, + conditions: String? = nil, + parent: String? = nil, + previousSibling: String? = nil, + output: [String: JSON]? = nil, + context: [String: JSON]? = nil, + metadata: [String: JSON]? = nil, + nextStep: DialogNodeNextStep? = nil, + actions: [DialogNodeAction]? = nil, + title: String? = nil, + nodeType: String? = nil, + eventName: String? = nil, + variable: String? = nil, + digressIn: String? = nil, + digressOut: String? = nil, + digressOutSlots: String? = nil + ) + { self.dialogNode = dialogNode self.description = description self.conditions = conditions diff --git a/Source/ConversationV1/Models/CreateEntity.swift b/Source/ConversationV1/Models/CreateEntity.swift index a98f8087b..9e294bbeb 100644 --- a/Source/ConversationV1/Models/CreateEntity.swift +++ b/Source/ConversationV1/Models/CreateEntity.swift @@ -19,19 +19,33 @@ import Foundation /** CreateEntity. */ public struct CreateEntity: Encodable { - /// The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix `sys-`. - It must be no longer than 64 characters. + /** + The name of the entity. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, underscore, and hyphen characters. + - It cannot begin with the reserved prefix `sys-`. + - It must be no longer than 64 characters. + */ public var entity: String - /// The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + /** + The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must + be no longer than 128 characters. + */ public var description: String? - /// Any metadata related to the value. + /** + Any metadata related to the value. + */ public var metadata: [String: JSON]? - /// An array of objects describing the entity values. + /** + An array of objects describing the entity values. + */ public var values: [CreateValue]? - /// Whether to use fuzzy matching for the entity. + /** + Whether to use fuzzy matching for the entity. + */ public var fuzzyMatch: Bool? // Map each property name to the key that shall be used for encoding/decoding. @@ -46,15 +60,26 @@ public struct CreateEntity: Encodable { /** Initialize a `CreateEntity` with member variables. - - parameter entity: The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix `sys-`. - It must be no longer than 64 characters. - - parameter description: The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + - parameter entity: The name of the entity. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, underscore, and hyphen characters. + - It cannot begin with the reserved prefix `sys-`. + - It must be no longer than 64 characters. + - parameter description: The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it + must be no longer than 128 characters. - parameter metadata: Any metadata related to the value. - parameter values: An array of objects describing the entity values. - parameter fuzzyMatch: Whether to use fuzzy matching for the entity. - returns: An initialized `CreateEntity`. */ - public init(entity: String, description: String? = nil, metadata: [String: JSON]? = nil, values: [CreateValue]? = nil, fuzzyMatch: Bool? = nil) { + public init( + entity: String, + description: String? = nil, + metadata: [String: JSON]? = nil, + values: [CreateValue]? = nil, + fuzzyMatch: Bool? = nil + ) + { self.entity = entity self.description = description self.metadata = metadata diff --git a/Source/ConversationV1/Models/CreateExample.swift b/Source/ConversationV1/Models/CreateExample.swift index c367c47e3..68627199c 100644 --- a/Source/ConversationV1/Models/CreateExample.swift +++ b/Source/ConversationV1/Models/CreateExample.swift @@ -19,7 +19,12 @@ import Foundation /** CreateExample. */ public struct CreateExample: Encodable { - /// The text of a user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters. + /** + The text of a user input example. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 1024 characters. + */ public var text: String // Map each property name to the key that shall be used for encoding/decoding. @@ -30,11 +35,17 @@ public struct CreateExample: Encodable { /** Initialize a `CreateExample` with member variables. - - parameter text: The text of a user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters. + - parameter text: The text of a user input example. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 1024 characters. - returns: An initialized `CreateExample`. */ - public init(text: String) { + public init( + text: String + ) + { self.text = text } diff --git a/Source/ConversationV1/Models/CreateIntent.swift b/Source/ConversationV1/Models/CreateIntent.swift index 36e37d9f9..48cf9af85 100644 --- a/Source/ConversationV1/Models/CreateIntent.swift +++ b/Source/ConversationV1/Models/CreateIntent.swift @@ -19,13 +19,23 @@ import Foundation /** CreateIntent. */ public struct CreateIntent: Encodable { - /// The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix `sys-`. - It must be no longer than 128 characters. + /** + The name of the intent. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. + - It cannot begin with the reserved prefix `sys-`. + - It must be no longer than 128 characters. + */ public var intent: String - /// The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + /** + The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must + be no longer than 128 characters. + */ public var description: String? - /// An array of user input examples for the intent. + /** + An array of user input examples for the intent. + */ public var examples: [CreateExample]? // Map each property name to the key that shall be used for encoding/decoding. @@ -38,13 +48,22 @@ public struct CreateIntent: Encodable { /** Initialize a `CreateIntent` with member variables. - - parameter intent: The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix `sys-`. - It must be no longer than 128 characters. - - parameter description: The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + - parameter intent: The name of the intent. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. + - It cannot begin with the reserved prefix `sys-`. + - It must be no longer than 128 characters. + - parameter description: The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it + must be no longer than 128 characters. - parameter examples: An array of user input examples for the intent. - returns: An initialized `CreateIntent`. */ - public init(intent: String, description: String? = nil, examples: [CreateExample]? = nil) { + public init( + intent: String, + description: String? = nil, + examples: [CreateExample]? = nil + ) + { self.intent = intent self.description = description self.examples = examples diff --git a/Source/ConversationV1/Models/CreateSynonym.swift b/Source/ConversationV1/Models/CreateSynonym.swift index dbfcdd4c0..8c6f7cb5e 100644 --- a/Source/ConversationV1/Models/CreateSynonym.swift +++ b/Source/ConversationV1/Models/CreateSynonym.swift @@ -19,7 +19,12 @@ import Foundation /** CreateSynonym. */ public struct CreateSynonym: Encodable { - /// The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. + /** + The text of the synonym. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. + */ public var synonym: String // Map each property name to the key that shall be used for encoding/decoding. @@ -30,11 +35,17 @@ public struct CreateSynonym: Encodable { /** Initialize a `CreateSynonym` with member variables. - - parameter synonym: The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. + - parameter synonym: The text of the synonym. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. - returns: An initialized `CreateSynonym`. */ - public init(synonym: String) { + public init( + synonym: String + ) + { self.synonym = synonym } diff --git a/Source/ConversationV1/Models/CreateValue.swift b/Source/ConversationV1/Models/CreateValue.swift index f3abc1286..5c9f73f7b 100644 --- a/Source/ConversationV1/Models/CreateValue.swift +++ b/Source/ConversationV1/Models/CreateValue.swift @@ -19,25 +19,47 @@ import Foundation /** CreateValue. */ public struct CreateValue: Encodable { - /// Specifies the type of value. + /** + Specifies the type of value. + */ public enum ValueType: String { case synonyms = "synonyms" case patterns = "patterns" } - /// The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. + /** + The text of the entity value. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. + */ public var value: String - /// Any metadata related to the entity value. + /** + Any metadata related to the entity value. + */ public var metadata: [String: JSON]? - /// An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by **type**), but not both. A synonym must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. + /** + An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by + **type**), but not both. A synonym must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. + */ public var synonyms: [String]? - /// An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by **type**), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities). + /** + An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by **type**), + but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to + specify a pattern, see the + [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities). + */ public var patterns: [String]? - /// Specifies the type of value. + /** + Specifies the type of value. + */ public var valueType: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -52,15 +74,32 @@ public struct CreateValue: Encodable { /** Initialize a `CreateValue` with member variables. - - parameter value: The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. + - parameter value: The text of the entity value. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. - parameter metadata: Any metadata related to the entity value. - - parameter synonyms: An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by **type**), but not both. A synonym must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. - - parameter patterns: An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by **type**), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities). + - parameter synonyms: An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated + by **type**), but not both. A synonym must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. + - parameter patterns: An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by + **type**), but not both. A pattern is a regular expression no longer than 128 characters. For more information + about how to specify a pattern, see the + [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities). - parameter valueType: Specifies the type of value. - returns: An initialized `CreateValue`. */ - public init(value: String, metadata: [String: JSON]? = nil, synonyms: [String]? = nil, patterns: [String]? = nil, valueType: String? = nil) { + public init( + value: String, + metadata: [String: JSON]? = nil, + synonyms: [String]? = nil, + patterns: [String]? = nil, + valueType: String? = nil + ) + { self.value = value self.metadata = metadata self.synonyms = synonyms diff --git a/Source/ConversationV1/Models/CreateWorkspace.swift b/Source/ConversationV1/Models/CreateWorkspace.swift index 4753009e7..7251e1669 100644 --- a/Source/ConversationV1/Models/CreateWorkspace.swift +++ b/Source/ConversationV1/Models/CreateWorkspace.swift @@ -19,31 +19,52 @@ import Foundation /** CreateWorkspace. */ public struct CreateWorkspace: Encodable { - /// The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters. + /** + The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be + no longer than 64 characters. + */ public var name: String? - /// The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + /** + The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it + must be no longer than 128 characters. + */ public var description: String? - /// The language of the workspace. + /** + The language of the workspace. + */ public var language: String? - /// An array of objects defining the intents for the workspace. + /** + An array of objects defining the intents for the workspace. + */ public var intents: [CreateIntent]? - /// An array of objects defining the entities for the workspace. + /** + An array of objects defining the entities for the workspace. + */ public var entities: [CreateEntity]? - /// An array of objects defining the nodes in the workspace dialog. + /** + An array of objects defining the nodes in the workspace dialog. + */ public var dialogNodes: [CreateDialogNode]? - /// An array of objects defining input examples that have been marked as irrelevant input. + /** + An array of objects defining input examples that have been marked as irrelevant input. + */ public var counterexamples: [CreateCounterexample]? - /// Any metadata related to the workspace. + /** + Any metadata related to the workspace. + */ public var metadata: [String: JSON]? - /// Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates that workspace training data is not to be used. + /** + Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates that + workspace training data is not to be used. + */ public var learningOptOut: Bool? // Map each property name to the key that shall be used for encoding/decoding. @@ -62,19 +83,33 @@ public struct CreateWorkspace: Encodable { /** Initialize a `CreateWorkspace` with member variables. - - parameter name: The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters. - - parameter description: The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + - parameter name: The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be + no longer than 64 characters. + - parameter description: The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it + must be no longer than 128 characters. - parameter language: The language of the workspace. - parameter intents: An array of objects defining the intents for the workspace. - parameter entities: An array of objects defining the entities for the workspace. - parameter dialogNodes: An array of objects defining the nodes in the workspace dialog. - parameter counterexamples: An array of objects defining input examples that have been marked as irrelevant input. - parameter metadata: Any metadata related to the workspace. - - parameter learningOptOut: Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates that workspace training data is not to be used. + - parameter learningOptOut: Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates + that workspace training data is not to be used. - returns: An initialized `CreateWorkspace`. */ - public init(name: String? = nil, description: String? = nil, language: String? = nil, intents: [CreateIntent]? = nil, entities: [CreateEntity]? = nil, dialogNodes: [CreateDialogNode]? = nil, counterexamples: [CreateCounterexample]? = nil, metadata: [String: JSON]? = nil, learningOptOut: Bool? = nil) { + public init( + name: String? = nil, + description: String? = nil, + language: String? = nil, + intents: [CreateIntent]? = nil, + entities: [CreateEntity]? = nil, + dialogNodes: [CreateDialogNode]? = nil, + counterexamples: [CreateCounterexample]? = nil, + metadata: [String: JSON]? = nil, + learningOptOut: Bool? = nil + ) + { self.name = name self.description = description self.language = language diff --git a/Source/ConversationV1/Models/DialogNode.swift b/Source/ConversationV1/Models/DialogNode.swift index e9b0924e8..8076e5c50 100644 --- a/Source/ConversationV1/Models/DialogNode.swift +++ b/Source/ConversationV1/Models/DialogNode.swift @@ -19,7 +19,9 @@ import Foundation /** DialogNode. */ public struct DialogNode: Decodable { - /// How the dialog node is processed. + /** + How the dialog node is processed. + */ public enum NodeType: String { case standard = "standard" case eventHandler = "event_handler" @@ -29,7 +31,9 @@ public struct DialogNode: Decodable { case folder = "folder" } - /// How an `event_handler` node is processed. + /** + How an `event_handler` node is processed. + */ public enum EventName: String { case focus = "focus" case input = "input" @@ -42,82 +46,127 @@ public struct DialogNode: Decodable { case digressionReturnPrompt = "digression_return_prompt" } - /// Whether this top-level dialog node can be digressed into. + /** + Whether this top-level dialog node can be digressed into. + */ public enum DigressIn: String { case notAvailable = "not_available" case returns = "returns" case doesNotReturn = "does_not_return" } - /// Whether this dialog node can be returned to after a digression. + /** + Whether this dialog node can be returned to after a digression. + */ public enum DigressOut: String { case returning = "allow_returning" case all = "allow_all" case allNeverReturn = "allow_all_never_return" } - /// Whether the user can digress to top-level nodes while filling out slots. + /** + Whether the user can digress to top-level nodes while filling out slots. + */ public enum DigressOutSlots: String { case notAllowed = "not_allowed" case allowReturning = "allow_returning" case allowAll = "allow_all" } - /// The dialog node ID. + /** + The dialog node ID. + */ public var dialogNodeID: String - /// The description of the dialog node. + /** + The description of the dialog node. + */ public var description: String? - /// The condition that triggers the dialog node. + /** + The condition that triggers the dialog node. + */ public var conditions: String? - /// The ID of the parent dialog node. This property is not returned if the dialog node has no parent. + /** + The ID of the parent dialog node. This property is not returned if the dialog node has no parent. + */ public var parent: String? - /// The ID of the previous sibling dialog node. This property is not returned if the dialog node has no previous sibling. + /** + The ID of the previous sibling dialog node. This property is not returned if the dialog node has no previous + sibling. + */ public var previousSibling: String? - /// The output of the dialog node. + /** + The output of the dialog node. + */ public var output: [String: JSON]? - /// The context (if defined) for the dialog node. + /** + The context (if defined) for the dialog node. + */ public var context: [String: JSON]? - /// Any metadata for the dialog node. + /** + Any metadata for the dialog node. + */ public var metadata: [String: JSON]? - /// The next step to execute following this dialog node. + /** + The next step to execute following this dialog node. + */ public var nextStep: DialogNodeNextStep? - /// The timestamp for creation of the dialog node. + /** + The timestamp for creation of the dialog node. + */ public var created: String? - /// The timestamp for the most recent update to the dialog node. + /** + The timestamp for the most recent update to the dialog node. + */ public var updated: String? - /// The actions for the dialog node. + /** + The actions for the dialog node. + */ public var actions: [DialogNodeAction]? - /// The alias used to identify the dialog node. + /** + The alias used to identify the dialog node. + */ public var title: String? - /// How the dialog node is processed. + /** + How the dialog node is processed. + */ public var nodeType: String? - /// How an `event_handler` node is processed. + /** + How an `event_handler` node is processed. + */ public var eventName: String? - /// The location in the dialog context where output is stored. + /** + The location in the dialog context where output is stored. + */ public var variable: String? - /// Whether this top-level dialog node can be digressed into. + /** + Whether this top-level dialog node can be digressed into. + */ public var digressIn: String? - /// Whether this dialog node can be returned to after a digression. + /** + Whether this dialog node can be returned to after a digression. + */ public var digressOut: String? - /// Whether the user can digress to top-level nodes while filling out slots. + /** + Whether the user can digress to top-level nodes while filling out slots. + */ public var digressOutSlots: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/DialogNodeAction.swift b/Source/ConversationV1/Models/DialogNodeAction.swift index 7a84095ed..3713c941d 100644 --- a/Source/ConversationV1/Models/DialogNodeAction.swift +++ b/Source/ConversationV1/Models/DialogNodeAction.swift @@ -19,25 +19,37 @@ import Foundation /** DialogNodeAction. */ public struct DialogNodeAction: Codable { - /// The type of action to invoke. + /** + The type of action to invoke. + */ public enum ActionType: String { case client = "client" case server = "server" } - /// The name of the action. + /** + The name of the action. + */ public var name: String - /// The type of action to invoke. + /** + The type of action to invoke. + */ public var actionType: String? - /// A map of key/value pairs to be provided to the action. + /** + A map of key/value pairs to be provided to the action. + */ public var parameters: [String: JSON]? - /// The location in the dialog context where the result of the action is stored. + /** + The location in the dialog context where the result of the action is stored. + */ public var resultVariable: String - /// The name of the context variable that the client application will use to pass in credentials for the action. + /** + The name of the context variable that the client application will use to pass in credentials for the action. + */ public var credentials: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -60,7 +72,14 @@ public struct DialogNodeAction: Codable { - returns: An initialized `DialogNodeAction`. */ - public init(name: String, resultVariable: String, actionType: String? = nil, parameters: [String: JSON]? = nil, credentials: String? = nil) { + public init( + name: String, + resultVariable: String, + actionType: String? = nil, + parameters: [String: JSON]? = nil, + credentials: String? = nil + ) + { self.name = name self.resultVariable = resultVariable self.actionType = actionType diff --git a/Source/ConversationV1/Models/DialogNodeCollection.swift b/Source/ConversationV1/Models/DialogNodeCollection.swift index 742ae3f4e..546884dc8 100644 --- a/Source/ConversationV1/Models/DialogNodeCollection.swift +++ b/Source/ConversationV1/Models/DialogNodeCollection.swift @@ -19,10 +19,14 @@ import Foundation /** An array of dialog nodes. */ public struct DialogNodeCollection: Decodable { - /// An array of objects describing the dialog nodes defined for the workspace. + /** + An array of objects describing the dialog nodes defined for the workspace. + */ public var dialogNodes: [DialogNode] - /// The pagination data for the returned objects. + /** + The pagination data for the returned objects. + */ public var pagination: Pagination // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/DialogNodeNextStep.swift b/Source/ConversationV1/Models/DialogNodeNextStep.swift index 7beeaddd6..237c8372e 100644 --- a/Source/ConversationV1/Models/DialogNodeNextStep.swift +++ b/Source/ConversationV1/Models/DialogNodeNextStep.swift @@ -19,7 +19,27 @@ import Foundation /** The next step to execute following this dialog node. */ public struct DialogNodeNextStep: Codable { - /// What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - `get_user_input` - `skip_user_input` - `jump_to` - If the node is of type `event_handler` and its parent node is of type `slot` or `frame`, additional values are also valid: - if **event_name**=`filled` and the type of the parent node is `slot`: - `reprompt` - `skip_all_slots` - if **event_name**=`nomatch` and the type of the parent node is `slot`: - `reprompt` - `skip_slot` - `skip_all_slots` - if **event_name**=`generic` and the type of the parent node is `frame`: - `reprompt` - `skip_slot` - `skip_all_slots` If you specify `jump_to`, then you must also specify a value for the `dialog_node` property. + /** + What happens after the dialog node completes. The valid values depend on the node type: + - The following values are valid for any node: + - `get_user_input` + - `skip_user_input` + - `jump_to` + - If the node is of type `event_handler` and its parent node is of type `slot` or `frame`, additional values are + also valid: + - if **event_name**=`filled` and the type of the parent node is `slot`: + - `reprompt` + - `skip_all_slots` + - if **event_name**=`nomatch` and the type of the parent node is `slot`: + - `reprompt` + - `skip_slot` + - `skip_all_slots` + - if **event_name**=`generic` and the type of the parent node is `frame`: + - `reprompt` + - `skip_slot` + - `skip_all_slots` + If you specify `jump_to`, then you must also specify a value for the `dialog_node` property. + */ public enum Behavior: String { case getUserInput = "get_user_input" case skipUserInput = "skip_user_input" @@ -29,7 +49,9 @@ public struct DialogNodeNextStep: Codable { case skipAllSlots = "skip_all_slots" } - /// Which part of the dialog node to process next. + /** + Which part of the dialog node to process next. + */ public enum Selector: String { case condition = "condition" case client = "client" @@ -37,13 +59,37 @@ public struct DialogNodeNextStep: Codable { case body = "body" } - /// What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - `get_user_input` - `skip_user_input` - `jump_to` - If the node is of type `event_handler` and its parent node is of type `slot` or `frame`, additional values are also valid: - if **event_name**=`filled` and the type of the parent node is `slot`: - `reprompt` - `skip_all_slots` - if **event_name**=`nomatch` and the type of the parent node is `slot`: - `reprompt` - `skip_slot` - `skip_all_slots` - if **event_name**=`generic` and the type of the parent node is `frame`: - `reprompt` - `skip_slot` - `skip_all_slots` If you specify `jump_to`, then you must also specify a value for the `dialog_node` property. + /** + What happens after the dialog node completes. The valid values depend on the node type: + - The following values are valid for any node: + - `get_user_input` + - `skip_user_input` + - `jump_to` + - If the node is of type `event_handler` and its parent node is of type `slot` or `frame`, additional values are + also valid: + - if **event_name**=`filled` and the type of the parent node is `slot`: + - `reprompt` + - `skip_all_slots` + - if **event_name**=`nomatch` and the type of the parent node is `slot`: + - `reprompt` + - `skip_slot` + - `skip_all_slots` + - if **event_name**=`generic` and the type of the parent node is `frame`: + - `reprompt` + - `skip_slot` + - `skip_all_slots` + If you specify `jump_to`, then you must also specify a value for the `dialog_node` property. + */ public var behavior: String - /// The ID of the dialog node to process next. This parameter is required if **behavior**=`jump_to`. + /** + The ID of the dialog node to process next. This parameter is required if **behavior**=`jump_to`. + */ public var dialogNode: String? - /// Which part of the dialog node to process next. + /** + Which part of the dialog node to process next. + */ public var selector: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -56,13 +102,36 @@ public struct DialogNodeNextStep: Codable { /** Initialize a `DialogNodeNextStep` with member variables. - - parameter behavior: What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - `get_user_input` - `skip_user_input` - `jump_to` - If the node is of type `event_handler` and its parent node is of type `slot` or `frame`, additional values are also valid: - if **event_name**=`filled` and the type of the parent node is `slot`: - `reprompt` - `skip_all_slots` - if **event_name**=`nomatch` and the type of the parent node is `slot`: - `reprompt` - `skip_slot` - `skip_all_slots` - if **event_name**=`generic` and the type of the parent node is `frame`: - `reprompt` - `skip_slot` - `skip_all_slots` If you specify `jump_to`, then you must also specify a value for the `dialog_node` property. + - parameter behavior: What happens after the dialog node completes. The valid values depend on the node type: + - The following values are valid for any node: + - `get_user_input` + - `skip_user_input` + - `jump_to` + - If the node is of type `event_handler` and its parent node is of type `slot` or `frame`, additional values are + also valid: + - if **event_name**=`filled` and the type of the parent node is `slot`: + - `reprompt` + - `skip_all_slots` + - if **event_name**=`nomatch` and the type of the parent node is `slot`: + - `reprompt` + - `skip_slot` + - `skip_all_slots` + - if **event_name**=`generic` and the type of the parent node is `frame`: + - `reprompt` + - `skip_slot` + - `skip_all_slots` + If you specify `jump_to`, then you must also specify a value for the `dialog_node` property. - parameter dialogNode: The ID of the dialog node to process next. This parameter is required if **behavior**=`jump_to`. - parameter selector: Which part of the dialog node to process next. - returns: An initialized `DialogNodeNextStep`. */ - public init(behavior: String, dialogNode: String? = nil, selector: String? = nil) { + public init( + behavior: String, + dialogNode: String? = nil, + selector: String? = nil + ) + { self.behavior = behavior self.dialogNode = dialogNode self.selector = selector diff --git a/Source/ConversationV1/Models/DialogNodeVisitedDetails.swift b/Source/ConversationV1/Models/DialogNodeVisitedDetails.swift index 89bca323d..d0a33d8ec 100644 --- a/Source/ConversationV1/Models/DialogNodeVisitedDetails.swift +++ b/Source/ConversationV1/Models/DialogNodeVisitedDetails.swift @@ -19,13 +19,19 @@ import Foundation /** DialogNodeVisitedDetails. */ public struct DialogNodeVisitedDetails: Codable { - /// A dialog node that was triggered during processing of the input message. + /** + A dialog node that was triggered during processing of the input message. + */ public var dialogNode: String? - /// The title of the dialog node. + /** + The title of the dialog node. + */ public var title: String? - /// The conditions that trigger the dialog node. + /** + The conditions that trigger the dialog node. + */ public var conditions: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -44,7 +50,12 @@ public struct DialogNodeVisitedDetails: Codable { - returns: An initialized `DialogNodeVisitedDetails`. */ - public init(dialogNode: String? = nil, title: String? = nil, conditions: String? = nil) { + public init( + dialogNode: String? = nil, + title: String? = nil, + conditions: String? = nil + ) + { self.dialogNode = dialogNode self.title = title self.conditions = conditions diff --git a/Source/ConversationV1/Models/Entity.swift b/Source/ConversationV1/Models/Entity.swift index b43cfd881..eea7733ab 100644 --- a/Source/ConversationV1/Models/Entity.swift +++ b/Source/ConversationV1/Models/Entity.swift @@ -19,22 +19,34 @@ import Foundation /** Entity. */ public struct Entity: Decodable { - /// The name of the entity. + /** + The name of the entity. + */ public var entityName: String - /// The timestamp for creation of the entity. + /** + The timestamp for creation of the entity. + */ public var created: String? - /// The timestamp for the last update to the entity. + /** + The timestamp for the last update to the entity. + */ public var updated: String? - /// The description of the entity. + /** + The description of the entity. + */ public var description: String? - /// Any metadata related to the entity. + /** + Any metadata related to the entity. + */ public var metadata: [String: JSON]? - /// Whether fuzzy matching is used for the entity. + /** + Whether fuzzy matching is used for the entity. + */ public var fuzzyMatch: Bool? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/EntityCollection.swift b/Source/ConversationV1/Models/EntityCollection.swift index 169088e16..95c058650 100644 --- a/Source/ConversationV1/Models/EntityCollection.swift +++ b/Source/ConversationV1/Models/EntityCollection.swift @@ -19,10 +19,14 @@ import Foundation /** An array of entities. */ public struct EntityCollection: Decodable { - /// An array of objects describing the entities defined for the workspace. + /** + An array of objects describing the entities defined for the workspace. + */ public var entities: [EntityExport] - /// The pagination data for the returned objects. + /** + The pagination data for the returned objects. + */ public var pagination: Pagination // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/EntityExport.swift b/Source/ConversationV1/Models/EntityExport.swift index 01c880577..ce0a41053 100644 --- a/Source/ConversationV1/Models/EntityExport.swift +++ b/Source/ConversationV1/Models/EntityExport.swift @@ -19,25 +19,39 @@ import Foundation /** EntityExport. */ public struct EntityExport: Decodable { - /// The name of the entity. + /** + The name of the entity. + */ public var entityName: String - /// The timestamp for creation of the entity. + /** + The timestamp for creation of the entity. + */ public var created: String? - /// The timestamp for the last update to the entity. + /** + The timestamp for the last update to the entity. + */ public var updated: String? - /// The description of the entity. + /** + The description of the entity. + */ public var description: String? - /// Any metadata related to the entity. + /** + Any metadata related to the entity. + */ public var metadata: [String: JSON]? - /// Whether fuzzy matching is used for the entity. + /** + Whether fuzzy matching is used for the entity. + */ public var fuzzyMatch: Bool? - /// An array objects describing the entity values. + /** + An array objects describing the entity values. + */ public var values: [ValueExport]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/Example.swift b/Source/ConversationV1/Models/Example.swift index 0d34e47dd..2e7ad8afb 100644 --- a/Source/ConversationV1/Models/Example.swift +++ b/Source/ConversationV1/Models/Example.swift @@ -19,13 +19,19 @@ import Foundation /** Example. */ public struct Example: Decodable { - /// The text of the user input example. + /** + The text of the user input example. + */ public var exampleText: String - /// The timestamp for creation of the example. + /** + The timestamp for creation of the example. + */ public var created: String? - /// The timestamp for the last update to the example. + /** + The timestamp for the last update to the example. + */ public var updated: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/ExampleCollection.swift b/Source/ConversationV1/Models/ExampleCollection.swift index a56bb883c..cd40cb86c 100644 --- a/Source/ConversationV1/Models/ExampleCollection.swift +++ b/Source/ConversationV1/Models/ExampleCollection.swift @@ -19,10 +19,14 @@ import Foundation /** ExampleCollection. */ public struct ExampleCollection: Decodable { - /// An array of objects describing the examples defined for the intent. + /** + An array of objects describing the examples defined for the intent. + */ public var examples: [Example] - /// The pagination data for the returned objects. + /** + The pagination data for the returned objects. + */ public var pagination: Pagination // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/InputData.swift b/Source/ConversationV1/Models/InputData.swift index 8e47dbb4e..4860c5e4f 100644 --- a/Source/ConversationV1/Models/InputData.swift +++ b/Source/ConversationV1/Models/InputData.swift @@ -19,7 +19,10 @@ import Foundation /** The user input. */ public struct InputData: Codable { - /// The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters. + /** + The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be + no longer than 2048 characters. + */ public var text: String // Map each property name to the key that shall be used for encoding/decoding. @@ -30,11 +33,15 @@ public struct InputData: Codable { /** Initialize a `InputData` with member variables. - - parameter text: The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters. + - parameter text: The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must + be no longer than 2048 characters. - returns: An initialized `InputData`. */ - public init(text: String) { + public init( + text: String + ) + { self.text = text } diff --git a/Source/ConversationV1/Models/Intent.swift b/Source/ConversationV1/Models/Intent.swift index 8638ff8e2..088f4e18e 100644 --- a/Source/ConversationV1/Models/Intent.swift +++ b/Source/ConversationV1/Models/Intent.swift @@ -19,16 +19,24 @@ import Foundation /** Intent. */ public struct Intent: Decodable { - /// The name of the intent. + /** + The name of the intent. + */ public var intentName: String - /// The timestamp for creation of the intent. + /** + The timestamp for creation of the intent. + */ public var created: String? - /// The timestamp for the last update to the intent. + /** + The timestamp for the last update to the intent. + */ public var updated: String? - /// The description of the intent. + /** + The description of the intent. + */ public var description: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/IntentCollection.swift b/Source/ConversationV1/Models/IntentCollection.swift index 700882af7..7df66ea61 100644 --- a/Source/ConversationV1/Models/IntentCollection.swift +++ b/Source/ConversationV1/Models/IntentCollection.swift @@ -19,10 +19,14 @@ import Foundation /** IntentCollection. */ public struct IntentCollection: Decodable { - /// An array of objects describing the intents defined for the workspace. + /** + An array of objects describing the intents defined for the workspace. + */ public var intents: [IntentExport] - /// The pagination data for the returned objects. + /** + The pagination data for the returned objects. + */ public var pagination: Pagination // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/IntentExport.swift b/Source/ConversationV1/Models/IntentExport.swift index 4b370dd29..b80fe44a7 100644 --- a/Source/ConversationV1/Models/IntentExport.swift +++ b/Source/ConversationV1/Models/IntentExport.swift @@ -19,19 +19,29 @@ import Foundation /** IntentExport. */ public struct IntentExport: Decodable { - /// The name of the intent. + /** + The name of the intent. + */ public var intentName: String - /// The timestamp for creation of the intent. + /** + The timestamp for creation of the intent. + */ public var created: String? - /// The timestamp for the last update to the intent. + /** + The timestamp for the last update to the intent. + */ public var updated: String? - /// The description of the intent. + /** + The description of the intent. + */ public var description: String? - /// An array of objects describing the user input examples for the intent. + /** + An array of objects describing the user input examples for the intent. + */ public var examples: [Example]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/LogCollection.swift b/Source/ConversationV1/Models/LogCollection.swift index 296766c2c..792002b20 100644 --- a/Source/ConversationV1/Models/LogCollection.swift +++ b/Source/ConversationV1/Models/LogCollection.swift @@ -19,10 +19,14 @@ import Foundation /** LogCollection. */ public struct LogCollection: Decodable { - /// An array of objects describing log events. + /** + An array of objects describing log events. + */ public var logs: [LogExport] - /// The pagination data for the returned objects. + /** + The pagination data for the returned objects. + */ public var pagination: LogPagination // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/LogExport.swift b/Source/ConversationV1/Models/LogExport.swift index adc47ca15..34f51da97 100644 --- a/Source/ConversationV1/Models/LogExport.swift +++ b/Source/ConversationV1/Models/LogExport.swift @@ -19,25 +19,39 @@ import Foundation /** LogExport. */ public struct LogExport: Decodable { - /// A request received by the workspace, including the user input and context. + /** + A request received by the workspace, including the user input and context. + */ public var request: MessageRequest - /// The response sent by the workspace, including the output text, detected intents and entities, and context. + /** + The response sent by the workspace, including the output text, detected intents and entities, and context. + */ public var response: MessageResponse - /// A unique identifier for the logged event. + /** + A unique identifier for the logged event. + */ public var logID: String - /// The timestamp for receipt of the message. + /** + The timestamp for receipt of the message. + */ public var requestTimestamp: String - /// The timestamp for the system response to the message. + /** + The timestamp for the system response to the message. + */ public var responseTimestamp: String - /// The unique identifier of the workspace where the request was made. + /** + The unique identifier of the workspace where the request was made. + */ public var workspaceID: String - /// The language of the workspace where the message request was made. + /** + The language of the workspace where the message request was made. + */ public var language: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/LogMessage.swift b/Source/ConversationV1/Models/LogMessage.swift index 1820936ec..7c23e9ca6 100644 --- a/Source/ConversationV1/Models/LogMessage.swift +++ b/Source/ConversationV1/Models/LogMessage.swift @@ -19,17 +19,23 @@ import Foundation /** Log message details. */ public struct LogMessage: Codable { - /// The severity of the log message. + /** + The severity of the log message. + */ public enum Level: String { case info = "info" case error = "error" case warn = "warn" } - /// The severity of the log message. + /** + The severity of the log message. + */ public var level: String - /// The text of the log message. + /** + The text of the log message. + */ public var msg: String /// Additional properties associated with this model. @@ -50,7 +56,12 @@ public struct LogMessage: Codable { - returns: An initialized `LogMessage`. */ - public init(level: String, msg: String, additionalProperties: [String: JSON] = [:]) { + public init( + level: String, + msg: String, + additionalProperties: [String: JSON] = [:] + ) + { self.level = level self.msg = msg self.additionalProperties = additionalProperties diff --git a/Source/ConversationV1/Models/LogPagination.swift b/Source/ConversationV1/Models/LogPagination.swift index b251d0986..a3a869137 100644 --- a/Source/ConversationV1/Models/LogPagination.swift +++ b/Source/ConversationV1/Models/LogPagination.swift @@ -19,13 +19,19 @@ import Foundation /** The pagination data for the returned objects. */ public struct LogPagination: Decodable { - /// The URL that will return the next page of results, if any. + /** + The URL that will return the next page of results, if any. + */ public var nextUrl: String? - /// Reserved for future use. + /** + Reserved for future use. + */ public var matched: Int? - /// A token identifying the next page of results. + /** + A token identifying the next page of results. + */ public var nextCursor: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/MessageInput.swift b/Source/ConversationV1/Models/MessageInput.swift index 58139d4c2..a68bb6eda 100644 --- a/Source/ConversationV1/Models/MessageInput.swift +++ b/Source/ConversationV1/Models/MessageInput.swift @@ -19,7 +19,9 @@ import Foundation /** The text of the user input. */ public struct MessageInput: Decodable { - /// The user's input. + /** + The user's input. + */ public var text: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/MessageRequest.swift b/Source/ConversationV1/Models/MessageRequest.swift index b1ef63312..097ebc6a8 100644 --- a/Source/ConversationV1/Models/MessageRequest.swift +++ b/Source/ConversationV1/Models/MessageRequest.swift @@ -19,22 +19,38 @@ import Foundation /** A request formatted for the Conversation service. */ public struct MessageRequest: Codable { - /// An input object that includes the input text. + /** + An input object that includes the input text. + */ public var input: InputData? - /// Whether to return more than one intent. Set to `true` to return all matching intents. + /** + Whether to return more than one intent. Set to `true` to return all matching intents. + */ public var alternateIntents: Bool? - /// State information for the conversation. Continue a conversation by including the context object from the previous response. + /** + State information for the conversation. Continue a conversation by including the context object from the previous + response. + */ public var context: Context? - /// Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input. + /** + Entities to use when evaluating the message. Include entities from the previous response to continue using those + entities rather than detecting entities in the new input. + */ public var entities: [RuntimeEntity]? - /// Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input. + /** + Intents to use when evaluating the user input. Include intents from the previous response to continue using those + intents rather than trying to recognize intents in the new input. + */ public var intents: [RuntimeIntent]? - /// System output. Include the output from the previous response to maintain intermediate information over multiple requests. + /** + System output. Include the output from the previous response to maintain intermediate information over multiple + requests. + */ public var output: OutputData? // Map each property name to the key that shall be used for encoding/decoding. @@ -52,14 +68,26 @@ public struct MessageRequest: Codable { - parameter input: An input object that includes the input text. - parameter alternateIntents: Whether to return more than one intent. Set to `true` to return all matching intents. - - parameter context: State information for the conversation. Continue a conversation by including the context object from the previous response. - - parameter entities: Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input. - - parameter intents: Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input. - - parameter output: System output. Include the output from the previous response to maintain intermediate information over multiple requests. + - parameter context: State information for the conversation. Continue a conversation by including the context object from the previous + response. + - parameter entities: Entities to use when evaluating the message. Include entities from the previous response to continue using those + entities rather than detecting entities in the new input. + - parameter intents: Intents to use when evaluating the user input. Include intents from the previous response to continue using those + intents rather than trying to recognize intents in the new input. + - parameter output: System output. Include the output from the previous response to maintain intermediate information over multiple + requests. - returns: An initialized `MessageRequest`. */ - public init(input: InputData? = nil, alternateIntents: Bool? = nil, context: Context? = nil, entities: [RuntimeEntity]? = nil, intents: [RuntimeIntent]? = nil, output: OutputData? = nil) { + public init( + input: InputData? = nil, + alternateIntents: Bool? = nil, + context: Context? = nil, + entities: [RuntimeEntity]? = nil, + intents: [RuntimeIntent]? = nil, + output: OutputData? = nil + ) + { self.input = input self.alternateIntents = alternateIntents self.context = context diff --git a/Source/ConversationV1/Models/MessageResponse.swift b/Source/ConversationV1/Models/MessageResponse.swift index aecb74331..e515c0cd8 100644 --- a/Source/ConversationV1/Models/MessageResponse.swift +++ b/Source/ConversationV1/Models/MessageResponse.swift @@ -19,22 +19,34 @@ import Foundation /** A response from the Conversation service. */ public struct MessageResponse: Decodable { - /// The user input from the request. + /** + The user input from the request. + */ public var input: MessageInput? - /// An array of intents recognized in the user input, sorted in descending order of confidence. + /** + An array of intents recognized in the user input, sorted in descending order of confidence. + */ public var intents: [RuntimeIntent] - /// An array of entities identified in the user input. + /** + An array of entities identified in the user input. + */ public var entities: [RuntimeEntity] - /// Whether to return more than one intent. A value of `true` indicates that all matching intents are returned. + /** + Whether to return more than one intent. A value of `true` indicates that all matching intents are returned. + */ public var alternateIntents: Bool? - /// State information for the conversation. + /** + State information for the conversation. + */ public var context: Context - /// Output from the dialog, including the response to the user, the nodes that were triggered, and log messages. + /** + Output from the dialog, including the response to the user, the nodes that were triggered, and log messages. + */ public var output: OutputData /// Additional properties associated with this model. diff --git a/Source/ConversationV1/Models/OutputData.swift b/Source/ConversationV1/Models/OutputData.swift index 67e0e94a1..f59b3ba79 100644 --- a/Source/ConversationV1/Models/OutputData.swift +++ b/Source/ConversationV1/Models/OutputData.swift @@ -19,16 +19,27 @@ import Foundation /** An output object that includes the response to the user, the nodes that were hit, and messages from the log. */ public struct OutputData: Codable { - /// An array of up to 50 messages logged with the request. + /** + An array of up to 50 messages logged with the request. + */ public var logMessages: [LogMessage] - /// An array of responses to the user. + /** + An array of responses to the user. + */ public var text: [String] - /// An array of the nodes that were triggered to create the response, in the order in which they were visited. This information is useful for debugging and for tracing the path taken through the node tree. + /** + An array of the nodes that were triggered to create the response, in the order in which they were visited. This + information is useful for debugging and for tracing the path taken through the node tree. + */ public var nodesVisited: [String]? - /// An array of objects containing detailed diagnostic information about the nodes that were triggered during processing of the input message. Included only if **nodes_visited_details** is set to `true` in the message request. + /** + An array of objects containing detailed diagnostic information about the nodes that were triggered during + processing of the input message. Included only if **nodes_visited_details** is set to `true` in the message + request. + */ public var nodesVisitedDetails: [DialogNodeVisitedDetails]? /// Additional properties associated with this model. @@ -48,12 +59,22 @@ public struct OutputData: Codable { - parameter logMessages: An array of up to 50 messages logged with the request. - parameter text: An array of responses to the user. - - parameter nodesVisited: An array of the nodes that were triggered to create the response, in the order in which they were visited. This information is useful for debugging and for tracing the path taken through the node tree. - - parameter nodesVisitedDetails: An array of objects containing detailed diagnostic information about the nodes that were triggered during processing of the input message. Included only if **nodes_visited_details** is set to `true` in the message request. + - parameter nodesVisited: An array of the nodes that were triggered to create the response, in the order in which they were visited. This + information is useful for debugging and for tracing the path taken through the node tree. + - parameter nodesVisitedDetails: An array of objects containing detailed diagnostic information about the nodes that were triggered during + processing of the input message. Included only if **nodes_visited_details** is set to `true` in the message + request. - returns: An initialized `OutputData`. */ - public init(logMessages: [LogMessage], text: [String], nodesVisited: [String]? = nil, nodesVisitedDetails: [DialogNodeVisitedDetails]? = nil, additionalProperties: [String: JSON] = [:]) { + public init( + logMessages: [LogMessage], + text: [String], + nodesVisited: [String]? = nil, + nodesVisitedDetails: [DialogNodeVisitedDetails]? = nil, + additionalProperties: [String: JSON] = [:] + ) + { self.logMessages = logMessages self.text = text self.nodesVisited = nodesVisited diff --git a/Source/ConversationV1/Models/Pagination.swift b/Source/ConversationV1/Models/Pagination.swift index ac814c407..72ae1c002 100644 --- a/Source/ConversationV1/Models/Pagination.swift +++ b/Source/ConversationV1/Models/Pagination.swift @@ -19,22 +19,34 @@ import Foundation /** The pagination data for the returned objects. */ public struct Pagination: Decodable { - /// The URL that will return the same page of results. + /** + The URL that will return the same page of results. + */ public var refreshUrl: String - /// The URL that will return the next page of results. + /** + The URL that will return the next page of results. + */ public var nextUrl: String? - /// Reserved for future use. + /** + Reserved for future use. + */ public var total: Int? - /// Reserved for future use. + /** + Reserved for future use. + */ public var matched: Int? - /// A token identifying the current page of results. + /** + A token identifying the current page of results. + */ public var refreshCursor: String? - /// A token identifying the next page of results. + /** + A token identifying the next page of results. + */ public var nextCursor: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/RuntimeEntity.swift b/Source/ConversationV1/Models/RuntimeEntity.swift index badce31fc..2d8a7adc0 100644 --- a/Source/ConversationV1/Models/RuntimeEntity.swift +++ b/Source/ConversationV1/Models/RuntimeEntity.swift @@ -19,22 +19,35 @@ import Foundation /** A term from the request that was identified as an entity. */ public struct RuntimeEntity: Codable { - /// An entity detected in the input. + /** + An entity detected in the input. + */ public var entity: String - /// An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text. + /** + An array of zero-based character offsets that indicate where the detected entity values begin and end in the input + text. + */ public var location: [Int] - /// The term in the input text that was recognized as an entity value. + /** + The term in the input text that was recognized as an entity value. + */ public var value: String - /// A decimal percentage that represents Watson's confidence in the entity. + /** + A decimal percentage that represents Watson's confidence in the entity. + */ public var confidence: Double? - /// Any metadata for the entity. + /** + Any metadata for the entity. + */ public var metadata: [String: JSON]? - /// The recognized capture groups for the entity, as defined by the entity pattern. + /** + The recognized capture groups for the entity, as defined by the entity pattern. + */ public var groups: [CaptureGroup]? /// Additional properties associated with this model. @@ -55,7 +68,8 @@ public struct RuntimeEntity: Codable { Initialize a `RuntimeEntity` with member variables. - parameter entity: An entity detected in the input. - - parameter location: An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text. + - parameter location: An array of zero-based character offsets that indicate where the detected entity values begin and end in the + input text. - parameter value: The term in the input text that was recognized as an entity value. - parameter confidence: A decimal percentage that represents Watson's confidence in the entity. - parameter metadata: Any metadata for the entity. @@ -63,7 +77,16 @@ public struct RuntimeEntity: Codable { - returns: An initialized `RuntimeEntity`. */ - public init(entity: String, location: [Int], value: String, confidence: Double? = nil, metadata: [String: JSON]? = nil, groups: [CaptureGroup]? = nil, additionalProperties: [String: JSON] = [:]) { + public init( + entity: String, + location: [Int], + value: String, + confidence: Double? = nil, + metadata: [String: JSON]? = nil, + groups: [CaptureGroup]? = nil, + additionalProperties: [String: JSON] = [:] + ) + { self.entity = entity self.location = location self.value = value diff --git a/Source/ConversationV1/Models/RuntimeIntent.swift b/Source/ConversationV1/Models/RuntimeIntent.swift index 462053998..bc0495e35 100644 --- a/Source/ConversationV1/Models/RuntimeIntent.swift +++ b/Source/ConversationV1/Models/RuntimeIntent.swift @@ -19,10 +19,14 @@ import Foundation /** An intent identified in the user input. */ public struct RuntimeIntent: Codable { - /// The name of the recognized intent. + /** + The name of the recognized intent. + */ public var intent: String - /// A decimal percentage that represents Watson's confidence in the intent. + /** + A decimal percentage that represents Watson's confidence in the intent. + */ public var confidence: Double /// Additional properties associated with this model. @@ -43,7 +47,12 @@ public struct RuntimeIntent: Codable { - returns: An initialized `RuntimeIntent`. */ - public init(intent: String, confidence: Double, additionalProperties: [String: JSON] = [:]) { + public init( + intent: String, + confidence: Double, + additionalProperties: [String: JSON] = [:] + ) + { self.intent = intent self.confidence = confidence self.additionalProperties = additionalProperties diff --git a/Source/ConversationV1/Models/Synonym.swift b/Source/ConversationV1/Models/Synonym.swift index bd15b321d..327b8fa0c 100644 --- a/Source/ConversationV1/Models/Synonym.swift +++ b/Source/ConversationV1/Models/Synonym.swift @@ -19,13 +19,19 @@ import Foundation /** Synonym. */ public struct Synonym: Decodable { - /// The text of the synonym. + /** + The text of the synonym. + */ public var synonymText: String - /// The timestamp for creation of the synonym. + /** + The timestamp for creation of the synonym. + */ public var created: String? - /// The timestamp for the most recent update to the synonym. + /** + The timestamp for the most recent update to the synonym. + */ public var updated: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/SynonymCollection.swift b/Source/ConversationV1/Models/SynonymCollection.swift index 37bb38fa5..baa5bc53e 100644 --- a/Source/ConversationV1/Models/SynonymCollection.swift +++ b/Source/ConversationV1/Models/SynonymCollection.swift @@ -19,10 +19,14 @@ import Foundation /** SynonymCollection. */ public struct SynonymCollection: Decodable { - /// An array of synonyms. + /** + An array of synonyms. + */ public var synonyms: [Synonym] - /// The pagination data for the returned objects. + /** + The pagination data for the returned objects. + */ public var pagination: Pagination // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/SystemResponse.swift b/Source/ConversationV1/Models/SystemResponse.swift index a6d8bba71..316141d8f 100644 --- a/Source/ConversationV1/Models/SystemResponse.swift +++ b/Source/ConversationV1/Models/SystemResponse.swift @@ -27,7 +27,10 @@ public struct SystemResponse: Codable { - returns: An initialized `SystemResponse`. */ - public init(additionalProperties: [String: JSON] = [:]) { + public init( + additionalProperties: [String: JSON] = [:] + ) + { self.additionalProperties = additionalProperties } diff --git a/Source/ConversationV1/Models/UpdateCounterexample.swift b/Source/ConversationV1/Models/UpdateCounterexample.swift index f2c79c170..7357e823d 100644 --- a/Source/ConversationV1/Models/UpdateCounterexample.swift +++ b/Source/ConversationV1/Models/UpdateCounterexample.swift @@ -19,7 +19,9 @@ import Foundation /** UpdateCounterexample. */ public struct UpdateCounterexample: Encodable { - /// The text of a user input counterexample. + /** + The text of a user input counterexample. + */ public var text: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -34,7 +36,10 @@ public struct UpdateCounterexample: Encodable { - returns: An initialized `UpdateCounterexample`. */ - public init(text: String? = nil) { + public init( + text: String? = nil + ) + { self.text = text } diff --git a/Source/ConversationV1/Models/UpdateDialogNode.swift b/Source/ConversationV1/Models/UpdateDialogNode.swift index d24d461d3..9d3d19b0f 100644 --- a/Source/ConversationV1/Models/UpdateDialogNode.swift +++ b/Source/ConversationV1/Models/UpdateDialogNode.swift @@ -19,7 +19,9 @@ import Foundation /** UpdateDialogNode. */ public struct UpdateDialogNode: Encodable { - /// How the dialog node is processed. + /** + How the dialog node is processed. + */ public enum NodeType: String { case standard = "standard" case eventHandler = "event_handler" @@ -29,7 +31,9 @@ public struct UpdateDialogNode: Encodable { case folder = "folder" } - /// How an `event_handler` node is processed. + /** + How an `event_handler` node is processed. + */ public enum EventName: String { case focus = "focus" case input = "input" @@ -42,76 +46,123 @@ public struct UpdateDialogNode: Encodable { case digressionReturnPrompt = "digression_return_prompt" } - /// Whether this top-level dialog node can be digressed into. + /** + Whether this top-level dialog node can be digressed into. + */ public enum DigressIn: String { case notAvailable = "not_available" case returns = "returns" case doesNotReturn = "does_not_return" } - /// Whether this dialog node can be returned to after a digression. + /** + Whether this dialog node can be returned to after a digression. + */ public enum DigressOut: String { case returning = "allow_returning" case all = "allow_all" case allNeverReturn = "allow_all_never_return" } - /// Whether the user can digress to top-level nodes while filling out slots. + /** + Whether the user can digress to top-level nodes while filling out slots. + */ public enum DigressOutSlots: String { case notAllowed = "not_allowed" case allowReturning = "allow_returning" case allowAll = "allow_all" } - /// The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters. + /** + The dialog node ID. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. + - It must be no longer than 1024 characters. + */ public var dialogNode: String? - /// The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + /** + The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it + must be no longer than 128 characters. + */ public var description: String? - /// The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters. + /** + The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab + characters, and it must be no longer than 2048 characters. + */ public var conditions: String? - /// The ID of the parent dialog node. + /** + The ID of the parent dialog node. + */ public var parent: String? - /// The ID of the previous sibling dialog node. + /** + The ID of the previous sibling dialog node. + */ public var previousSibling: String? - /// The output of the dialog node. For more information about how to specify dialog node output, see the [documentation](https://console.bluemix.net/docs/services/conversation/dialog-overview.html#complex). + /** + The output of the dialog node. For more information about how to specify dialog node output, see the + [documentation](https://console.bluemix.net/docs/services/conversation/dialog-overview.html#complex). + */ public var output: [String: JSON]? - /// The context for the dialog node. + /** + The context for the dialog node. + */ public var context: [String: JSON]? - /// The metadata for the dialog node. + /** + The metadata for the dialog node. + */ public var metadata: [String: JSON]? - /// The next step to be executed in dialog processing. + /** + The next step to be executed in dialog processing. + */ public var nextStep: DialogNodeNextStep? - /// The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters. + /** + The alias used to identify the dialog node. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. + - It must be no longer than 64 characters. + */ public var title: String? - /// How the dialog node is processed. + /** + How the dialog node is processed. + */ public var nodeType: String? - /// How an `event_handler` node is processed. + /** + How an `event_handler` node is processed. + */ public var eventName: String? - /// The location in the dialog context where output is stored. + /** + The location in the dialog context where output is stored. + */ public var variable: String? - /// An array of objects describing any actions to be invoked by the dialog node. + /** + An array of objects describing any actions to be invoked by the dialog node. + */ public var actions: [DialogNodeAction]? - /// Whether this top-level dialog node can be digressed into. + /** + Whether this top-level dialog node can be digressed into. + */ public var digressIn: String? - /// Whether this dialog node can be returned to after a digression. + /** + Whether this dialog node can be returned to after a digression. + */ public var digressOut: String? - /// Whether the user can digress to top-level nodes while filling out slots. + /** + Whether the user can digress to top-level nodes while filling out slots. + */ public var digressOutSlots: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -138,16 +189,23 @@ public struct UpdateDialogNode: Encodable { /** Initialize a `UpdateDialogNode` with member variables. - - parameter dialogNode: The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters. - - parameter description: The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. - - parameter conditions: The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters. + - parameter dialogNode: The dialog node ID. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. + - It must be no longer than 1024 characters. + - parameter description: The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and + it must be no longer than 128 characters. + - parameter conditions: The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab + characters, and it must be no longer than 2048 characters. - parameter parent: The ID of the parent dialog node. - parameter previousSibling: The ID of the previous sibling dialog node. - - parameter output: The output of the dialog node. For more information about how to specify dialog node output, see the [documentation](https://console.bluemix.net/docs/services/conversation/dialog-overview.html#complex). + - parameter output: The output of the dialog node. For more information about how to specify dialog node output, see the + [documentation](https://console.bluemix.net/docs/services/conversation/dialog-overview.html#complex). - parameter context: The context for the dialog node. - parameter metadata: The metadata for the dialog node. - parameter nextStep: The next step to be executed in dialog processing. - - parameter title: The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters. + - parameter title: The alias used to identify the dialog node. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. + - It must be no longer than 64 characters. - parameter nodeType: How the dialog node is processed. - parameter eventName: How an `event_handler` node is processed. - parameter variable: The location in the dialog context where output is stored. @@ -158,7 +216,26 @@ public struct UpdateDialogNode: Encodable { - returns: An initialized `UpdateDialogNode`. */ - public init(dialogNode: String? = nil, description: String? = nil, conditions: String? = nil, parent: String? = nil, previousSibling: String? = nil, output: [String: JSON]? = nil, context: [String: JSON]? = nil, metadata: [String: JSON]? = nil, nextStep: DialogNodeNextStep? = nil, title: String? = nil, nodeType: String? = nil, eventName: String? = nil, variable: String? = nil, actions: [DialogNodeAction]? = nil, digressIn: String? = nil, digressOut: String? = nil, digressOutSlots: String? = nil) { + public init( + dialogNode: String? = nil, + description: String? = nil, + conditions: String? = nil, + parent: String? = nil, + previousSibling: String? = nil, + output: [String: JSON]? = nil, + context: [String: JSON]? = nil, + metadata: [String: JSON]? = nil, + nextStep: DialogNodeNextStep? = nil, + title: String? = nil, + nodeType: String? = nil, + eventName: String? = nil, + variable: String? = nil, + actions: [DialogNodeAction]? = nil, + digressIn: String? = nil, + digressOut: String? = nil, + digressOutSlots: String? = nil + ) + { self.dialogNode = dialogNode self.description = description self.conditions = conditions diff --git a/Source/ConversationV1/Models/UpdateEntity.swift b/Source/ConversationV1/Models/UpdateEntity.swift index be273e3bd..8ed767cee 100644 --- a/Source/ConversationV1/Models/UpdateEntity.swift +++ b/Source/ConversationV1/Models/UpdateEntity.swift @@ -19,19 +19,33 @@ import Foundation /** UpdateEntity. */ public struct UpdateEntity: Encodable { - /// The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix `sys-`. - It must be no longer than 64 characters. + /** + The name of the entity. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, underscore, and hyphen characters. + - It cannot begin with the reserved prefix `sys-`. + - It must be no longer than 64 characters. + */ public var entity: String? - /// The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + /** + The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must + be no longer than 128 characters. + */ public var description: String? - /// Any metadata related to the entity. + /** + Any metadata related to the entity. + */ public var metadata: [String: JSON]? - /// Whether to use fuzzy matching for the entity. + /** + Whether to use fuzzy matching for the entity. + */ public var fuzzyMatch: Bool? - /// An array of entity values. + /** + An array of entity values. + */ public var values: [CreateValue]? // Map each property name to the key that shall be used for encoding/decoding. @@ -46,15 +60,26 @@ public struct UpdateEntity: Encodable { /** Initialize a `UpdateEntity` with member variables. - - parameter entity: The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix `sys-`. - It must be no longer than 64 characters. - - parameter description: The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + - parameter entity: The name of the entity. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, underscore, and hyphen characters. + - It cannot begin with the reserved prefix `sys-`. + - It must be no longer than 64 characters. + - parameter description: The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it + must be no longer than 128 characters. - parameter metadata: Any metadata related to the entity. - parameter fuzzyMatch: Whether to use fuzzy matching for the entity. - parameter values: An array of entity values. - returns: An initialized `UpdateEntity`. */ - public init(entity: String? = nil, description: String? = nil, metadata: [String: JSON]? = nil, fuzzyMatch: Bool? = nil, values: [CreateValue]? = nil) { + public init( + entity: String? = nil, + description: String? = nil, + metadata: [String: JSON]? = nil, + fuzzyMatch: Bool? = nil, + values: [CreateValue]? = nil + ) + { self.entity = entity self.description = description self.metadata = metadata diff --git a/Source/ConversationV1/Models/UpdateExample.swift b/Source/ConversationV1/Models/UpdateExample.swift index f2fd9beb6..8f064169d 100644 --- a/Source/ConversationV1/Models/UpdateExample.swift +++ b/Source/ConversationV1/Models/UpdateExample.swift @@ -19,7 +19,12 @@ import Foundation /** UpdateExample. */ public struct UpdateExample: Encodable { - /// The text of the user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters. + /** + The text of the user input example. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 1024 characters. + */ public var text: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -30,11 +35,17 @@ public struct UpdateExample: Encodable { /** Initialize a `UpdateExample` with member variables. - - parameter text: The text of the user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters. + - parameter text: The text of the user input example. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 1024 characters. - returns: An initialized `UpdateExample`. */ - public init(text: String? = nil) { + public init( + text: String? = nil + ) + { self.text = text } diff --git a/Source/ConversationV1/Models/UpdateIntent.swift b/Source/ConversationV1/Models/UpdateIntent.swift index 96d9e52c0..ea350b2ae 100644 --- a/Source/ConversationV1/Models/UpdateIntent.swift +++ b/Source/ConversationV1/Models/UpdateIntent.swift @@ -19,13 +19,22 @@ import Foundation /** UpdateIntent. */ public struct UpdateIntent: Encodable { - /// The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix `sys-`. - It must be no longer than 128 characters. + /** + The name of the intent. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. + - It cannot begin with the reserved prefix `sys-`. + - It must be no longer than 128 characters. + */ public var intent: String? - /// The description of the intent. + /** + The description of the intent. + */ public var description: String? - /// An array of user input examples for the intent. + /** + An array of user input examples for the intent. + */ public var examples: [CreateExample]? // Map each property name to the key that shall be used for encoding/decoding. @@ -38,13 +47,21 @@ public struct UpdateIntent: Encodable { /** Initialize a `UpdateIntent` with member variables. - - parameter intent: The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix `sys-`. - It must be no longer than 128 characters. + - parameter intent: The name of the intent. This string must conform to the following restrictions: + - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. + - It cannot begin with the reserved prefix `sys-`. + - It must be no longer than 128 characters. - parameter description: The description of the intent. - parameter examples: An array of user input examples for the intent. - returns: An initialized `UpdateIntent`. */ - public init(intent: String? = nil, description: String? = nil, examples: [CreateExample]? = nil) { + public init( + intent: String? = nil, + description: String? = nil, + examples: [CreateExample]? = nil + ) + { self.intent = intent self.description = description self.examples = examples diff --git a/Source/ConversationV1/Models/UpdateSynonym.swift b/Source/ConversationV1/Models/UpdateSynonym.swift index 3532ab38a..b5342ce27 100644 --- a/Source/ConversationV1/Models/UpdateSynonym.swift +++ b/Source/ConversationV1/Models/UpdateSynonym.swift @@ -19,7 +19,12 @@ import Foundation /** UpdateSynonym. */ public struct UpdateSynonym: Encodable { - /// The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. + /** + The text of the synonym. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. + */ public var synonym: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -30,11 +35,17 @@ public struct UpdateSynonym: Encodable { /** Initialize a `UpdateSynonym` with member variables. - - parameter synonym: The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. + - parameter synonym: The text of the synonym. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. - returns: An initialized `UpdateSynonym`. */ - public init(synonym: String? = nil) { + public init( + synonym: String? = nil + ) + { self.synonym = synonym } diff --git a/Source/ConversationV1/Models/UpdateValue.swift b/Source/ConversationV1/Models/UpdateValue.swift index fe3562a98..362ef978b 100644 --- a/Source/ConversationV1/Models/UpdateValue.swift +++ b/Source/ConversationV1/Models/UpdateValue.swift @@ -19,25 +19,47 @@ import Foundation /** UpdateValue. */ public struct UpdateValue: Encodable { - /// Specifies the type of value. + /** + Specifies the type of value. + */ public enum ValueType: String { case synonyms = "synonyms" case patterns = "patterns" } - /// The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. + /** + The text of the entity value. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. + */ public var value: String? - /// Any metadata related to the entity value. + /** + Any metadata related to the entity value. + */ public var metadata: [String: JSON]? - /// Specifies the type of value. + /** + Specifies the type of value. + */ public var valueType: String? - /// An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by **type**), but not both. A synonym must conform to the following resrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. + /** + An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by **type**), + but not both. A synonym must conform to the following resrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. + */ public var synonyms: [String]? - /// An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by **type**), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities). + /** + An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by **type**), + but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to + specify a pattern, see the + [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities). + */ public var patterns: [String]? // Map each property name to the key that shall be used for encoding/decoding. @@ -52,15 +74,32 @@ public struct UpdateValue: Encodable { /** Initialize a `UpdateValue` with member variables. - - parameter value: The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. + - parameter value: The text of the entity value. This string must conform to the following restrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. - parameter metadata: Any metadata related to the entity value. - parameter valueType: Specifies the type of value. - - parameter synonyms: An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by **type**), but not both. A synonym must conform to the following resrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters. - - parameter patterns: An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by **type**), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities). + - parameter synonyms: An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by + **type**), but not both. A synonym must conform to the following resrictions: + - It cannot contain carriage return, newline, or tab characters. + - It cannot consist of only whitespace characters. + - It must be no longer than 64 characters. + - parameter patterns: An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by + **type**), but not both. A pattern is a regular expression no longer than 128 characters. For more information + about how to specify a pattern, see the + [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities). - returns: An initialized `UpdateValue`. */ - public init(value: String? = nil, metadata: [String: JSON]? = nil, valueType: String? = nil, synonyms: [String]? = nil, patterns: [String]? = nil) { + public init( + value: String? = nil, + metadata: [String: JSON]? = nil, + valueType: String? = nil, + synonyms: [String]? = nil, + patterns: [String]? = nil + ) + { self.value = value self.metadata = metadata self.valueType = valueType diff --git a/Source/ConversationV1/Models/UpdateWorkspace.swift b/Source/ConversationV1/Models/UpdateWorkspace.swift index 06a935d0e..dec2167d9 100644 --- a/Source/ConversationV1/Models/UpdateWorkspace.swift +++ b/Source/ConversationV1/Models/UpdateWorkspace.swift @@ -19,31 +19,52 @@ import Foundation /** UpdateWorkspace. */ public struct UpdateWorkspace: Encodable { - /// The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters. + /** + The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be + no longer than 64 characters. + */ public var name: String? - /// The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + /** + The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it + must be no longer than 128 characters. + */ public var description: String? - /// The language of the workspace. + /** + The language of the workspace. + */ public var language: String? - /// An array of objects defining the intents for the workspace. + /** + An array of objects defining the intents for the workspace. + */ public var intents: [CreateIntent]? - /// An array of objects defining the entities for the workspace. + /** + An array of objects defining the entities for the workspace. + */ public var entities: [CreateEntity]? - /// An array of objects defining the nodes in the workspace dialog. + /** + An array of objects defining the nodes in the workspace dialog. + */ public var dialogNodes: [CreateDialogNode]? - /// An array of objects defining input examples that have been marked as irrelevant input. + /** + An array of objects defining input examples that have been marked as irrelevant input. + */ public var counterexamples: [CreateCounterexample]? - /// Any metadata related to the workspace. + /** + Any metadata related to the workspace. + */ public var metadata: [String: JSON]? - /// Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates that workspace training data is not to be used. + /** + Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates that + workspace training data is not to be used. + */ public var learningOptOut: Bool? // Map each property name to the key that shall be used for encoding/decoding. @@ -62,19 +83,33 @@ public struct UpdateWorkspace: Encodable { /** Initialize a `UpdateWorkspace` with member variables. - - parameter name: The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters. - - parameter description: The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters. + - parameter name: The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be + no longer than 64 characters. + - parameter description: The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it + must be no longer than 128 characters. - parameter language: The language of the workspace. - parameter intents: An array of objects defining the intents for the workspace. - parameter entities: An array of objects defining the entities for the workspace. - parameter dialogNodes: An array of objects defining the nodes in the workspace dialog. - parameter counterexamples: An array of objects defining input examples that have been marked as irrelevant input. - parameter metadata: Any metadata related to the workspace. - - parameter learningOptOut: Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates that workspace training data is not to be used. + - parameter learningOptOut: Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates + that workspace training data is not to be used. - returns: An initialized `UpdateWorkspace`. */ - public init(name: String? = nil, description: String? = nil, language: String? = nil, intents: [CreateIntent]? = nil, entities: [CreateEntity]? = nil, dialogNodes: [CreateDialogNode]? = nil, counterexamples: [CreateCounterexample]? = nil, metadata: [String: JSON]? = nil, learningOptOut: Bool? = nil) { + public init( + name: String? = nil, + description: String? = nil, + language: String? = nil, + intents: [CreateIntent]? = nil, + entities: [CreateEntity]? = nil, + dialogNodes: [CreateDialogNode]? = nil, + counterexamples: [CreateCounterexample]? = nil, + metadata: [String: JSON]? = nil, + learningOptOut: Bool? = nil + ) + { self.name = name self.description = description self.language = language diff --git a/Source/ConversationV1/Models/Value.swift b/Source/ConversationV1/Models/Value.swift index 47dafbcd6..1208b83b1 100644 --- a/Source/ConversationV1/Models/Value.swift +++ b/Source/ConversationV1/Models/Value.swift @@ -19,31 +19,47 @@ import Foundation /** Value. */ public struct Value: Decodable { - /// Specifies the type of value. + /** + Specifies the type of value. + */ public enum ValueType: String { case synonyms = "synonyms" case patterns = "patterns" } - /// The text of the entity value. + /** + The text of the entity value. + */ public var valueText: String - /// Any metadata related to the entity value. + /** + Any metadata related to the entity value. + */ public var metadata: [String: JSON]? - /// The timestamp for creation of the entity value. + /** + The timestamp for creation of the entity value. + */ public var created: String? - /// The timestamp for the last update to the entity value. + /** + The timestamp for the last update to the entity value. + */ public var updated: String? - /// An array containing any synonyms for the entity value. + /** + An array containing any synonyms for the entity value. + */ public var synonyms: [String]? - /// An array containing any patterns for the entity value. + /** + An array containing any patterns for the entity value. + */ public var patterns: [String]? - /// Specifies the type of value. + /** + Specifies the type of value. + */ public var valueType: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/ValueCollection.swift b/Source/ConversationV1/Models/ValueCollection.swift index ee6c8de38..9fcff5f6c 100644 --- a/Source/ConversationV1/Models/ValueCollection.swift +++ b/Source/ConversationV1/Models/ValueCollection.swift @@ -19,10 +19,14 @@ import Foundation /** ValueCollection. */ public struct ValueCollection: Decodable { - /// An array of entity values. + /** + An array of entity values. + */ public var values: [ValueExport] - /// An object defining the pagination data for the returned objects. + /** + An object defining the pagination data for the returned objects. + */ public var pagination: Pagination // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/ValueExport.swift b/Source/ConversationV1/Models/ValueExport.swift index 521c14312..f9b199d57 100644 --- a/Source/ConversationV1/Models/ValueExport.swift +++ b/Source/ConversationV1/Models/ValueExport.swift @@ -19,31 +19,47 @@ import Foundation /** ValueExport. */ public struct ValueExport: Decodable { - /// Specifies the type of value. + /** + Specifies the type of value. + */ public enum ValueType: String { case synonyms = "synonyms" case patterns = "patterns" } - /// The text of the entity value. + /** + The text of the entity value. + */ public var valueText: String - /// Any metadata related to the entity value. + /** + Any metadata related to the entity value. + */ public var metadata: [String: JSON]? - /// The timestamp for creation of the entity value. + /** + The timestamp for creation of the entity value. + */ public var created: String? - /// The timestamp for the last update to the entity value. + /** + The timestamp for the last update to the entity value. + */ public var updated: String? - /// An array containing any synonyms for the entity value. + /** + An array containing any synonyms for the entity value. + */ public var synonyms: [String]? - /// An array containing any patterns for the entity value. + /** + An array containing any patterns for the entity value. + */ public var patterns: [String]? - /// Specifies the type of value. + /** + Specifies the type of value. + */ public var valueType: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/Workspace.swift b/Source/ConversationV1/Models/Workspace.swift index 985136ee8..55e43fc1f 100644 --- a/Source/ConversationV1/Models/Workspace.swift +++ b/Source/ConversationV1/Models/Workspace.swift @@ -19,28 +19,45 @@ import Foundation /** Workspace. */ public struct Workspace: Decodable { - /// The name of the workspace. + /** + The name of the workspace. + */ public var name: String - /// The language of the workspace. + /** + The language of the workspace. + */ public var language: String - /// The timestamp for creation of the workspace. + /** + The timestamp for creation of the workspace. + */ public var created: String? - /// The timestamp for the last update to the workspace. + /** + The timestamp for the last update to the workspace. + */ public var updated: String? - /// The workspace ID. + /** + The workspace ID. + */ public var workspaceID: String - /// The description of the workspace. + /** + The description of the workspace. + */ public var description: String? - /// Any metadata related to the workspace. + /** + Any metadata related to the workspace. + */ public var metadata: [String: JSON]? - /// Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for general service improvements. `true` indicates that workspace training data is not to be used. + /** + Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for + general service improvements. `true` indicates that workspace training data is not to be used. + */ public var learningOptOut: Bool? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/WorkspaceCollection.swift b/Source/ConversationV1/Models/WorkspaceCollection.swift index 5fd10e6ba..a90f2aa54 100644 --- a/Source/ConversationV1/Models/WorkspaceCollection.swift +++ b/Source/ConversationV1/Models/WorkspaceCollection.swift @@ -19,10 +19,14 @@ import Foundation /** WorkspaceCollection. */ public struct WorkspaceCollection: Decodable { - /// An array of objects describing the workspaces associated with the service instance. + /** + An array of objects describing the workspaces associated with the service instance. + */ public var workspaces: [Workspace] - /// An object defining the pagination data for the returned objects. + /** + An object defining the pagination data for the returned objects. + */ public var pagination: Pagination // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ConversationV1/Models/WorkspaceExport.swift b/Source/ConversationV1/Models/WorkspaceExport.swift index 574f7e0b0..fd1590e44 100644 --- a/Source/ConversationV1/Models/WorkspaceExport.swift +++ b/Source/ConversationV1/Models/WorkspaceExport.swift @@ -19,7 +19,9 @@ import Foundation /** WorkspaceExport. */ public struct WorkspaceExport: Decodable { - /// The current status of the workspace. + /** + The current status of the workspace. + */ public enum Status: String { case nonExistent = "Non Existent" case training = "Training" @@ -28,43 +30,70 @@ public struct WorkspaceExport: Decodable { case unavailable = "Unavailable" } - /// The name of the workspace. + /** + The name of the workspace. + */ public var name: String - /// The description of the workspace. + /** + The description of the workspace. + */ public var description: String - /// The language of the workspace. + /** + The language of the workspace. + */ public var language: String - /// Any metadata that is required by the workspace. + /** + Any metadata that is required by the workspace. + */ public var metadata: [String: JSON] - /// The timestamp for creation of the workspace. + /** + The timestamp for creation of the workspace. + */ public var created: String? - /// The timestamp for the last update to the workspace. + /** + The timestamp for the last update to the workspace. + */ public var updated: String? - /// The workspace ID. + /** + The workspace ID. + */ public var workspaceID: String - /// The current status of the workspace. + /** + The current status of the workspace. + */ public var status: String - /// Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates that workspace training data is not to be used. + /** + Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates that + workspace training data is not to be used. + */ public var learningOptOut: Bool - /// An array of intents. + /** + An array of intents. + */ public var intents: [IntentExport]? - /// An array of entities. + /** + An array of entities. + */ public var entities: [EntityExport]? - /// An array of counterexamples. + /** + An array of counterexamples. + */ public var counterexamples: [Counterexample]? - /// An array of objects describing the dialog nodes in the workspace. + /** + An array of objects describing the dialog nodes in the workspace. + */ public var dialogNodes: [DialogNode]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Discovery.swift b/Source/DiscoveryV1/Discovery.swift index 8d8ff2b55..d1a413f70 100644 --- a/Source/DiscoveryV1/Discovery.swift +++ b/Source/DiscoveryV1/Discovery.swift @@ -17,10 +17,10 @@ import Foundation /** - The IBM Watson Discovery Service is a cognitive search and content analytics engine that you can add to applications to - identify patterns, trends and actionable insights to drive better decision-making. Securely unify structured and - unstructured data with pre-enriched content, and use a simplified query language to eliminate the need for manual - filtering of results. + The IBM Watson™ Discovery Service is a cognitive search and content analytics engine that you can add to + applications to identify patterns, trends and actionable insights to drive better decision-making. Securely unify + structured and unstructured data with pre-enriched content, and use a simplified query language to eliminate the need + for manual filtering of results. */ public class Discovery { @@ -449,22 +449,24 @@ public class Discovery { /** Add configuration. - Creates a new configuration. If the input configuration contains the `configuration_id`, `created`, or `updated` - properties, then they are ignored and overridden by the system, and an error is not returned so that the overridden - fields do not need to be removed when copying a configuration. The configuration can contain unrecognized JSON - fields. Any such fields are ignored and do not generate an error. This makes it easier to use newer configuration - files with older versions of the API and the service. It also makes it possible for the tooling to add additional - metadata and information to the configuration. + Creates a new configuration. + If the input configuration contains the `configuration_id`, `created`, or `updated` properties, then they are + ignored and overridden by the system, and an error is not returned so that the overridden fields do not need to be + removed when copying a configuration. + The configuration can contain unrecognized JSON fields. Any such fields are ignored and do not generate an error. + This makes it easier to use newer configuration files with older versions of the API and the service. It also makes + it possible for the tooling to add additional metadata and information to the configuration. - parameter environmentID: The ID of the environment. - parameter configuration: Input an object that enables you to customize how your content is ingested and what enrichments are added to your - data. `name` is required and must be unique within the current `environment`. All other properties are optional. - If the input configuration contains the `configuration_id`, `created`, or `updated` properties, then they will be - ignored and overridden by the system (an error is not returned so that the overridden fields do not need to be - removed when copying a configuration). The configuration can contain unrecognized JSON fields. Any such fields - will be ignored and will not generate an error. This makes it easier to use newer configuration files with older - versions of the API and the service. It also makes it possible for the tooling to add additional metadata and - information to the configuration. + data. + `name` is required and must be unique within the current `environment`. All other properties are optional. + If the input configuration contains the `configuration_id`, `created`, or `updated` properties, then they will be + ignored and overridden by the system (an error is not returned so that the overridden fields do not need to be + removed when copying a configuration). + The configuration can contain unrecognized JSON fields. Any such fields will be ignored and will not generate an + error. This makes it easier to use newer configuration files with older versions of the API and the service. It + also makes it possible for the tooling to add additional metadata and information to the configuration. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -630,23 +632,26 @@ public class Discovery { /** Update a configuration. - Replaces an existing configuration. * Completely replaces the original configuration. * The `configuration_id`, - `updated`, and `created` fields are accepted in the request, but they are ignored, and an error is not generated. - It is also acceptable for users to submit an updated configuration with none of the three properties. * Documents - are processed with a snapshot of the configuration as it was at the time the document was submitted to be ingested. - This means that already submitted documents will not see any updates made to the configuration. + Replaces an existing configuration. + * Completely replaces the original configuration. + * The `configuration_id`, `updated`, and `created` fields are accepted in the request, but they are ignored, and + an error is not generated. It is also acceptable for users to submit an updated configuration with none of the + three properties. + * Documents are processed with a snapshot of the configuration as it was at the time the document was submitted + to be ingested. This means that already submitted documents will not see any updates made to the configuration. - parameter environmentID: The ID of the environment. - parameter configurationID: The ID of the configuration. - parameter configuration: Input an object that enables you to update and customize how your data is ingested and what enrichments are added - to your data. The `name` parameter is required and must be unique within the current `environment`. All other - properties are optional, but if they are omitted the default values replace the current value of each omitted - property. If the input configuration contains the `configuration_id`, `created`, or `updated` properties, they are - ignored and overridden by the system, and an error is not returned so that the overridden fields do not need to be - removed when updating a configuration. The configuration can contain unrecognized JSON fields. Any such fields - are ignored and do not generate an error. This makes it easier to use newer configuration files with older versions - of the API and the service. It also makes it possible for the tooling to add additional metadata and information to - the configuration. + to your data. + The `name` parameter is required and must be unique within the current `environment`. All other properties are + optional, but if they are omitted the default values replace the current value of each omitted property. + If the input configuration contains the `configuration_id`, `created`, or `updated` properties, they are ignored + and overridden by the system, and an error is not returned so that the overridden fields do not need to be + removed when updating a configuration. + The configuration can contain unrecognized JSON fields. Any such fields are ignored and do not generate an error. + This makes it easier to use newer configuration files with older versions of the API and the service. It also + makes it possible for the tooling to add additional metadata and information to the configuration. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -765,19 +770,24 @@ public class Discovery { help you understand how the document was processed. The document is not added to the index. - parameter environmentID: The ID of the environment. - - parameter configuration: The configuration to use to process the document. If this part is provided, then the provided configuration is used - to process the document. If the `configuration_id` is also provided (both are present at the same time), then - request is rejected. The maximum supported configuration size is 1 MB. Configuration parts larger than 1 MB are - rejected. See the `GET /configurations/{configuration_id}` operation for an example configuration. + - parameter configuration: The configuration to use to process the document. If this part is provided, then the provided configuration is + used to process the document. If the `configuration_id` is also provided (both are present at the same time), + then request is rejected. The maximum supported configuration size is 1 MB. Configuration parts larger than 1 MB + are rejected. + See the `GET /configurations/{configuration_id}` operation for an example configuration. - parameter step: Specify to only run the input document through the given step instead of running the input document through the - entire ingestion workflow. Valid values are `convert`, `enrich`, and `normalize`. - - parameter configurationID: The ID of the configuration to use to process the document. If the `configuration` form part is also provided (both - are present at the same time), then request will be rejected. + entire ingestion workflow. Valid values are `convert`, `enrich`, and `normalize`. + - parameter configurationID: The ID of the configuration to use to process the document. If the `configuration` form part is also provided + (both are present at the same time), then request will be rejected. - parameter file: The content of the document to ingest. The maximum supported file size is 50 megabytes. Files larger than 50 - megabytes is rejected. + megabytes is rejected. - parameter metadata: If you're using the Data Crawler to upload your documents, you can test a document against the type of metadata - that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB - are rejected. Example: ``` { \"Creator\": \"Johnny Appleseed\", \"Subject\": \"Apples\" } ```. + that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 + MB are rejected. + Example: ``` { + \"Creator\": \"Johnny Appleseed\", + \"Subject\": \"Apples\" + } ```. - parameter fileContentType: The content type of file. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. @@ -1259,18 +1269,20 @@ public class Discovery { Create or update expansion list. Create or replace the Expansion list for this collection. The maximum number of expanded terms per collection is - `500`. The current expansion list is replaced with the uploaded content. + `500`. + The current expansion list is replaced with the uploaded content. - parameter environmentID: The ID of the environment. - parameter collectionID: The ID of the collection. - - parameter expansions: An array of query expansion definitions. Each object in the `expansions` array represents a term or set of terms - that will be expanded into other terms. Each expansion object can be configured so that all terms are expanded to - all other terms in the object - bi-directional, or a set list of terms can be expanded into a second list of terms - - uni-directional. To create a bi-directional expansion specify an `expanded_terms` array. When found in a query, - all items in the `expanded_terms` array are then expanded to the other items in the same array. To create a - uni-directional expansion, specify both an array of `input_terms` and an array of `expanded_terms`. When items in - the `input_terms` array are present in a query, they are expanded using the items listed in the `expanded_terms` - array. + - parameter expansions: An array of query expansion definitions. + Each object in the `expansions` array represents a term or set of terms that will be expanded into other terms. + Each expansion object can be configured so that all terms are expanded to all other terms in the object - + bi-directional, or a set list of terms can be expanded into a second list of terms - uni-directional. + To create a bi-directional expansion specify an `expanded_terms` array. When found in a query, all items in the + `expanded_terms` array are then expanded to the other items in the same array. + To create a uni-directional expansion, specify both an array of `input_terms` and an array of `expanded_terms`. + When items in the `input_terms` array are present in a query, they are expanded using the items listed in the + `expanded_terms` array. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1384,24 +1396,30 @@ public class Discovery { /** Add a document. - Add a document to a collection with optional metadata. * The `version` query parameter is still required. * - Returns immediately after the system has accepted the document for processing. * The user must provide document - content, metadata, or both. If the request is missing both document content and metadata, it is rejected. * The - user can set the `Content-Type` parameter on the `file` part to indicate the media type of the document. If the - `Content-Type` parameter is missing or is one of the generic media types (for example, `application/octet-stream`), - then the service attempts to automatically detect the document's media type. * The following field names are - reserved and will be filtered out if present after normalization: `id`, `score`, `highlight`, and any field with - the prefix of: `_`, `+`, or `-` * Fields with empty name values after normalization are filtered out before - indexing. * Fields containing the following characters after normalization are filtered out before indexing: `#` - and `,`. + Add a document to a collection with optional metadata. + * The `version` query parameter is still required. + * Returns immediately after the system has accepted the document for processing. + * The user must provide document content, metadata, or both. If the request is missing both document content and + metadata, it is rejected. + * The user can set the `Content-Type` parameter on the `file` part to indicate the media type of the document. If + the `Content-Type` parameter is missing or is one of the generic media types (for example, + `application/octet-stream`), then the service attempts to automatically detect the document's media type. + * The following field names are reserved and will be filtered out if present after normalization: `id`, `score`, + `highlight`, and any field with the prefix of: `_`, `+`, or `-` + * Fields with empty name values after normalization are filtered out before indexing. + * Fields containing the following characters after normalization are filtered out before indexing: `#` and `,`. - parameter environmentID: The ID of the environment. - parameter collectionID: The ID of the collection. - parameter file: The content of the document to ingest. The maximum supported file size is 50 megabytes. Files larger than 50 - megabytes is rejected. + megabytes is rejected. - parameter metadata: If you're using the Data Crawler to upload your documents, you can test a document against the type of metadata - that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB - are rejected. Example: ``` { \"Creator\": \"Johnny Appleseed\", \"Subject\": \"Apples\" } ```. + that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 + MB are rejected. + Example: ``` { + \"Creator\": \"Johnny Appleseed\", + \"Subject\": \"Apples\" + } ```. - parameter fileContentType: The content type of file. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. @@ -1537,10 +1555,14 @@ public class Discovery { - parameter collectionID: The ID of the collection. - parameter documentID: The ID of the document. - parameter file: The content of the document to ingest. The maximum supported file size is 50 megabytes. Files larger than 50 - megabytes is rejected. + megabytes is rejected. - parameter metadata: If you're using the Data Crawler to upload your documents, you can test a document against the type of metadata - that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB - are rejected. Example: ``` { \"Creator\": \"Johnny Appleseed\", \"Subject\": \"Apples\" } ```. + that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 + MB are rejected. + Example: ``` { + \"Creator\": \"Johnny Appleseed\", + \"Subject\": \"Apples\" + } ```. - parameter fileContentType: The content type of file. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. @@ -1676,47 +1698,47 @@ public class Discovery { - parameter environmentID: The ID of the environment. - parameter collectionID: The ID of the collection. - - parameter filter: A cacheable query that limits the documents returned to exclude any documents that don't mention the query content. - Filter searches are better for metadata type searches and when you are trying to get a sense of concepts in the - data set. + - parameter filter: A cacheable query that limits the documents returned to exclude any documents that don't mention the query + content. Filter searches are better for metadata type searches and when you are trying to get a sense of concepts + in the data set. - parameter query: A query search returns all documents in your data set with full enrichments and full text, but with the most - relevant documents listed first. Use a query search when you want to find the most relevant search results. You - cannot use `natural_language_query` and `query` at the same time. + relevant documents listed first. Use a query search when you want to find the most relevant search results. You + cannot use `natural_language_query` and `query` at the same time. - parameter naturalLanguageQuery: A natural language query that returns relevant documents by utilizing training data and natural language - understanding. You cannot use `natural_language_query` and `query` at the same time. + understanding. You cannot use `natural_language_query` and `query` at the same time. - parameter passages: A passages query that returns the most relevant passages from the results. - parameter aggregation: An aggregation search uses combinations of filters and query search to return an exact answer. Aggregations are - useful for building applications, because you can use them to build lists, tables, and time series. For a full list - of possible aggregrations, see the Query reference. + useful for building applications, because you can use them to build lists, tables, and time series. For a full + list of possible aggregrations, see the Query reference. - parameter count: Number of documents to return. - parameter returnFields: A comma separated list of the portion of the document hierarchy to return. - - parameter offset: The number of query results to skip at the beginning. For example, if the total number of results that are returned - is 10, and the offset is 8, it returns the last two results. + - parameter offset: The number of query results to skip at the beginning. For example, if the total number of results that are + returned is 10, and the offset is 8, it returns the last two results. - parameter sort: A comma separated list of fields in the document to sort on. You can optionally specify a sort direction by - prefixing the field with `-` for descending or `+` for ascending. Ascending is the default sort direction if no - prefix is specified. + prefixing the field with `-` for descending or `+` for ascending. Ascending is the default sort direction if no + prefix is specified. - parameter highlight: When true a highlight field is returned for each result which contains the fields that match the query with - `` tags around the matching query terms. Defaults to false. - - parameter passagesFields: A comma-separated list of fields that passages are drawn from. If this parameter not specified, then all top-level - fields are included. + `` tags around the matching query terms. Defaults to false. + - parameter passagesFields: A comma-separated list of fields that passages are drawn from. If this parameter not specified, then all + top-level fields are included. - parameter passagesCount: The maximum number of passages to return. The search returns fewer passages if the requested total is not found. - The default is `10`. The maximum is `100`. - - parameter passagesCharacters: The approximate number of characters that any one passage will have. The default is `400`. The minimum is `50`. The - maximum is `2000`. + The default is `10`. The maximum is `100`. + - parameter passagesCharacters: The approximate number of characters that any one passage will have. The default is `400`. The minimum is `50`. + The maximum is `2000`. - parameter deduplicate: When `true` and used with a Watson Discovery News collection, duplicate results (based on the contents of the - `title` field) are removed. Duplicate comparison is limited to the current query only, `offset` is not considered. - Defaults to `false`. This parameter is currently Beta functionality. + `title` field) are removed. Duplicate comparison is limited to the current query only, `offset` is not + considered. Defaults to `false`. This parameter is currently Beta functionality. - parameter deduplicateField: When specified, duplicate results based on the field specified are removed from the returned results. Duplicate - comparison is limited to the current query only, `offset` is not considered. This parameter is currently Beta - functionality. + comparison is limited to the current query only, `offset` is not considered. This parameter is currently Beta + functionality. - parameter similar: When `true`, results are returned based on their similarity to the document IDs specified in the - `similar.document_ids` parameter. The default is `false`. - - parameter similarDocumentIds: A comma-separated list of document IDs that will be used to find similar documents. **Note:** If the - `natural_language_query` parameter is also specified, it will be used to expand the scope of the document - similarity search to include the natural language query. Other query parameters, such as `filter` and `query` are - subsequently applied and reduce the query scope. - - parameter similarFields: A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If - not specified, the entire document is used for comparison. + `similar.document_ids` parameter. The default is `false`. + - parameter similarDocumentIds: A comma-separated list of document IDs that will be used to find similar documents. + **Note:** If the `natural_language_query` parameter is also specified, it will be used to expand the scope of the + document similarity search to include the natural language query. Other query parameters, such as `filter` and + `query` are subsequently applied and reduce the query scope. + - parameter similarFields: A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. + If not specified, the entire document is used for comparison. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1863,44 +1885,44 @@ public class Discovery { - parameter environmentID: The ID of the environment. - parameter collectionID: The ID of the collection. - - parameter filter: A cacheable query that limits the documents returned to exclude any documents that don't mention the query content. - Filter searches are better for metadata type searches and when you are trying to get a sense of concepts in the - data set. + - parameter filter: A cacheable query that limits the documents returned to exclude any documents that don't mention the query + content. Filter searches are better for metadata type searches and when you are trying to get a sense of concepts + in the data set. - parameter query: A query search returns all documents in your data set with full enrichments and full text, but with the most - relevant documents listed first. Use a query search when you want to find the most relevant search results. You - cannot use `natural_language_query` and `query` at the same time. + relevant documents listed first. Use a query search when you want to find the most relevant search results. You + cannot use `natural_language_query` and `query` at the same time. - parameter naturalLanguageQuery: A natural language query that returns relevant documents by utilizing training data and natural language - understanding. You cannot use `natural_language_query` and `query` at the same time. + understanding. You cannot use `natural_language_query` and `query` at the same time. - parameter passages: A passages query that returns the most relevant passages from the results. - parameter aggregation: An aggregation search uses combinations of filters and query search to return an exact answer. Aggregations are - useful for building applications, because you can use them to build lists, tables, and time series. For a full list - of possible aggregrations, see the Query reference. + useful for building applications, because you can use them to build lists, tables, and time series. For a full + list of possible aggregrations, see the Query reference. - parameter count: Number of documents to return. - parameter returnFields: A comma separated list of the portion of the document hierarchy to return. - - parameter offset: The number of query results to skip at the beginning. For example, if the total number of results that are returned - is 10, and the offset is 8, it returns the last two results. + - parameter offset: The number of query results to skip at the beginning. For example, if the total number of results that are + returned is 10, and the offset is 8, it returns the last two results. - parameter sort: A comma separated list of fields in the document to sort on. You can optionally specify a sort direction by - prefixing the field with `-` for descending or `+` for ascending. Ascending is the default sort direction if no - prefix is specified. + prefixing the field with `-` for descending or `+` for ascending. Ascending is the default sort direction if no + prefix is specified. - parameter highlight: When true a highlight field is returned for each result which contains the fields that match the query with - `` tags around the matching query terms. Defaults to false. - - parameter passagesFields: A comma-separated list of fields that passages are drawn from. If this parameter not specified, then all top-level - fields are included. + `` tags around the matching query terms. Defaults to false. + - parameter passagesFields: A comma-separated list of fields that passages are drawn from. If this parameter not specified, then all + top-level fields are included. - parameter passagesCount: The maximum number of passages to return. The search returns fewer passages if the requested total is not found. - The default is `10`. The maximum is `100`. - - parameter passagesCharacters: The approximate number of characters that any one passage will have. The default is `400`. The minimum is `50`. The - maximum is `2000`. + The default is `10`. The maximum is `100`. + - parameter passagesCharacters: The approximate number of characters that any one passage will have. The default is `400`. The minimum is `50`. + The maximum is `2000`. - parameter deduplicateField: When specified, duplicate results based on the field specified are removed from the returned results. Duplicate - comparison is limited to the current query only, `offset` is not considered. This parameter is currently Beta - functionality. + comparison is limited to the current query only, `offset` is not considered. This parameter is currently Beta + functionality. - parameter similar: When `true`, results are returned based on their similarity to the document IDs specified in the - `similar.document_ids` parameter. The default is `false`. - - parameter similarDocumentIds: A comma-separated list of document IDs that will be used to find similar documents. **Note:** If the - `natural_language_query` parameter is also specified, it will be used to expand the scope of the document - similarity search to include the natural language query. Other query parameters, such as `filter` and `query` are - subsequently applied and reduce the query scope. - - parameter similarFields: A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If - not specified, the entire document is used for comparison. + `similar.document_ids` parameter. The default is `false`. + - parameter similarDocumentIds: A comma-separated list of document IDs that will be used to find similar documents. + **Note:** If the `natural_language_query` parameter is also specified, it will be used to expand the scope of the + document similarity search to include the natural language query. Other query parameters, such as `filter` and + `query` are subsequently applied and reduce the query scope. + - parameter similarFields: A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. + If not specified, the entire document is used for comparison. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2040,40 +2062,40 @@ public class Discovery { - parameter environmentID: The ID of the environment. - parameter collectionIds: A comma-separated list of collection IDs to be queried against. - - parameter filter: A cacheable query that limits the documents returned to exclude any documents that don't mention the query content. - Filter searches are better for metadata type searches and when you are trying to get a sense of concepts in the - data set. + - parameter filter: A cacheable query that limits the documents returned to exclude any documents that don't mention the query + content. Filter searches are better for metadata type searches and when you are trying to get a sense of concepts + in the data set. - parameter query: A query search returns all documents in your data set with full enrichments and full text, but with the most - relevant documents listed first. Use a query search when you want to find the most relevant search results. You - cannot use `natural_language_query` and `query` at the same time. + relevant documents listed first. Use a query search when you want to find the most relevant search results. You + cannot use `natural_language_query` and `query` at the same time. - parameter naturalLanguageQuery: A natural language query that returns relevant documents by utilizing training data and natural language - understanding. You cannot use `natural_language_query` and `query` at the same time. + understanding. You cannot use `natural_language_query` and `query` at the same time. - parameter aggregation: An aggregation search uses combinations of filters and query search to return an exact answer. Aggregations are - useful for building applications, because you can use them to build lists, tables, and time series. For a full list - of possible aggregrations, see the Query reference. + useful for building applications, because you can use them to build lists, tables, and time series. For a full + list of possible aggregrations, see the Query reference. - parameter count: Number of documents to return. - parameter returnFields: A comma separated list of the portion of the document hierarchy to return. - - parameter offset: The number of query results to skip at the beginning. For example, if the total number of results that are returned - is 10, and the offset is 8, it returns the last two results. + - parameter offset: The number of query results to skip at the beginning. For example, if the total number of results that are + returned is 10, and the offset is 8, it returns the last two results. - parameter sort: A comma separated list of fields in the document to sort on. You can optionally specify a sort direction by - prefixing the field with `-` for descending or `+` for ascending. Ascending is the default sort direction if no - prefix is specified. + prefixing the field with `-` for descending or `+` for ascending. Ascending is the default sort direction if no + prefix is specified. - parameter highlight: When true a highlight field is returned for each result which contains the fields that match the query with - `` tags around the matching query terms. Defaults to false. + `` tags around the matching query terms. Defaults to false. - parameter deduplicate: When `true` and used with a Watson Discovery News collection, duplicate results (based on the contents of the - `title` field) are removed. Duplicate comparison is limited to the current query only, `offset` is not considered. - Defaults to `false`. This parameter is currently Beta functionality. + `title` field) are removed. Duplicate comparison is limited to the current query only, `offset` is not + considered. Defaults to `false`. This parameter is currently Beta functionality. - parameter deduplicateField: When specified, duplicate results based on the field specified are removed from the returned results. Duplicate - comparison is limited to the current query only, `offset` is not considered. This parameter is currently Beta - functionality. + comparison is limited to the current query only, `offset` is not considered. This parameter is currently Beta + functionality. - parameter similar: When `true`, results are returned based on their similarity to the document IDs specified in the - `similar.document_ids` parameter. The default is `false`. - - parameter similarDocumentIds: A comma-separated list of document IDs that will be used to find similar documents. **Note:** If the - `natural_language_query` parameter is also specified, it will be used to expand the scope of the document - similarity search to include the natural language query. Other query parameters, such as `filter` and `query` are - subsequently applied and reduce the query scope. - - parameter similarFields: A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If - not specified, the entire document is used for comparison. + `similar.document_ids` parameter. The default is `false`. + - parameter similarDocumentIds: A comma-separated list of document IDs that will be used to find similar documents. + **Note:** If the `natural_language_query` parameter is also specified, it will be used to expand the scope of the + document similarity search to include the natural language query. Other query parameters, such as `filter` and + `query` are subsequently applied and reduce the query scope. + - parameter similarFields: A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. + If not specified, the entire document is used for comparison. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2201,37 +2223,37 @@ public class Discovery { - parameter environmentID: The ID of the environment. - parameter collectionIds: A comma-separated list of collection IDs to be queried against. - - parameter filter: A cacheable query that limits the documents returned to exclude any documents that don't mention the query content. - Filter searches are better for metadata type searches and when you are trying to get a sense of concepts in the - data set. + - parameter filter: A cacheable query that limits the documents returned to exclude any documents that don't mention the query + content. Filter searches are better for metadata type searches and when you are trying to get a sense of concepts + in the data set. - parameter query: A query search returns all documents in your data set with full enrichments and full text, but with the most - relevant documents listed first. Use a query search when you want to find the most relevant search results. You - cannot use `natural_language_query` and `query` at the same time. + relevant documents listed first. Use a query search when you want to find the most relevant search results. You + cannot use `natural_language_query` and `query` at the same time. - parameter naturalLanguageQuery: A natural language query that returns relevant documents by utilizing training data and natural language - understanding. You cannot use `natural_language_query` and `query` at the same time. + understanding. You cannot use `natural_language_query` and `query` at the same time. - parameter aggregation: An aggregation search uses combinations of filters and query search to return an exact answer. Aggregations are - useful for building applications, because you can use them to build lists, tables, and time series. For a full list - of possible aggregrations, see the Query reference. + useful for building applications, because you can use them to build lists, tables, and time series. For a full + list of possible aggregrations, see the Query reference. - parameter count: Number of documents to return. - parameter returnFields: A comma separated list of the portion of the document hierarchy to return. - - parameter offset: The number of query results to skip at the beginning. For example, if the total number of results that are returned - is 10, and the offset is 8, it returns the last two results. + - parameter offset: The number of query results to skip at the beginning. For example, if the total number of results that are + returned is 10, and the offset is 8, it returns the last two results. - parameter sort: A comma separated list of fields in the document to sort on. You can optionally specify a sort direction by - prefixing the field with `-` for descending or `+` for ascending. Ascending is the default sort direction if no - prefix is specified. + prefixing the field with `-` for descending or `+` for ascending. Ascending is the default sort direction if no + prefix is specified. - parameter highlight: When true a highlight field is returned for each result which contains the fields that match the query with - `` tags around the matching query terms. Defaults to false. + `` tags around the matching query terms. Defaults to false. - parameter deduplicateField: When specified, duplicate results based on the field specified are removed from the returned results. Duplicate - comparison is limited to the current query only, `offset` is not considered. This parameter is currently Beta - functionality. + comparison is limited to the current query only, `offset` is not considered. This parameter is currently Beta + functionality. - parameter similar: When `true`, results are returned based on their similarity to the document IDs specified in the - `similar.document_ids` parameter. The default is `false`. - - parameter similarDocumentIds: A comma-separated list of document IDs that will be used to find similar documents. **Note:** If the - `natural_language_query` parameter is also specified, it will be used to expand the scope of the document - similarity search to include the natural language query. Other query parameters, such as `filter` and `query` are - subsequently applied and reduce the query scope. - - parameter similarFields: A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If - not specified, the entire document is used for comparison. + `similar.document_ids` parameter. The default is `false`. + - parameter similarDocumentIds: A comma-separated list of document IDs that will be used to find similar documents. + **Note:** If the `natural_language_query` parameter is also specified, it will be used to expand the scope of the + document similarity search to include the natural language query. Other query parameters, such as `filter` and + `query` are subsequently applied and reduce the query scope. + - parameter similarFields: A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. + If not specified, the entire document is used for comparison. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -3069,8 +3091,9 @@ public class Discovery { Delete labeled data. Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with - the customer ID. You associate a customer ID with data by passing the **X-Watson-Metadata** header with a request - that passes data. For more information about personal data and customer IDs, see [Information + the customer ID. + You associate a customer ID with data by passing the **X-Watson-Metadata** header with a request that passes data. + For more information about personal data and customer IDs, see [Information security](https://console.bluemix.net/docs/services/discovery/information-security.html). - parameter customerID: The customer ID for which all data is to be deleted. diff --git a/Source/DiscoveryV1/Models/AggregationResult.swift b/Source/DiscoveryV1/Models/AggregationResult.swift index 2acdfd033..de645e226 100644 --- a/Source/DiscoveryV1/Models/AggregationResult.swift +++ b/Source/DiscoveryV1/Models/AggregationResult.swift @@ -19,13 +19,19 @@ import Foundation /** AggregationResult. */ public struct AggregationResult: Decodable { - /// Key that matched the aggregation type. + /** + Key that matched the aggregation type. + */ public var key: String? - /// Number of matching results. + /** + Number of matching results. + */ public var matchingResults: Int? - /// Aggregations returned in the case of chained aggregations. + /** + Aggregations returned in the case of chained aggregations. + */ public var aggregations: [QueryAggregation]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/Calculation.swift b/Source/DiscoveryV1/Models/Calculation.swift index d5f88eebe..c3f63c1c4 100644 --- a/Source/DiscoveryV1/Models/Calculation.swift +++ b/Source/DiscoveryV1/Models/Calculation.swift @@ -19,21 +19,31 @@ import Foundation /** Calculation. */ public struct Calculation: Decodable { - /// The type of aggregation command used. For example: term, filter, max, min, etc. + /** + The type of aggregation command used. For example: term, filter, max, min, etc. + */ public var type: String? public var results: [AggregationResult]? - /// Number of matching results. + /** + Number of matching results. + */ public var matchingResults: Int? - /// Aggregations returned by the Discovery service. + /** + Aggregations returned by the Discovery service. + */ public var aggregations: [QueryAggregation]? - /// The field where the aggregation is located in the document. + /** + The field where the aggregation is located in the document. + */ public var field: String? - /// Value of the aggregation. + /** + Value of the aggregation. + */ public var value: Double? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/Collection.swift b/Source/DiscoveryV1/Models/Collection.swift index c30723eea..9af0b3565 100644 --- a/Source/DiscoveryV1/Models/Collection.swift +++ b/Source/DiscoveryV1/Models/Collection.swift @@ -19,44 +19,71 @@ import Foundation /** A collection for storing documents. */ public struct Collection: Decodable { - /// The status of the collection. + /** + The status of the collection. + */ public enum Status: String { case active = "active" case pending = "pending" case maintenance = "maintenance" } - /// The unique identifier of the collection. + /** + The unique identifier of the collection. + */ public var collectionID: String? - /// The name of the collection. + /** + The name of the collection. + */ public var name: String? - /// The description of the collection. + /** + The description of the collection. + */ public var description: String? - /// The creation date of the collection in the format yyyy-MM-dd'T'HH:mmcon:ss.SSS'Z'. + /** + The creation date of the collection in the format yyyy-MM-dd'T'HH:mmcon:ss.SSS'Z'. + */ public var created: String? - /// The timestamp of when the collection was last updated in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. + /** + The timestamp of when the collection was last updated in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. + */ public var updated: String? - /// The status of the collection. + /** + The status of the collection. + */ public var status: String? - /// The unique identifier of the collection's configuration. + /** + The unique identifier of the collection's configuration. + */ public var configurationID: String? - /// The language of the documents stored in the collection. Permitted values include `en` (English), `de` (German), and `es` (Spanish). + /** + The language of the documents stored in the collection. Permitted values include `en` (English), `de` (German), and + `es` (Spanish). + */ public var language: String? - /// The object providing information about the documents in the collection. Present only when retrieving details of a collection. + /** + The object providing information about the documents in the collection. Present only when retrieving details of a + collection. + */ public var documentCounts: DocumentCounts? - /// The object providing information about the disk usage of the collection. Present only when retrieving details of a collection. + /** + The object providing information about the disk usage of the collection. Present only when retrieving details of a + collection. + */ public var diskUsage: CollectionDiskUsage? - /// Provides information about the status of relevance training for collection. + /** + Provides information about the status of relevance training for collection. + */ public var trainingStatus: TrainingStatus? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/CollectionDiskUsage.swift b/Source/DiscoveryV1/Models/CollectionDiskUsage.swift index 02e81af67..b17907b16 100644 --- a/Source/DiscoveryV1/Models/CollectionDiskUsage.swift +++ b/Source/DiscoveryV1/Models/CollectionDiskUsage.swift @@ -19,7 +19,9 @@ import Foundation /** Summary of the disk usage statistics for this collection. */ public struct CollectionDiskUsage: Decodable { - /// Number of bytes used by the collection. + /** + Number of bytes used by the collection. + */ public var usedBytes: Int? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/CollectionUsage.swift b/Source/DiscoveryV1/Models/CollectionUsage.swift index 05edea7c3..0997cae58 100644 --- a/Source/DiscoveryV1/Models/CollectionUsage.swift +++ b/Source/DiscoveryV1/Models/CollectionUsage.swift @@ -19,10 +19,14 @@ import Foundation /** Summary of the collection usage in the environment. */ public struct CollectionUsage: Decodable { - /// Number of active collections in the environment. + /** + Number of active collections in the environment. + */ public var available: Int? - /// Total number of collections allowed in the environment. + /** + Total number of collections allowed in the environment. + */ public var maximumAllowed: Int? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/Configuration.swift b/Source/DiscoveryV1/Models/Configuration.swift index aa688eab1..788f71ae5 100644 --- a/Source/DiscoveryV1/Models/Configuration.swift +++ b/Source/DiscoveryV1/Models/Configuration.swift @@ -19,28 +19,45 @@ import Foundation /** A custom configuration for the environment. */ public struct Configuration: Codable { - /// The unique identifier of the configuration. + /** + The unique identifier of the configuration. + */ public var configurationID: String? - /// The name of the configuration. + /** + The name of the configuration. + */ public var name: String - /// The creation date of the configuration in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. + /** + The creation date of the configuration in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. + */ public var created: String? - /// The timestamp of when the configuration was last updated in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. + /** + The timestamp of when the configuration was last updated in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. + */ public var updated: String? - /// The description of the configuration, if available. + /** + The description of the configuration, if available. + */ public var description: String? - /// The document conversion settings for the configuration. + /** + The document conversion settings for the configuration. + */ public var conversions: Conversions? - /// An array of document enrichment settings for the configuration. + /** + An array of document enrichment settings for the configuration. + */ public var enrichments: [Enrichment]? - /// Defines operations that can be used to transform the final output JSON into a normalized form. Operations are executed in the order that they appear in the array. + /** + Defines operations that can be used to transform the final output JSON into a normalized form. Operations are + executed in the order that they appear in the array. + */ public var normalizations: [NormalizationOperation]? // Map each property name to the key that shall be used for encoding/decoding. @@ -65,11 +82,22 @@ public struct Configuration: Codable { - parameter description: The description of the configuration, if available. - parameter conversions: The document conversion settings for the configuration. - parameter enrichments: An array of document enrichment settings for the configuration. - - parameter normalizations: Defines operations that can be used to transform the final output JSON into a normalized form. Operations are executed in the order that they appear in the array. + - parameter normalizations: Defines operations that can be used to transform the final output JSON into a normalized form. Operations are + executed in the order that they appear in the array. - returns: An initialized `Configuration`. */ - public init(name: String, configurationID: String? = nil, created: String? = nil, updated: String? = nil, description: String? = nil, conversions: Conversions? = nil, enrichments: [Enrichment]? = nil, normalizations: [NormalizationOperation]? = nil) { + public init( + name: String, + configurationID: String? = nil, + created: String? = nil, + updated: String? = nil, + description: String? = nil, + conversions: Conversions? = nil, + enrichments: [Enrichment]? = nil, + normalizations: [NormalizationOperation]? = nil + ) + { self.name = name self.configurationID = configurationID self.created = created diff --git a/Source/DiscoveryV1/Models/Conversions.swift b/Source/DiscoveryV1/Models/Conversions.swift index 31a5f8980..bcc6eaabd 100644 --- a/Source/DiscoveryV1/Models/Conversions.swift +++ b/Source/DiscoveryV1/Models/Conversions.swift @@ -19,19 +19,30 @@ import Foundation /** Document conversion settings. */ public struct Conversions: Codable { - /// A list of PDF conversion settings. + /** + A list of PDF conversion settings. + */ public var pdf: PdfSettings? - /// A list of Word conversion settings. + /** + A list of Word conversion settings. + */ public var word: WordSettings? - /// A list of HTML conversion settings. + /** + A list of HTML conversion settings. + */ public var html: HtmlSettings? - /// A list of Document Segmentation settings. + /** + A list of Document Segmentation settings. + */ public var segment: SegmentSettings? - /// Defines operations that can be used to transform the final output JSON into a normalized form. Operations are executed in the order that they appear in the array. + /** + Defines operations that can be used to transform the final output JSON into a normalized form. Operations are + executed in the order that they appear in the array. + */ public var jsonNormalizations: [NormalizationOperation]? // Map each property name to the key that shall be used for encoding/decoding. @@ -50,11 +61,19 @@ public struct Conversions: Codable { - parameter word: A list of Word conversion settings. - parameter html: A list of HTML conversion settings. - parameter segment: A list of Document Segmentation settings. - - parameter jsonNormalizations: Defines operations that can be used to transform the final output JSON into a normalized form. Operations are executed in the order that they appear in the array. + - parameter jsonNormalizations: Defines operations that can be used to transform the final output JSON into a normalized form. Operations are + executed in the order that they appear in the array. - returns: An initialized `Conversions`. */ - public init(pdf: PdfSettings? = nil, word: WordSettings? = nil, html: HtmlSettings? = nil, segment: SegmentSettings? = nil, jsonNormalizations: [NormalizationOperation]? = nil) { + public init( + pdf: PdfSettings? = nil, + word: WordSettings? = nil, + html: HtmlSettings? = nil, + segment: SegmentSettings? = nil, + jsonNormalizations: [NormalizationOperation]? = nil + ) + { self.pdf = pdf self.word = word self.html = html diff --git a/Source/DiscoveryV1/Models/CreateCollectionRequest.swift b/Source/DiscoveryV1/Models/CreateCollectionRequest.swift index 8277cd54a..9d6568b7c 100644 --- a/Source/DiscoveryV1/Models/CreateCollectionRequest.swift +++ b/Source/DiscoveryV1/Models/CreateCollectionRequest.swift @@ -19,7 +19,9 @@ import Foundation /** CreateCollectionRequest. */ public struct CreateCollectionRequest: Encodable { - /// The language of the documents stored in the collection, in the form of an ISO 639-1 language code. + /** + The language of the documents stored in the collection, in the form of an ISO 639-1 language code. + */ public enum Language: String { case en = "en" case es = "es" @@ -32,16 +34,24 @@ public struct CreateCollectionRequest: Encodable { case pt = "pt" } - /// The name of the collection to be created. + /** + The name of the collection to be created. + */ public var name: String - /// A description of the collection. + /** + A description of the collection. + */ public var description: String? - /// The ID of the configuration in which the collection is to be created. + /** + The ID of the configuration in which the collection is to be created. + */ public var configurationID: String? - /// The language of the documents stored in the collection, in the form of an ISO 639-1 language code. + /** + The language of the documents stored in the collection, in the form of an ISO 639-1 language code. + */ public var language: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -62,7 +72,13 @@ public struct CreateCollectionRequest: Encodable { - returns: An initialized `CreateCollectionRequest`. */ - public init(name: String, description: String? = nil, configurationID: String? = nil, language: String? = nil) { + public init( + name: String, + description: String? = nil, + configurationID: String? = nil, + language: String? = nil + ) + { self.name = name self.description = description self.configurationID = configurationID diff --git a/Source/DiscoveryV1/Models/CreateEnvironmentRequest.swift b/Source/DiscoveryV1/Models/CreateEnvironmentRequest.swift index 2ac910153..41dc1d866 100644 --- a/Source/DiscoveryV1/Models/CreateEnvironmentRequest.swift +++ b/Source/DiscoveryV1/Models/CreateEnvironmentRequest.swift @@ -19,13 +19,19 @@ import Foundation /** CreateEnvironmentRequest. */ internal struct CreateEnvironmentRequest: Encodable { - /// Name that identifies the environment. + /** + Name that identifies the environment. + */ public var name: String - /// Description of the environment. + /** + Description of the environment. + */ public var description: String? - /// **Deprecated**: Size of the environment. + /** + **Deprecated**: Size of the environment. + */ public var size: Int? // Map each property name to the key that shall be used for encoding/decoding. @@ -44,7 +50,12 @@ internal struct CreateEnvironmentRequest: Encodable { - returns: An initialized `CreateEnvironmentRequest`. */ - public init(name: String, description: String? = nil, size: Int? = nil) { + public init( + name: String, + description: String? = nil, + size: Int? = nil + ) + { self.name = name self.description = description self.size = size diff --git a/Source/DiscoveryV1/Models/DeleteCollectionResponse.swift b/Source/DiscoveryV1/Models/DeleteCollectionResponse.swift index 29c5d2e17..e409b3798 100644 --- a/Source/DiscoveryV1/Models/DeleteCollectionResponse.swift +++ b/Source/DiscoveryV1/Models/DeleteCollectionResponse.swift @@ -19,15 +19,21 @@ import Foundation /** DeleteCollectionResponse. */ public struct DeleteCollectionResponse: Decodable { - /// The status of the collection. The status of a successful deletion operation is `deleted`. + /** + The status of the collection. The status of a successful deletion operation is `deleted`. + */ public enum Status: String { case deleted = "deleted" } - /// The unique identifier of the collection that is being deleted. + /** + The unique identifier of the collection that is being deleted. + */ public var collectionID: String - /// The status of the collection. The status of a successful deletion operation is `deleted`. + /** + The status of the collection. The status of a successful deletion operation is `deleted`. + */ public var status: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/DeleteConfigurationResponse.swift b/Source/DiscoveryV1/Models/DeleteConfigurationResponse.swift index cac6cb37c..f0b63a08b 100644 --- a/Source/DiscoveryV1/Models/DeleteConfigurationResponse.swift +++ b/Source/DiscoveryV1/Models/DeleteConfigurationResponse.swift @@ -19,18 +19,26 @@ import Foundation /** DeleteConfigurationResponse. */ public struct DeleteConfigurationResponse: Decodable { - /// Status of the configuration. A deleted configuration has the status deleted. + /** + Status of the configuration. A deleted configuration has the status deleted. + */ public enum Status: String { case deleted = "deleted" } - /// The unique identifier for the configuration. + /** + The unique identifier for the configuration. + */ public var configurationID: String - /// Status of the configuration. A deleted configuration has the status deleted. + /** + Status of the configuration. A deleted configuration has the status deleted. + */ public var status: String - /// An array of notice messages, if any. + /** + An array of notice messages, if any. + */ public var notices: [Notice]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/DeleteDocumentResponse.swift b/Source/DiscoveryV1/Models/DeleteDocumentResponse.swift index 7cc15bca9..9ce45627b 100644 --- a/Source/DiscoveryV1/Models/DeleteDocumentResponse.swift +++ b/Source/DiscoveryV1/Models/DeleteDocumentResponse.swift @@ -19,15 +19,21 @@ import Foundation /** DeleteDocumentResponse. */ public struct DeleteDocumentResponse: Decodable { - /// Status of the document. A deleted document has the status deleted. + /** + Status of the document. A deleted document has the status deleted. + */ public enum Status: String { case deleted = "deleted" } - /// The unique identifier of the document. + /** + The unique identifier of the document. + */ public var documentID: String? - /// Status of the document. A deleted document has the status deleted. + /** + Status of the document. A deleted document has the status deleted. + */ public var status: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/DeleteEnvironmentResponse.swift b/Source/DiscoveryV1/Models/DeleteEnvironmentResponse.swift index 3c698bd54..46e5efe9f 100644 --- a/Source/DiscoveryV1/Models/DeleteEnvironmentResponse.swift +++ b/Source/DiscoveryV1/Models/DeleteEnvironmentResponse.swift @@ -19,15 +19,21 @@ import Foundation /** DeleteEnvironmentResponse. */ public struct DeleteEnvironmentResponse: Decodable { - /// Status of the environment. + /** + Status of the environment. + */ public enum Status: String { case deleted = "deleted" } - /// The unique identifier for the environment. + /** + The unique identifier for the environment. + */ public var environmentID: String - /// Status of the environment. + /** + Status of the environment. + */ public var status: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/DiskUsage.swift b/Source/DiscoveryV1/Models/DiskUsage.swift index 057e7c492..3b8631a9d 100644 --- a/Source/DiscoveryV1/Models/DiskUsage.swift +++ b/Source/DiscoveryV1/Models/DiskUsage.swift @@ -19,22 +19,34 @@ import Foundation /** Summary of the disk usage statistics for the environment. */ public struct DiskUsage: Decodable { - /// Number of bytes used on the environment's disk capacity. + /** + Number of bytes used on the environment's disk capacity. + */ public var usedBytes: Int? - /// Total number of bytes available in the environment's disk capacity. + /** + Total number of bytes available in the environment's disk capacity. + */ public var maximumAllowedBytes: Int? - /// **Deprecated**: Total number of bytes available in the environment's disk capacity. + /** + **Deprecated**: Total number of bytes available in the environment's disk capacity. + */ public var totalBytes: Int? - /// **Deprecated**: Amount of disk capacity used, in KB or GB format. + /** + **Deprecated**: Amount of disk capacity used, in KB or GB format. + */ public var used: String? - /// **Deprecated**: Total amount of the environment's disk capacity, in KB or GB format. + /** + **Deprecated**: Total amount of the environment's disk capacity, in KB or GB format. + */ public var total: String? - /// **Deprecated**: Percentage of the environment's disk capacity that is being used. + /** + **Deprecated**: Percentage of the environment's disk capacity that is being used. + */ public var percentUsed: Double? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/DocumentAccepted.swift b/Source/DiscoveryV1/Models/DocumentAccepted.swift index 5d39fafc1..8a0f4d938 100644 --- a/Source/DiscoveryV1/Models/DocumentAccepted.swift +++ b/Source/DiscoveryV1/Models/DocumentAccepted.swift @@ -19,18 +19,26 @@ import Foundation /** DocumentAccepted. */ public struct DocumentAccepted: Decodable { - /// Status of the document in the ingestion process. + /** + Status of the document in the ingestion process. + */ public enum Status: String { case processing = "processing" } - /// The unique identifier of the ingested document. + /** + The unique identifier of the ingested document. + */ public var documentID: String? - /// Status of the document in the ingestion process. + /** + Status of the document in the ingestion process. + */ public var status: String? - /// Array of notices produced by the document-ingestion process. + /** + Array of notices produced by the document-ingestion process. + */ public var notices: [Notice]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/DocumentCounts.swift b/Source/DiscoveryV1/Models/DocumentCounts.swift index 842e2fcf9..2586f6446 100644 --- a/Source/DiscoveryV1/Models/DocumentCounts.swift +++ b/Source/DiscoveryV1/Models/DocumentCounts.swift @@ -19,13 +19,19 @@ import Foundation /** DocumentCounts. */ public struct DocumentCounts: Decodable { - /// The total number of available documents in the collection. + /** + The total number of available documents in the collection. + */ public var available: Int? - /// The number of documents in the collection that are currently being processed. + /** + The number of documents in the collection that are currently being processed. + */ public var processing: Int? - /// The number of documents in the collection that failed to be ingested. + /** + The number of documents in the collection that failed to be ingested. + */ public var failed: Int? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/DocumentStatus.swift b/Source/DiscoveryV1/Models/DocumentStatus.swift index 68f068dad..4b20221f1 100644 --- a/Source/DiscoveryV1/Models/DocumentStatus.swift +++ b/Source/DiscoveryV1/Models/DocumentStatus.swift @@ -19,7 +19,9 @@ import Foundation /** Status information about a submitted document. */ public struct DocumentStatus: Decodable { - /// Status of the document in the ingestion process. + /** + Status of the document in the ingestion process. + */ public enum Status: String { case available = "available" case availableWithNotices = "available with notices" @@ -27,7 +29,9 @@ public struct DocumentStatus: Decodable { case processing = "processing" } - /// The type of the original source file. + /** + The type of the original source file. + */ public enum FileType: String { case pdf = "pdf" case html = "html" @@ -35,34 +39,54 @@ public struct DocumentStatus: Decodable { case json = "json" } - /// The unique identifier of the document. + /** + The unique identifier of the document. + */ public var documentID: String - /// The unique identifier for the configuration. + /** + The unique identifier for the configuration. + */ public var configurationID: String? - /// The creation date of the document in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. + /** + The creation date of the document in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. + */ public var created: String? - /// Date of the most recent document update, in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. + /** + Date of the most recent document update, in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. + */ public var updated: String? - /// Status of the document in the ingestion process. + /** + Status of the document in the ingestion process. + */ public var status: String - /// Description of the document status. + /** + Description of the document status. + */ public var statusDescription: String - /// Name of the original source file (if available). + /** + Name of the original source file (if available). + */ public var filename: String? - /// The type of the original source file. + /** + The type of the original source file. + */ public var fileType: String? - /// The SHA-1 hash of the original source file (formatted as a hexadecimal string). + /** + The SHA-1 hash of the original source file (formatted as a hexadecimal string). + */ public var sha1: String? - /// Array of notices produced by the document-ingestion process. + /** + Array of notices produced by the document-ingestion process. + */ public var notices: [Notice] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/Enrichment.swift b/Source/DiscoveryV1/Models/Enrichment.swift index fc17f7764..0ff720944 100644 --- a/Source/DiscoveryV1/Models/Enrichment.swift +++ b/Source/DiscoveryV1/Models/Enrichment.swift @@ -19,25 +19,48 @@ import Foundation /** Enrichment. */ public struct Enrichment: Codable { - /// Describes what the enrichment step does. + /** + Describes what the enrichment step does. + */ public var description: String? - /// Field where enrichments will be stored. This field must already exist or be at most 1 level deeper than an existing field. For example, if `text` is a top-level field with no sub-fields, `text.foo` is a valid destination but `text.foo.bar` is not. + /** + Field where enrichments will be stored. This field must already exist or be at most 1 level deeper than an existing + field. For example, if `text` is a top-level field with no sub-fields, `text.foo` is a valid destination but + `text.foo.bar` is not. + */ public var destinationField: String - /// Field to be enriched. + /** + Field to be enriched. + */ public var sourceField: String - /// Indicates that the enrichments will overwrite the destination_field field if it already exists. + /** + Indicates that the enrichments will overwrite the destination_field field if it already exists. + */ public var overwrite: Bool? - /// Name of the enrichment service to call. Current options are `natural_language_understanding` and `elements`. When using `natual_language_understanding`, the `options` object must contain Natural Language Understanding Options. When using `elements` the `options` object must contain Element Classification options. Additionally, when using the `elements` enrichment the configuration specified and files ingested must meet all the criteria specified in [the documentation](https://console.bluemix.net/docs/services/discovery/element-classification.html) Previous API versions also supported `alchemy_language`. + /** + Name of the enrichment service to call. Current options are `natural_language_understanding` and `elements`. + When using `natual_language_understanding`, the `options` object must contain Natural Language Understanding + Options. + When using `elements` the `options` object must contain Element Classification options. Additionally, when using + the `elements` enrichment the configuration specified and files ingested must meet all the criteria specified in + [the documentation](https://console.bluemix.net/docs/services/discovery/element-classification.html) + Previous API versions also supported `alchemy_language`. + */ public var enrichmentName: String - /// If true, then most errors generated during the enrichment process will be treated as warnings and will not cause the document to fail processing. + /** + If true, then most errors generated during the enrichment process will be treated as warnings and will not cause + the document to fail processing. + */ public var ignoreDownstreamErrors: Bool? - /// A list of options specific to the enrichment. + /** + A list of options specific to the enrichment. + */ public var options: EnrichmentOptions? // Map each property name to the key that shall be used for encoding/decoding. @@ -54,17 +77,35 @@ public struct Enrichment: Codable { /** Initialize a `Enrichment` with member variables. - - parameter destinationField: Field where enrichments will be stored. This field must already exist or be at most 1 level deeper than an existing field. For example, if `text` is a top-level field with no sub-fields, `text.foo` is a valid destination but `text.foo.bar` is not. + - parameter destinationField: Field where enrichments will be stored. This field must already exist or be at most 1 level deeper than an + existing field. For example, if `text` is a top-level field with no sub-fields, `text.foo` is a valid destination + but `text.foo.bar` is not. - parameter sourceField: Field to be enriched. - - parameter enrichmentName: Name of the enrichment service to call. Current options are `natural_language_understanding` and `elements`. When using `natual_language_understanding`, the `options` object must contain Natural Language Understanding Options. When using `elements` the `options` object must contain Element Classification options. Additionally, when using the `elements` enrichment the configuration specified and files ingested must meet all the criteria specified in [the documentation](https://console.bluemix.net/docs/services/discovery/element-classification.html) Previous API versions also supported `alchemy_language`. + - parameter enrichmentName: Name of the enrichment service to call. Current options are `natural_language_understanding` and `elements`. + When using `natual_language_understanding`, the `options` object must contain Natural Language Understanding + Options. + When using `elements` the `options` object must contain Element Classification options. Additionally, when using + the `elements` enrichment the configuration specified and files ingested must meet all the criteria specified in + [the documentation](https://console.bluemix.net/docs/services/discovery/element-classification.html) + Previous API versions also supported `alchemy_language`. - parameter description: Describes what the enrichment step does. - parameter overwrite: Indicates that the enrichments will overwrite the destination_field field if it already exists. - - parameter ignoreDownstreamErrors: If true, then most errors generated during the enrichment process will be treated as warnings and will not cause the document to fail processing. + - parameter ignoreDownstreamErrors: If true, then most errors generated during the enrichment process will be treated as warnings and will not cause + the document to fail processing. - parameter options: A list of options specific to the enrichment. - returns: An initialized `Enrichment`. */ - public init(destinationField: String, sourceField: String, enrichmentName: String, description: String? = nil, overwrite: Bool? = nil, ignoreDownstreamErrors: Bool? = nil, options: EnrichmentOptions? = nil) { + public init( + destinationField: String, + sourceField: String, + enrichmentName: String, + description: String? = nil, + overwrite: Bool? = nil, + ignoreDownstreamErrors: Bool? = nil, + options: EnrichmentOptions? = nil + ) + { self.destinationField = destinationField self.sourceField = sourceField self.enrichmentName = enrichmentName diff --git a/Source/DiscoveryV1/Models/EnrichmentOptions.swift b/Source/DiscoveryV1/Models/EnrichmentOptions.swift index 8b6abf487..5259c5a79 100644 --- a/Source/DiscoveryV1/Models/EnrichmentOptions.swift +++ b/Source/DiscoveryV1/Models/EnrichmentOptions.swift @@ -19,10 +19,14 @@ import Foundation /** Options which are specific to a particular enrichment. */ public struct EnrichmentOptions: Codable { - /// An object representing the enrichment features that will be applied to the specified field. + /** + An object representing the enrichment features that will be applied to the specified field. + */ public var features: NluEnrichmentFeatures? - /// *For use with `elements` enrichments only.* The element extraction model to use. Models available are: `contract`. + /** + *For use with `elements` enrichments only.* The element extraction model to use. Models available are: `contract`. + */ public var model: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -35,11 +39,16 @@ public struct EnrichmentOptions: Codable { Initialize a `EnrichmentOptions` with member variables. - parameter features: An object representing the enrichment features that will be applied to the specified field. - - parameter model: *For use with `elements` enrichments only.* The element extraction model to use. Models available are: `contract`. + - parameter model: *For use with `elements` enrichments only.* The element extraction model to use. Models available are: + `contract`. - returns: An initialized `EnrichmentOptions`. */ - public init(features: NluEnrichmentFeatures? = nil, model: String? = nil) { + public init( + features: NluEnrichmentFeatures? = nil, + model: String? = nil + ) + { self.features = features self.model = model } diff --git a/Source/DiscoveryV1/Models/Environment.swift b/Source/DiscoveryV1/Models/Environment.swift index ea38cda0c..d36966a80 100644 --- a/Source/DiscoveryV1/Models/Environment.swift +++ b/Source/DiscoveryV1/Models/Environment.swift @@ -19,38 +19,58 @@ import Foundation /** Details about an environment. */ public struct Environment: Decodable { - /// Status of the environment. + /** + Status of the environment. + */ public enum Status: String { case active = "active" case pending = "pending" case maintenance = "maintenance" } - /// Unique identifier for the environment. + /** + Unique identifier for the environment. + */ public var environmentID: String? - /// Name that identifies the environment. + /** + Name that identifies the environment. + */ public var name: String? - /// Description of the environment. + /** + Description of the environment. + */ public var description: String? - /// Creation date of the environment, in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. + /** + Creation date of the environment, in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. + */ public var created: String? - /// Date of most recent environment update, in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. + /** + Date of most recent environment update, in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. + */ public var updated: String? - /// Status of the environment. + /** + Status of the environment. + */ public var status: String? - /// If true, then the environment contains read-only collections which are maintained by IBM. + /** + If true, then the environment contains read-only collections which are maintained by IBM. + */ public var readOnly: Bool? - /// **Deprecated**: Size of the environment. + /** + **Deprecated**: Size of the environment. + */ public var size: Int? - /// Details about the resource usage and capacity of the environment. + /** + Details about the resource usage and capacity of the environment. + */ public var indexCapacity: IndexCapacity? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/EnvironmentDocuments.swift b/Source/DiscoveryV1/Models/EnvironmentDocuments.swift index 7b9aa2818..60c032f37 100644 --- a/Source/DiscoveryV1/Models/EnvironmentDocuments.swift +++ b/Source/DiscoveryV1/Models/EnvironmentDocuments.swift @@ -19,10 +19,14 @@ import Foundation /** Summary of the document usage statistics for the environment. */ public struct EnvironmentDocuments: Decodable { - /// Number of documents indexed for the environment. + /** + Number of documents indexed for the environment. + */ public var indexed: Int? - /// Total number of documents allowed in the environment's capacity. + /** + Total number of documents allowed in the environment's capacity. + */ public var maximumAllowed: Int? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/Expansion.swift b/Source/DiscoveryV1/Models/Expansion.swift index df6268cd5..cbdcf98ce 100644 --- a/Source/DiscoveryV1/Models/Expansion.swift +++ b/Source/DiscoveryV1/Models/Expansion.swift @@ -19,10 +19,15 @@ import Foundation /** An expansion definition. Each object respresents one set of expandable strings. For example, you could have expansions for the word `hot` in one object, and expansions for the word `cold` in another. */ public struct Expansion: Codable { - /// A list of terms that will be expanded for this expansion. If specified, only the items in this list are expanded. + /** + A list of terms that will be expanded for this expansion. If specified, only the items in this list are expanded. + */ public var inputTerms: [String]? - /// A list of terms that this expansion will be expanded to. If specified without `input_terms`, it also functions as the input term list. + /** + A list of terms that this expansion will be expanded to. If specified without `input_terms`, it also functions as + the input term list. + */ public var expandedTerms: [String] // Map each property name to the key that shall be used for encoding/decoding. @@ -34,12 +39,17 @@ public struct Expansion: Codable { /** Initialize a `Expansion` with member variables. - - parameter expandedTerms: A list of terms that this expansion will be expanded to. If specified without `input_terms`, it also functions as the input term list. + - parameter expandedTerms: A list of terms that this expansion will be expanded to. If specified without `input_terms`, it also functions as + the input term list. - parameter inputTerms: A list of terms that will be expanded for this expansion. If specified, only the items in this list are expanded. - returns: An initialized `Expansion`. */ - public init(expandedTerms: [String], inputTerms: [String]? = nil) { + public init( + expandedTerms: [String], + inputTerms: [String]? = nil + ) + { self.expandedTerms = expandedTerms self.inputTerms = inputTerms } diff --git a/Source/DiscoveryV1/Models/Expansions.swift b/Source/DiscoveryV1/Models/Expansions.swift index 237ebbfb8..a3713a9ad 100644 --- a/Source/DiscoveryV1/Models/Expansions.swift +++ b/Source/DiscoveryV1/Models/Expansions.swift @@ -19,7 +19,17 @@ import Foundation /** The query expansion definitions for the specified collection. */ public struct Expansions: Codable { - /// An array of query expansion definitions. Each object in the `expansions` array represents a term or set of terms that will be expanded into other terms. Each expansion object can be configured so that all terms are expanded to all other terms in the object - bi-directional, or a set list of terms can be expanded into a second list of terms - uni-directional. To create a bi-directional expansion specify an `expanded_terms` array. When found in a query, all items in the `expanded_terms` array are then expanded to the other items in the same array. To create a uni-directional expansion, specify both an array of `input_terms` and an array of `expanded_terms`. When items in the `input_terms` array are present in a query, they are expanded using the items listed in the `expanded_terms` array. + /** + An array of query expansion definitions. + Each object in the `expansions` array represents a term or set of terms that will be expanded into other terms. + Each expansion object can be configured so that all terms are expanded to all other terms in the object - + bi-directional, or a set list of terms can be expanded into a second list of terms - uni-directional. + To create a bi-directional expansion specify an `expanded_terms` array. When found in a query, all items in the + `expanded_terms` array are then expanded to the other items in the same array. + To create a uni-directional expansion, specify both an array of `input_terms` and an array of `expanded_terms`. + When items in the `input_terms` array are present in a query, they are expanded using the items listed in the + `expanded_terms` array. + */ public var expansions: [Expansion] // Map each property name to the key that shall be used for encoding/decoding. @@ -30,11 +40,22 @@ public struct Expansions: Codable { /** Initialize a `Expansions` with member variables. - - parameter expansions: An array of query expansion definitions. Each object in the `expansions` array represents a term or set of terms that will be expanded into other terms. Each expansion object can be configured so that all terms are expanded to all other terms in the object - bi-directional, or a set list of terms can be expanded into a second list of terms - uni-directional. To create a bi-directional expansion specify an `expanded_terms` array. When found in a query, all items in the `expanded_terms` array are then expanded to the other items in the same array. To create a uni-directional expansion, specify both an array of `input_terms` and an array of `expanded_terms`. When items in the `input_terms` array are present in a query, they are expanded using the items listed in the `expanded_terms` array. + - parameter expansions: An array of query expansion definitions. + Each object in the `expansions` array represents a term or set of terms that will be expanded into other terms. + Each expansion object can be configured so that all terms are expanded to all other terms in the object - + bi-directional, or a set list of terms can be expanded into a second list of terms - uni-directional. + To create a bi-directional expansion specify an `expanded_terms` array. When found in a query, all items in the + `expanded_terms` array are then expanded to the other items in the same array. + To create a uni-directional expansion, specify both an array of `input_terms` and an array of `expanded_terms`. + When items in the `input_terms` array are present in a query, they are expanded using the items listed in the + `expanded_terms` array. - returns: An initialized `Expansions`. */ - public init(expansions: [Expansion]) { + public init( + expansions: [Expansion] + ) + { self.expansions = expansions } diff --git a/Source/DiscoveryV1/Models/Field.swift b/Source/DiscoveryV1/Models/Field.swift index d17855272..ec829e338 100644 --- a/Source/DiscoveryV1/Models/Field.swift +++ b/Source/DiscoveryV1/Models/Field.swift @@ -19,7 +19,9 @@ import Foundation /** Field. */ public struct Field: Decodable { - /// The type of the field. + /** + The type of the field. + */ public enum FieldType: String { case nested = "nested" case string = "string" @@ -34,10 +36,14 @@ public struct Field: Decodable { case binary = "binary" } - /// The name of the field. + /** + The name of the field. + */ public var fieldName: String? - /// The type of the field. + /** + The type of the field. + */ public var fieldType: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/Filter.swift b/Source/DiscoveryV1/Models/Filter.swift index 2f39972db..2c616a9fa 100644 --- a/Source/DiscoveryV1/Models/Filter.swift +++ b/Source/DiscoveryV1/Models/Filter.swift @@ -19,18 +19,26 @@ import Foundation /** Filter. */ public struct Filter: Decodable { - /// The type of aggregation command used. For example: term, filter, max, min, etc. + /** + The type of aggregation command used. For example: term, filter, max, min, etc. + */ public var type: String? public var results: [AggregationResult]? - /// Number of matching results. + /** + Number of matching results. + */ public var matchingResults: Int? - /// Aggregations returned by the Discovery service. + /** + Aggregations returned by the Discovery service. + */ public var aggregations: [QueryAggregation]? - /// The match the aggregated results queried for. + /** + The match the aggregated results queried for. + */ public var match: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/FontSetting.swift b/Source/DiscoveryV1/Models/FontSetting.swift index dbdc5e21d..9cecdf954 100644 --- a/Source/DiscoveryV1/Models/FontSetting.swift +++ b/Source/DiscoveryV1/Models/FontSetting.swift @@ -53,7 +53,15 @@ public struct FontSetting: Codable { - returns: An initialized `FontSetting`. */ - public init(level: Int? = nil, minSize: Int? = nil, maxSize: Int? = nil, bold: Bool? = nil, italic: Bool? = nil, name: String? = nil) { + public init( + level: Int? = nil, + minSize: Int? = nil, + maxSize: Int? = nil, + bold: Bool? = nil, + italic: Bool? = nil, + name: String? = nil + ) + { self.level = level self.minSize = minSize self.maxSize = maxSize diff --git a/Source/DiscoveryV1/Models/Histogram.swift b/Source/DiscoveryV1/Models/Histogram.swift index 05c3c500a..32aac2045 100644 --- a/Source/DiscoveryV1/Models/Histogram.swift +++ b/Source/DiscoveryV1/Models/Histogram.swift @@ -19,21 +19,31 @@ import Foundation /** Histogram. */ public struct Histogram: Decodable { - /// The type of aggregation command used. For example: term, filter, max, min, etc. + /** + The type of aggregation command used. For example: term, filter, max, min, etc. + */ public var type: String? public var results: [AggregationResult]? - /// Number of matching results. + /** + Number of matching results. + */ public var matchingResults: Int? - /// Aggregations returned by the Discovery service. + /** + Aggregations returned by the Discovery service. + */ public var aggregations: [QueryAggregation]? - /// The field where the aggregation is located in the document. + /** + The field where the aggregation is located in the document. + */ public var field: String? - /// Interval of the aggregation. (For 'histogram' type). + /** + Interval of the aggregation. (For 'histogram' type). + */ public var interval: Int? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/HtmlSettings.swift b/Source/DiscoveryV1/Models/HtmlSettings.swift index 3529b6a92..680bc4552 100644 --- a/Source/DiscoveryV1/Models/HtmlSettings.swift +++ b/Source/DiscoveryV1/Models/HtmlSettings.swift @@ -53,7 +53,15 @@ public struct HtmlSettings: Codable { - returns: An initialized `HtmlSettings`. */ - public init(excludeTagsCompletely: [String]? = nil, excludeTagsKeepContent: [String]? = nil, keepContent: XPathPatterns? = nil, excludeContent: XPathPatterns? = nil, keepTagAttributes: [String]? = nil, excludeTagAttributes: [String]? = nil) { + public init( + excludeTagsCompletely: [String]? = nil, + excludeTagsKeepContent: [String]? = nil, + keepContent: XPathPatterns? = nil, + excludeContent: XPathPatterns? = nil, + keepTagAttributes: [String]? = nil, + excludeTagAttributes: [String]? = nil + ) + { self.excludeTagsCompletely = excludeTagsCompletely self.excludeTagsKeepContent = excludeTagsKeepContent self.keepContent = keepContent diff --git a/Source/DiscoveryV1/Models/IndexCapacity.swift b/Source/DiscoveryV1/Models/IndexCapacity.swift index e46ae8a2a..c76ac79b4 100644 --- a/Source/DiscoveryV1/Models/IndexCapacity.swift +++ b/Source/DiscoveryV1/Models/IndexCapacity.swift @@ -19,16 +19,24 @@ import Foundation /** Details about the resource usage and capacity of the environment. */ public struct IndexCapacity: Decodable { - /// Summary of the document usage statistics for the environment. + /** + Summary of the document usage statistics for the environment. + */ public var documents: EnvironmentDocuments? - /// Summary of the disk usage of the environment. + /** + Summary of the disk usage of the environment. + */ public var diskUsage: DiskUsage? - /// Summary of the collection usage in the environment. + /** + Summary of the collection usage in the environment. + */ public var collections: CollectionUsage? - /// **Deprecated**: Summary of the memory usage of the environment. + /** + **Deprecated**: Summary of the memory usage of the environment. + */ public var memoryUsage: MemoryUsage? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/ListCollectionFieldsResponse.swift b/Source/DiscoveryV1/Models/ListCollectionFieldsResponse.swift index 4b49887bf..554cc4f96 100644 --- a/Source/DiscoveryV1/Models/ListCollectionFieldsResponse.swift +++ b/Source/DiscoveryV1/Models/ListCollectionFieldsResponse.swift @@ -16,10 +16,20 @@ import Foundation -/** The list of fetched fields. The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations. * Fields which contain nested JSON objects are assigned a type of "nested". * Fields which belong to a nested object are prefixed with `.properties` (for example, `warnings.properties.severity` means that the `warnings` object has a property called `severity`). * Fields returned from the News collection are prefixed with `v{N}-fullnews-t3-{YEAR}.mappings` (for example, `v5-fullnews-t3-2016.mappings.text.properties.author`). */ +/** The list of fetched fields. + +The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations. + + * Fields which contain nested JSON objects are assigned a type of "nested". + + * Fields which belong to a nested object are prefixed with `.properties` (for example, `warnings.properties.severity` means that the `warnings` object has a property called `severity`). + + * Fields returned from the News collection are prefixed with `v{N}-fullnews-t3-{YEAR}.mappings` (for example, `v5-fullnews-t3-2016.mappings.text.properties.author`). */ public struct ListCollectionFieldsResponse: Decodable { - /// An array containing information about each field in the collections. + /** + An array containing information about each field in the collections. + */ public var fields: [Field]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/ListCollectionsResponse.swift b/Source/DiscoveryV1/Models/ListCollectionsResponse.swift index 1a3b00a7a..fdfc42ea5 100644 --- a/Source/DiscoveryV1/Models/ListCollectionsResponse.swift +++ b/Source/DiscoveryV1/Models/ListCollectionsResponse.swift @@ -19,7 +19,9 @@ import Foundation /** ListCollectionsResponse. */ public struct ListCollectionsResponse: Decodable { - /// An array containing information about each collection in the environment. + /** + An array containing information about each collection in the environment. + */ public var collections: [Collection]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/ListConfigurationsResponse.swift b/Source/DiscoveryV1/Models/ListConfigurationsResponse.swift index 1fcdc2324..25d4ef44c 100644 --- a/Source/DiscoveryV1/Models/ListConfigurationsResponse.swift +++ b/Source/DiscoveryV1/Models/ListConfigurationsResponse.swift @@ -19,7 +19,9 @@ import Foundation /** ListConfigurationsResponse. */ public struct ListConfigurationsResponse: Decodable { - /// An array of Configurations that are available for the service instance. + /** + An array of Configurations that are available for the service instance. + */ public var configurations: [Configuration]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/ListEnvironmentsResponse.swift b/Source/DiscoveryV1/Models/ListEnvironmentsResponse.swift index 757074244..5f3cfa19a 100644 --- a/Source/DiscoveryV1/Models/ListEnvironmentsResponse.swift +++ b/Source/DiscoveryV1/Models/ListEnvironmentsResponse.swift @@ -19,7 +19,9 @@ import Foundation /** ListEnvironmentsResponse. */ public struct ListEnvironmentsResponse: Decodable { - /// An array of [environments] that are available for the service instance. + /** + An array of [environments] that are available for the service instance. + */ public var environments: [Environment]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/MemoryUsage.swift b/Source/DiscoveryV1/Models/MemoryUsage.swift index 9ace9b6bd..cd4c8bbba 100644 --- a/Source/DiscoveryV1/Models/MemoryUsage.swift +++ b/Source/DiscoveryV1/Models/MemoryUsage.swift @@ -19,19 +19,29 @@ import Foundation /** **Deprecated**: Summary of the memory usage statistics for this environment. */ public struct MemoryUsage: Decodable { - /// **Deprecated**: Number of bytes used in the environment's memory capacity. + /** + **Deprecated**: Number of bytes used in the environment's memory capacity. + */ public var usedBytes: Int? - /// **Deprecated**: Total number of bytes available in the environment's memory capacity. + /** + **Deprecated**: Total number of bytes available in the environment's memory capacity. + */ public var totalBytes: Int? - /// **Deprecated**: Amount of memory capacity used, in KB or GB format. + /** + **Deprecated**: Amount of memory capacity used, in KB or GB format. + */ public var used: String? - /// **Deprecated**: Total amount of the environment's memory capacity, in KB or GB format. + /** + **Deprecated**: Total amount of the environment's memory capacity, in KB or GB format. + */ public var total: String? - /// **Deprecated**: Percentage of the environment's memory capacity that is being used. + /** + **Deprecated**: Percentage of the environment's memory capacity that is being used. + */ public var percentUsed: Double? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/Nested.swift b/Source/DiscoveryV1/Models/Nested.swift index cde9770bc..bf710a992 100644 --- a/Source/DiscoveryV1/Models/Nested.swift +++ b/Source/DiscoveryV1/Models/Nested.swift @@ -19,18 +19,26 @@ import Foundation /** Nested. */ public struct Nested: Decodable { - /// The type of aggregation command used. For example: term, filter, max, min, etc. + /** + The type of aggregation command used. For example: term, filter, max, min, etc. + */ public var type: String? public var results: [AggregationResult]? - /// Number of matching results. + /** + Number of matching results. + */ public var matchingResults: Int? - /// Aggregations returned by the Discovery service. + /** + Aggregations returned by the Discovery service. + */ public var aggregations: [QueryAggregation]? - /// The area of the results the aggregation was restricted to. + /** + The area of the results the aggregation was restricted to. + */ public var path: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/NewTrainingQuery.swift b/Source/DiscoveryV1/Models/NewTrainingQuery.swift index 9190fe8b3..c74ac5ccc 100644 --- a/Source/DiscoveryV1/Models/NewTrainingQuery.swift +++ b/Source/DiscoveryV1/Models/NewTrainingQuery.swift @@ -41,7 +41,12 @@ internal struct NewTrainingQuery: Encodable { - returns: An initialized `NewTrainingQuery`. */ - public init(naturalLanguageQuery: String? = nil, filter: String? = nil, examples: [TrainingExample]? = nil) { + public init( + naturalLanguageQuery: String? = nil, + filter: String? = nil, + examples: [TrainingExample]? = nil + ) + { self.naturalLanguageQuery = naturalLanguageQuery self.filter = filter self.examples = examples diff --git a/Source/DiscoveryV1/Models/NluEnrichmentCategories.swift b/Source/DiscoveryV1/Models/NluEnrichmentCategories.swift index b8556d2d8..ea80a1568 100644 --- a/Source/DiscoveryV1/Models/NluEnrichmentCategories.swift +++ b/Source/DiscoveryV1/Models/NluEnrichmentCategories.swift @@ -27,7 +27,10 @@ public struct NluEnrichmentCategories: Codable { - returns: An initialized `NluEnrichmentCategories`. */ - public init(additionalProperties: [String: JSON] = [:]) { + public init( + additionalProperties: [String: JSON] = [:] + ) + { self.additionalProperties = additionalProperties } diff --git a/Source/DiscoveryV1/Models/NluEnrichmentEmotion.swift b/Source/DiscoveryV1/Models/NluEnrichmentEmotion.swift index b722cb1ae..1e58ed05d 100644 --- a/Source/DiscoveryV1/Models/NluEnrichmentEmotion.swift +++ b/Source/DiscoveryV1/Models/NluEnrichmentEmotion.swift @@ -19,10 +19,14 @@ import Foundation /** An object specifying the emotion detection enrichment and related parameters. */ public struct NluEnrichmentEmotion: Codable { - /// When `true`, emotion detection is performed on the entire field. + /** + When `true`, emotion detection is performed on the entire field. + */ public var document: Bool? - /// A comma-separated list of target strings that will have any associated emotions detected. + /** + A comma-separated list of target strings that will have any associated emotions detected. + */ public var targets: [String]? // Map each property name to the key that shall be used for encoding/decoding. @@ -39,7 +43,11 @@ public struct NluEnrichmentEmotion: Codable { - returns: An initialized `NluEnrichmentEmotion`. */ - public init(document: Bool? = nil, targets: [String]? = nil) { + public init( + document: Bool? = nil, + targets: [String]? = nil + ) + { self.document = document self.targets = targets } diff --git a/Source/DiscoveryV1/Models/NluEnrichmentEntities.swift b/Source/DiscoveryV1/Models/NluEnrichmentEntities.swift index bab650979..0393e5ca8 100644 --- a/Source/DiscoveryV1/Models/NluEnrichmentEntities.swift +++ b/Source/DiscoveryV1/Models/NluEnrichmentEntities.swift @@ -19,25 +19,41 @@ import Foundation /** An object speficying the Entities enrichment and related parameters. */ public struct NluEnrichmentEntities: Codable { - /// When `true`, sentiment analysis of entities will be performed on the specified field. + /** + When `true`, sentiment analysis of entities will be performed on the specified field. + */ public var sentiment: Bool? - /// When `true`, emotion detection of entities will be performed on the specified field. + /** + When `true`, emotion detection of entities will be performed on the specified field. + */ public var emotion: Bool? - /// The maximum number of entities to extract for each instance of the specified field. + /** + The maximum number of entities to extract for each instance of the specified field. + */ public var limit: Int? - /// When `true`, the number of mentions of each identified entity is recorded. The default is `false`. + /** + When `true`, the number of mentions of each identified entity is recorded. The default is `false`. + */ public var mentions: Bool? - /// When `true`, the types of mentions for each idetifieid entity is recorded. The default is `false`. + /** + When `true`, the types of mentions for each idetifieid entity is recorded. The default is `false`. + */ public var mentionTypes: Bool? - /// When `true`, a list of sentence locations for each instance of each identified entity is recorded. The default is `false`. + /** + When `true`, a list of sentence locations for each instance of each identified entity is recorded. The default is + `false`. + */ public var sentenceLocation: Bool? - /// The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge Graph `en-news`, or the default public model `alchemy`. + /** + The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge Studio, the + public model for use with Knowledge Graph `en-news`, or the default public model `alchemy`. + */ public var model: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -59,12 +75,23 @@ public struct NluEnrichmentEntities: Codable { - parameter limit: The maximum number of entities to extract for each instance of the specified field. - parameter mentions: When `true`, the number of mentions of each identified entity is recorded. The default is `false`. - parameter mentionTypes: When `true`, the types of mentions for each idetifieid entity is recorded. The default is `false`. - - parameter sentenceLocation: When `true`, a list of sentence locations for each instance of each identified entity is recorded. The default is `false`. - - parameter model: The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge Graph `en-news`, or the default public model `alchemy`. + - parameter sentenceLocation: When `true`, a list of sentence locations for each instance of each identified entity is recorded. The default is + `false`. + - parameter model: The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge Studio, + the public model for use with Knowledge Graph `en-news`, or the default public model `alchemy`. - returns: An initialized `NluEnrichmentEntities`. */ - public init(sentiment: Bool? = nil, emotion: Bool? = nil, limit: Int? = nil, mentions: Bool? = nil, mentionTypes: Bool? = nil, sentenceLocation: Bool? = nil, model: String? = nil) { + public init( + sentiment: Bool? = nil, + emotion: Bool? = nil, + limit: Int? = nil, + mentions: Bool? = nil, + mentionTypes: Bool? = nil, + sentenceLocation: Bool? = nil, + model: String? = nil + ) + { self.sentiment = sentiment self.emotion = emotion self.limit = limit diff --git a/Source/DiscoveryV1/Models/NluEnrichmentFeatures.swift b/Source/DiscoveryV1/Models/NluEnrichmentFeatures.swift index d7efb7788..d0f86acad 100644 --- a/Source/DiscoveryV1/Models/NluEnrichmentFeatures.swift +++ b/Source/DiscoveryV1/Models/NluEnrichmentFeatures.swift @@ -19,25 +19,39 @@ import Foundation /** NluEnrichmentFeatures. */ public struct NluEnrichmentFeatures: Codable { - /// An object specifying the Keyword enrichment and related parameters. + /** + An object specifying the Keyword enrichment and related parameters. + */ public var keywords: NluEnrichmentKeywords? - /// An object speficying the Entities enrichment and related parameters. + /** + An object speficying the Entities enrichment and related parameters. + */ public var entities: NluEnrichmentEntities? - /// An object specifying the sentiment extraction enrichment and related parameters. + /** + An object specifying the sentiment extraction enrichment and related parameters. + */ public var sentiment: NluEnrichmentSentiment? - /// An object specifying the emotion detection enrichment and related parameters. + /** + An object specifying the emotion detection enrichment and related parameters. + */ public var emotion: NluEnrichmentEmotion? - /// An object specifying the categories enrichment and related parameters. + /** + An object specifying the categories enrichment and related parameters. + */ public var categories: NluEnrichmentCategories? - /// An object specifiying the semantic roles enrichment and related parameters. + /** + An object specifiying the semantic roles enrichment and related parameters. + */ public var semanticRoles: NluEnrichmentSemanticRoles? - /// An object specifying the relations enrichment and related parameters. + /** + An object specifying the relations enrichment and related parameters. + */ public var relations: NluEnrichmentRelations? // Map each property name to the key that shall be used for encoding/decoding. @@ -64,7 +78,16 @@ public struct NluEnrichmentFeatures: Codable { - returns: An initialized `NluEnrichmentFeatures`. */ - public init(keywords: NluEnrichmentKeywords? = nil, entities: NluEnrichmentEntities? = nil, sentiment: NluEnrichmentSentiment? = nil, emotion: NluEnrichmentEmotion? = nil, categories: NluEnrichmentCategories? = nil, semanticRoles: NluEnrichmentSemanticRoles? = nil, relations: NluEnrichmentRelations? = nil) { + public init( + keywords: NluEnrichmentKeywords? = nil, + entities: NluEnrichmentEntities? = nil, + sentiment: NluEnrichmentSentiment? = nil, + emotion: NluEnrichmentEmotion? = nil, + categories: NluEnrichmentCategories? = nil, + semanticRoles: NluEnrichmentSemanticRoles? = nil, + relations: NluEnrichmentRelations? = nil + ) + { self.keywords = keywords self.entities = entities self.sentiment = sentiment diff --git a/Source/DiscoveryV1/Models/NluEnrichmentKeywords.swift b/Source/DiscoveryV1/Models/NluEnrichmentKeywords.swift index fea5332aa..b86dfe691 100644 --- a/Source/DiscoveryV1/Models/NluEnrichmentKeywords.swift +++ b/Source/DiscoveryV1/Models/NluEnrichmentKeywords.swift @@ -19,13 +19,19 @@ import Foundation /** An object specifying the Keyword enrichment and related parameters. */ public struct NluEnrichmentKeywords: Codable { - /// When `true`, sentiment analysis of keywords will be performed on the specified field. + /** + When `true`, sentiment analysis of keywords will be performed on the specified field. + */ public var sentiment: Bool? - /// When `true`, emotion detection of keywords will be performed on the specified field. + /** + When `true`, emotion detection of keywords will be performed on the specified field. + */ public var emotion: Bool? - /// The maximum number of keywords to extract for each instance of the specified field. + /** + The maximum number of keywords to extract for each instance of the specified field. + */ public var limit: Int? // Map each property name to the key that shall be used for encoding/decoding. @@ -44,7 +50,12 @@ public struct NluEnrichmentKeywords: Codable { - returns: An initialized `NluEnrichmentKeywords`. */ - public init(sentiment: Bool? = nil, emotion: Bool? = nil, limit: Int? = nil) { + public init( + sentiment: Bool? = nil, + emotion: Bool? = nil, + limit: Int? = nil + ) + { self.sentiment = sentiment self.emotion = emotion self.limit = limit diff --git a/Source/DiscoveryV1/Models/NluEnrichmentRelations.swift b/Source/DiscoveryV1/Models/NluEnrichmentRelations.swift index 710abe6a9..338f22440 100644 --- a/Source/DiscoveryV1/Models/NluEnrichmentRelations.swift +++ b/Source/DiscoveryV1/Models/NluEnrichmentRelations.swift @@ -19,7 +19,11 @@ import Foundation /** An object specifying the relations enrichment and related parameters. */ public struct NluEnrichmentRelations: Codable { - /// *For use with `natural_language_understanding` enrichments only.* The enrichement model to use with relationship extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge Graph `en-news`, the default is`en-news`. + /** + *For use with `natural_language_understanding` enrichments only.* The enrichement model to use with relationship + extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge + Graph `en-news`, the default is`en-news`. + */ public var model: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -30,11 +34,16 @@ public struct NluEnrichmentRelations: Codable { /** Initialize a `NluEnrichmentRelations` with member variables. - - parameter model: *For use with `natural_language_understanding` enrichments only.* The enrichement model to use with relationship extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge Graph `en-news`, the default is`en-news`. + - parameter model: *For use with `natural_language_understanding` enrichments only.* The enrichement model to use with relationship + extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge + Graph `en-news`, the default is`en-news`. - returns: An initialized `NluEnrichmentRelations`. */ - public init(model: String? = nil) { + public init( + model: String? = nil + ) + { self.model = model } diff --git a/Source/DiscoveryV1/Models/NluEnrichmentSemanticRoles.swift b/Source/DiscoveryV1/Models/NluEnrichmentSemanticRoles.swift index 7f0a07511..ce3d44b60 100644 --- a/Source/DiscoveryV1/Models/NluEnrichmentSemanticRoles.swift +++ b/Source/DiscoveryV1/Models/NluEnrichmentSemanticRoles.swift @@ -19,13 +19,19 @@ import Foundation /** An object specifiying the semantic roles enrichment and related parameters. */ public struct NluEnrichmentSemanticRoles: Codable { - /// When `true` entities are extracted from the identified sentence parts. + /** + When `true` entities are extracted from the identified sentence parts. + */ public var entities: Bool? - /// When `true`, keywords are extracted from the identified sentence parts. + /** + When `true`, keywords are extracted from the identified sentence parts. + */ public var keywords: Bool? - /// The maximum number of semantic roles enrichments to extact from each instance of the specified field. + /** + The maximum number of semantic roles enrichments to extact from each instance of the specified field. + */ public var limit: Int? // Map each property name to the key that shall be used for encoding/decoding. @@ -44,7 +50,12 @@ public struct NluEnrichmentSemanticRoles: Codable { - returns: An initialized `NluEnrichmentSemanticRoles`. */ - public init(entities: Bool? = nil, keywords: Bool? = nil, limit: Int? = nil) { + public init( + entities: Bool? = nil, + keywords: Bool? = nil, + limit: Int? = nil + ) + { self.entities = entities self.keywords = keywords self.limit = limit diff --git a/Source/DiscoveryV1/Models/NluEnrichmentSentiment.swift b/Source/DiscoveryV1/Models/NluEnrichmentSentiment.swift index 192810770..5509c4793 100644 --- a/Source/DiscoveryV1/Models/NluEnrichmentSentiment.swift +++ b/Source/DiscoveryV1/Models/NluEnrichmentSentiment.swift @@ -19,10 +19,14 @@ import Foundation /** An object specifying the sentiment extraction enrichment and related parameters. */ public struct NluEnrichmentSentiment: Codable { - /// When `true`, sentiment analysis is performed on the entire field. + /** + When `true`, sentiment analysis is performed on the entire field. + */ public var document: Bool? - /// A comma-separated list of target strings that will have any associated sentiment analyzed. + /** + A comma-separated list of target strings that will have any associated sentiment analyzed. + */ public var targets: [String]? // Map each property name to the key that shall be used for encoding/decoding. @@ -39,7 +43,11 @@ public struct NluEnrichmentSentiment: Codable { - returns: An initialized `NluEnrichmentSentiment`. */ - public init(document: Bool? = nil, targets: [String]? = nil) { + public init( + document: Bool? = nil, + targets: [String]? = nil + ) + { self.document = document self.targets = targets } diff --git a/Source/DiscoveryV1/Models/NormalizationOperation.swift b/Source/DiscoveryV1/Models/NormalizationOperation.swift index 540ef14fe..7431660bb 100644 --- a/Source/DiscoveryV1/Models/NormalizationOperation.swift +++ b/Source/DiscoveryV1/Models/NormalizationOperation.swift @@ -19,12 +19,25 @@ import Foundation /** NormalizationOperation. */ public struct NormalizationOperation: Codable { - /// Identifies what type of operation to perform. - /// **copy** - Copies the value of the `source_field` to the `destination_field` field. If the `destination_field` already exists, then the value of the `source_field` overwrites the original value of the `destination_field`. - /// **move** - Renames (moves) the `source_field` to the `destination_field`. If the `destination_field` already exists, then the value of the `source_field` overwrites the original value of the `destination_field`. Rename is identical to copy, except that the `source_field` is removed after the value has been copied to the `destination_field` (it is the same as a _copy_ followed by a _remove_). - /// **merge** - Merges the value of the `source_field` with the value of the `destination_field`. The `destination_field` is converted into an array if it is not already an array, and the value of the `source_field` is appended to the array. This operation removes the `source_field` after the merge. If the `source_field` does not exist in the current document, then the `destination_field` is still converted into an array (if it is not an array already). This is ensures the type for `destination_field` is consistent across all documents. - /// **remove** - Deletes the `source_field` field. The `destination_field` is ignored for this operation. - /// **remove_nulls** - Removes all nested null (blank) leif values from the JSON tree. `source_field` and `destination_field` are ignored by this operation because _remove_nulls_ operates on the entire JSON tree. Typically, `remove_nulls` is invoked as the last normalization operation (if it is inoked at all, it can be time-expensive). + /** + Identifies what type of operation to perform. + **copy** - Copies the value of the `source_field` to the `destination_field` field. If the `destination_field` + already exists, then the value of the `source_field` overwrites the original value of the `destination_field`. + **move** - Renames (moves) the `source_field` to the `destination_field`. If the `destination_field` already + exists, then the value of the `source_field` overwrites the original value of the `destination_field`. Rename is + identical to copy, except that the `source_field` is removed after the value has been copied to the + `destination_field` (it is the same as a _copy_ followed by a _remove_). + **merge** - Merges the value of the `source_field` with the value of the `destination_field`. The + `destination_field` is converted into an array if it is not already an array, and the value of the `source_field` + is appended to the array. This operation removes the `source_field` after the merge. If the `source_field` does not + exist in the current document, then the `destination_field` is still converted into an array (if it is not an array + already). This is ensures the type for `destination_field` is consistent across all documents. + **remove** - Deletes the `source_field` field. The `destination_field` is ignored for this operation. + **remove_nulls** - Removes all nested null (blank) leif values from the JSON tree. `source_field` and + `destination_field` are ignored by this operation because _remove_nulls_ operates on the entire JSON tree. + Typically, `remove_nulls` is invoked as the last normalization operation (if it is inoked at all, it can be + time-expensive). + */ public enum Operation: String { case copy = "copy" case move = "move" @@ -33,13 +46,35 @@ public struct NormalizationOperation: Codable { case removeNulls = "remove_nulls" } - /// Identifies what type of operation to perform. + /** + Identifies what type of operation to perform. + **copy** - Copies the value of the `source_field` to the `destination_field` field. If the `destination_field` + already exists, then the value of the `source_field` overwrites the original value of the `destination_field`. + **move** - Renames (moves) the `source_field` to the `destination_field`. If the `destination_field` already + exists, then the value of the `source_field` overwrites the original value of the `destination_field`. Rename is + identical to copy, except that the `source_field` is removed after the value has been copied to the + `destination_field` (it is the same as a _copy_ followed by a _remove_). + **merge** - Merges the value of the `source_field` with the value of the `destination_field`. The + `destination_field` is converted into an array if it is not already an array, and the value of the `source_field` + is appended to the array. This operation removes the `source_field` after the merge. If the `source_field` does not + exist in the current document, then the `destination_field` is still converted into an array (if it is not an array + already). This is ensures the type for `destination_field` is consistent across all documents. + **remove** - Deletes the `source_field` field. The `destination_field` is ignored for this operation. + **remove_nulls** - Removes all nested null (blank) leif values from the JSON tree. `source_field` and + `destination_field` are ignored by this operation because _remove_nulls_ operates on the entire JSON tree. + Typically, `remove_nulls` is invoked as the last normalization operation (if it is inoked at all, it can be + time-expensive). + */ public var operation: String? - /// The source field for the operation. + /** + The source field for the operation. + */ public var sourceField: String? - /// The destination field for the operation. + /** + The destination field for the operation. + */ public var destinationField: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -53,12 +88,33 @@ public struct NormalizationOperation: Codable { Initialize a `NormalizationOperation` with member variables. - parameter operation: Identifies what type of operation to perform. + **copy** - Copies the value of the `source_field` to the `destination_field` field. If the `destination_field` + already exists, then the value of the `source_field` overwrites the original value of the `destination_field`. + **move** - Renames (moves) the `source_field` to the `destination_field`. If the `destination_field` already + exists, then the value of the `source_field` overwrites the original value of the `destination_field`. Rename is + identical to copy, except that the `source_field` is removed after the value has been copied to the + `destination_field` (it is the same as a _copy_ followed by a _remove_). + **merge** - Merges the value of the `source_field` with the value of the `destination_field`. The + `destination_field` is converted into an array if it is not already an array, and the value of the `source_field` + is appended to the array. This operation removes the `source_field` after the merge. If the `source_field` does + not exist in the current document, then the `destination_field` is still converted into an array (if it is not an + array already). This is ensures the type for `destination_field` is consistent across all documents. + **remove** - Deletes the `source_field` field. The `destination_field` is ignored for this operation. + **remove_nulls** - Removes all nested null (blank) leif values from the JSON tree. `source_field` and + `destination_field` are ignored by this operation because _remove_nulls_ operates on the entire JSON tree. + Typically, `remove_nulls` is invoked as the last normalization operation (if it is inoked at all, it can be + time-expensive). - parameter sourceField: The source field for the operation. - parameter destinationField: The destination field for the operation. - returns: An initialized `NormalizationOperation`. */ - public init(operation: String? = nil, sourceField: String? = nil, destinationField: String? = nil) { + public init( + operation: String? = nil, + sourceField: String? = nil, + destinationField: String? = nil + ) + { self.operation = operation self.sourceField = sourceField self.destinationField = destinationField diff --git a/Source/DiscoveryV1/Models/Notice.swift b/Source/DiscoveryV1/Models/Notice.swift index e75acd12f..3a3b9cd9d 100644 --- a/Source/DiscoveryV1/Models/Notice.swift +++ b/Source/DiscoveryV1/Models/Notice.swift @@ -19,31 +19,48 @@ import Foundation /** A notice produced for the collection. */ public struct Notice: Decodable { - /// Severity level of the notice. + /** + Severity level of the notice. + */ public enum Severity: String { case warning = "warning" case error = "error" } - /// 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. + /** + 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. + */ public var noticeID: String? - /// The creation date of the collection in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. + /** + The creation date of the collection in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. + */ public var created: String? - /// Unique identifier of the document. + /** + Unique identifier of the document. + */ public var documentID: String? - /// Unique identifier of the query used for relevance training. + /** + Unique identifier of the query used for relevance training. + */ public var queryID: String? - /// Severity level of the notice. + /** + Severity level of the notice. + */ public var severity: String? - /// Ingestion or training step in which the notice occurred. + /** + Ingestion or training step in which the notice occurred. + */ public var step: String? - /// The description of the notice. + /** + The description of the notice. + */ public var description: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/PdfHeadingDetection.swift b/Source/DiscoveryV1/Models/PdfHeadingDetection.swift index b94b07a86..fd8669280 100644 --- a/Source/DiscoveryV1/Models/PdfHeadingDetection.swift +++ b/Source/DiscoveryV1/Models/PdfHeadingDetection.swift @@ -33,7 +33,10 @@ public struct PdfHeadingDetection: Codable { - returns: An initialized `PdfHeadingDetection`. */ - public init(fonts: [FontSetting]? = nil) { + public init( + fonts: [FontSetting]? = nil + ) + { self.fonts = fonts } diff --git a/Source/DiscoveryV1/Models/PdfSettings.swift b/Source/DiscoveryV1/Models/PdfSettings.swift index b9f945987..b19c66789 100644 --- a/Source/DiscoveryV1/Models/PdfSettings.swift +++ b/Source/DiscoveryV1/Models/PdfSettings.swift @@ -33,7 +33,10 @@ public struct PdfSettings: Codable { - returns: An initialized `PdfSettings`. */ - public init(heading: PdfHeadingDetection? = nil) { + public init( + heading: PdfHeadingDetection? = nil + ) + { self.heading = heading } diff --git a/Source/DiscoveryV1/Models/QueryEntities.swift b/Source/DiscoveryV1/Models/QueryEntities.swift index 70fbefc43..eb906f3d4 100644 --- a/Source/DiscoveryV1/Models/QueryEntities.swift +++ b/Source/DiscoveryV1/Models/QueryEntities.swift @@ -19,19 +19,31 @@ import Foundation /** QueryEntities. */ public struct QueryEntities: Encodable { - /// The entity query feature to perform. Supported features are `disambiguate` and `similar_entities`. + /** + The entity query feature to perform. Supported features are `disambiguate` and `similar_entities`. + */ public var feature: String? - /// A text string that appears within the entity text field. + /** + A text string that appears within the entity text field. + */ public var entity: QueryEntitiesEntity? - /// Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for `London` with the context of `England`. + /** + Entity text to provide context for the queried entity and rank based on that association. For example, if you + wanted to query the city of London in England your query would look for `London` with the context of `England`. + */ public var context: QueryEntitiesContext? - /// The number of results to return. The default is `10`. The maximum is `1000`. + /** + The number of results to return. The default is `10`. The maximum is `1000`. + */ public var count: Int? - /// The number of evidence items to return for each result. The default is `0`. The maximum number of evidence items per query is 10,000. + /** + The number of evidence items to return for each result. The default is `0`. The maximum number of evidence items + per query is 10,000. + */ public var evidenceCount: Int? // Map each property name to the key that shall be used for encoding/decoding. @@ -48,13 +60,22 @@ public struct QueryEntities: Encodable { - parameter feature: The entity query feature to perform. Supported features are `disambiguate` and `similar_entities`. - parameter entity: A text string that appears within the entity text field. - - parameter context: Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for `London` with the context of `England`. + - parameter context: Entity text to provide context for the queried entity and rank based on that association. For example, if you + wanted to query the city of London in England your query would look for `London` with the context of `England`. - parameter count: The number of results to return. The default is `10`. The maximum is `1000`. - - parameter evidenceCount: The number of evidence items to return for each result. The default is `0`. The maximum number of evidence items per query is 10,000. + - parameter evidenceCount: The number of evidence items to return for each result. The default is `0`. The maximum number of evidence items + per query is 10,000. - returns: An initialized `QueryEntities`. */ - public init(feature: String? = nil, entity: QueryEntitiesEntity? = nil, context: QueryEntitiesContext? = nil, count: Int? = nil, evidenceCount: Int? = nil) { + public init( + feature: String? = nil, + entity: QueryEntitiesEntity? = nil, + context: QueryEntitiesContext? = nil, + count: Int? = nil, + evidenceCount: Int? = nil + ) + { self.feature = feature self.entity = entity self.context = context diff --git a/Source/DiscoveryV1/Models/QueryEntitiesContext.swift b/Source/DiscoveryV1/Models/QueryEntitiesContext.swift index f14f9ebda..f3d1f53fd 100644 --- a/Source/DiscoveryV1/Models/QueryEntitiesContext.swift +++ b/Source/DiscoveryV1/Models/QueryEntitiesContext.swift @@ -19,7 +19,10 @@ import Foundation /** Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for `London` with the context of `England`. */ public struct QueryEntitiesContext: Encodable { - /// Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for `London` with the context of `England`. + /** + Entity text to provide context for the queried entity and rank based on that association. For example, if you + wanted to query the city of London in England your query would look for `London` with the context of `England`. + */ public var text: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -30,11 +33,15 @@ public struct QueryEntitiesContext: Encodable { /** Initialize a `QueryEntitiesContext` with member variables. - - parameter text: Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for `London` with the context of `England`. + - parameter text: Entity text to provide context for the queried entity and rank based on that association. For example, if you + wanted to query the city of London in England your query would look for `London` with the context of `England`. - returns: An initialized `QueryEntitiesContext`. */ - public init(text: String? = nil) { + public init( + text: String? = nil + ) + { self.text = text } diff --git a/Source/DiscoveryV1/Models/QueryEntitiesEntity.swift b/Source/DiscoveryV1/Models/QueryEntitiesEntity.swift index 7adc7cd4f..d01114633 100644 --- a/Source/DiscoveryV1/Models/QueryEntitiesEntity.swift +++ b/Source/DiscoveryV1/Models/QueryEntitiesEntity.swift @@ -19,10 +19,14 @@ import Foundation /** A text string that appears within the entity text field. */ public struct QueryEntitiesEntity: Codable { - /// Entity text content. + /** + Entity text content. + */ public var text: String? - /// The type of the specified entity. + /** + The type of the specified entity. + */ public var type: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -39,7 +43,11 @@ public struct QueryEntitiesEntity: Codable { - returns: An initialized `QueryEntitiesEntity`. */ - public init(text: String? = nil, type: String? = nil) { + public init( + text: String? = nil, + type: String? = nil + ) + { self.text = text self.type = type } diff --git a/Source/DiscoveryV1/Models/QueryEntitiesResponseItem.swift b/Source/DiscoveryV1/Models/QueryEntitiesResponseItem.swift index 614be752e..20397d119 100644 --- a/Source/DiscoveryV1/Models/QueryEntitiesResponseItem.swift +++ b/Source/DiscoveryV1/Models/QueryEntitiesResponseItem.swift @@ -19,13 +19,19 @@ import Foundation /** Object containing Entity query response information. */ public struct QueryEntitiesResponseItem: Decodable { - /// Entity text content. + /** + Entity text content. + */ public var text: String? - /// The type of the result entity. + /** + The type of the result entity. + */ public var type: String? - /// List of different evidentiary items to support the result. + /** + List of different evidentiary items to support the result. + */ public var evidence: [QueryEvidence]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/QueryEvidence.swift b/Source/DiscoveryV1/Models/QueryEvidence.swift index 37ec6c6cc..c656adca9 100644 --- a/Source/DiscoveryV1/Models/QueryEvidence.swift +++ b/Source/DiscoveryV1/Models/QueryEvidence.swift @@ -19,19 +19,29 @@ import Foundation /** Description of evidence location supporting Knoweldge Graph query result. */ public struct QueryEvidence: Decodable { - /// The docuemnt ID (as indexed in Discovery) of the evidence location. + /** + The docuemnt ID (as indexed in Discovery) of the evidence location. + */ public var documentID: String? - /// The field of the document where the supporting evidence was identified. + /** + The field of the document where the supporting evidence was identified. + */ public var field: String? - /// The start location of the evidence in the identified field. This value is inclusive. + /** + The start location of the evidence in the identified field. This value is inclusive. + */ public var startOffset: Int? - /// The end location of the evidence in the identified field. This value is inclusive. + /** + The end location of the evidence in the identified field. This value is inclusive. + */ public var endOffset: Int? - /// An array of entity objects that show evidence of the result. + /** + An array of entity objects that show evidence of the result. + */ public var entities: [QueryEvidenceEntity]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/QueryEvidenceEntity.swift b/Source/DiscoveryV1/Models/QueryEvidenceEntity.swift index d6d6fc218..65a876642 100644 --- a/Source/DiscoveryV1/Models/QueryEvidenceEntity.swift +++ b/Source/DiscoveryV1/Models/QueryEvidenceEntity.swift @@ -19,16 +19,24 @@ import Foundation /** Entity description and location within evidence field. */ public struct QueryEvidenceEntity: Decodable { - /// The entity type for this entity. Possible types vary based on model used. + /** + The entity type for this entity. Possible types vary based on model used. + */ public var type: String? - /// The original text of this entity as found in the evidence field. + /** + The original text of this entity as found in the evidence field. + */ public var text: String? - /// The start location of the entity text in the identified field. This value is inclusive. + /** + The start location of the entity text in the identified field. This value is inclusive. + */ public var startOffset: Int? - /// The end location of the entity text in the identified field. This value is exclusive. + /** + The end location of the entity text in the identified field. This value is exclusive. + */ public var endOffset: Int? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/QueryFilterType.swift b/Source/DiscoveryV1/Models/QueryFilterType.swift index 1e3636426..299f18896 100644 --- a/Source/DiscoveryV1/Models/QueryFilterType.swift +++ b/Source/DiscoveryV1/Models/QueryFilterType.swift @@ -19,10 +19,14 @@ import Foundation /** QueryFilterType. */ public struct QueryFilterType: Encodable { - /// A comma-separated list of types to exclude. + /** + A comma-separated list of types to exclude. + */ public var exclude: [String]? - /// A comma-separated list of types to include. All other types are excluded. + /** + A comma-separated list of types to include. All other types are excluded. + */ public var include: [String]? // Map each property name to the key that shall be used for encoding/decoding. @@ -39,7 +43,11 @@ public struct QueryFilterType: Encodable { - returns: An initialized `QueryFilterType`. */ - public init(exclude: [String]? = nil, include: [String]? = nil) { + public init( + exclude: [String]? = nil, + include: [String]? = nil + ) + { self.exclude = exclude self.include = include } diff --git a/Source/DiscoveryV1/Models/QueryNoticesResult.swift b/Source/DiscoveryV1/Models/QueryNoticesResult.swift index dac202cfb..d2a2709cb 100644 --- a/Source/DiscoveryV1/Models/QueryNoticesResult.swift +++ b/Source/DiscoveryV1/Models/QueryNoticesResult.swift @@ -19,7 +19,9 @@ import Foundation /** QueryNoticesResult. */ public struct QueryNoticesResult: Decodable { - /// The type of the original source file. + /** + The type of the original source file. + */ public enum FileType: String { case pdf = "pdf" case html = "html" @@ -27,34 +29,55 @@ public struct QueryNoticesResult: Decodable { case json = "json" } - /// The unique identifier of the document. + /** + The unique identifier of the document. + */ public var id: String? - /// *Deprecated* This field is now part of the `result_metadata` object. + /** + *Deprecated* This field is now part of the `result_metadata` object. + */ public var score: Double? - /// Metadata of the document. + /** + Metadata of the document. + */ public var metadata: [String: JSON]? - /// The collection ID of the collection containing the document for this result. + /** + The collection ID of the collection containing the document for this result. + */ public var collectionID: String? - /// Metadata of the query result. + /** + Metadata of the query result. + */ public var resultMetadata: QueryResultMetadata? - /// The internal status code returned by the ingestion subsystem indicating the overall result of ingesting the source document. + /** + The internal status code returned by the ingestion subsystem indicating the overall result of ingesting the source + document. + */ public var code: Int? - /// Name of the original source file (if available). + /** + Name of the original source file (if available). + */ public var filename: String? - /// The type of the original source file. + /** + The type of the original source file. + */ public var fileType: String? - /// The SHA-1 hash of the original source file (formatted as a hexadecimal string). + /** + The SHA-1 hash of the original source file (formatted as a hexadecimal string). + */ public var sha1: String? - /// Array of notices for the document. + /** + Array of notices for the document. + */ public var notices: [Notice]? /// Additional properties associated with this model. diff --git a/Source/DiscoveryV1/Models/QueryPassages.swift b/Source/DiscoveryV1/Models/QueryPassages.swift index 2ccc4e10e..928b444cf 100644 --- a/Source/DiscoveryV1/Models/QueryPassages.swift +++ b/Source/DiscoveryV1/Models/QueryPassages.swift @@ -19,22 +19,34 @@ import Foundation /** QueryPassages. */ public struct QueryPassages: Decodable { - /// The unique identifier of the document from which the passage has been extracted. + /** + The unique identifier of the document from which the passage has been extracted. + */ public var documentID: String? - /// The confidence score of the passages's analysis. A higher score indicates greater confidence. + /** + The confidence score of the passages's analysis. A higher score indicates greater confidence. + */ public var passageScore: Double? - /// The content of the extracted passage. + /** + The content of the extracted passage. + */ public var passageText: String? - /// The position of the first character of the extracted passage in the originating field. + /** + The position of the first character of the extracted passage in the originating field. + */ public var startOffset: Int? - /// The position of the last character of the extracted passage in the originating field. + /** + The position of the last character of the extracted passage in the originating field. + */ public var endOffset: Int? - /// The label of the field from which the passage has been extracted. + /** + The label of the field from which the passage has been extracted. + */ public var field: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/QueryRelations.swift b/Source/DiscoveryV1/Models/QueryRelations.swift index 2d048a463..ff2c5794e 100644 --- a/Source/DiscoveryV1/Models/QueryRelations.swift +++ b/Source/DiscoveryV1/Models/QueryRelations.swift @@ -19,28 +19,46 @@ import Foundation /** A respresentation of a relationship query. */ public struct QueryRelations: Encodable { - /// The sorting method for the relationships, can be `score` or `frequency`. `frequency` is the number of unique times each entity is identified. The default is `score`. + /** + The sorting method for the relationships, can be `score` or `frequency`. `frequency` is the number of unique times + each entity is identified. The default is `score`. + */ public enum Sort: String { case score = "score" case frequency = "frequency" } - /// An array of entities to find relationships for. + /** + An array of entities to find relationships for. + */ public var entities: [QueryRelationsEntity]? - /// Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for `London` with the context of `England`. + /** + Entity text to provide context for the queried entity and rank based on that association. For example, if you + wanted to query the city of London in England your query would look for `London` with the context of `England`. + */ public var context: QueryEntitiesContext? - /// The sorting method for the relationships, can be `score` or `frequency`. `frequency` is the number of unique times each entity is identified. The default is `score`. + /** + The sorting method for the relationships, can be `score` or `frequency`. `frequency` is the number of unique times + each entity is identified. The default is `score`. + */ public var sort: String? - /// Filters to apply to the relationship query. + /** + Filters to apply to the relationship query. + */ public var filter: QueryRelationsFilter? - /// The number of results to return. The default is `10`. The maximum is `1000`. + /** + The number of results to return. The default is `10`. The maximum is `1000`. + */ public var count: Int? - /// The number of evidence items to return for each result. The default is `0`. The maximum number of evidence items per query is 10,000. + /** + The number of evidence items to return for each result. The default is `0`. The maximum number of evidence items + per query is 10,000. + */ public var evidenceCount: Int? // Map each property name to the key that shall be used for encoding/decoding. @@ -57,15 +75,26 @@ public struct QueryRelations: Encodable { Initialize a `QueryRelations` with member variables. - parameter entities: An array of entities to find relationships for. - - parameter context: Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for `London` with the context of `England`. - - parameter sort: The sorting method for the relationships, can be `score` or `frequency`. `frequency` is the number of unique times each entity is identified. The default is `score`. + - parameter context: Entity text to provide context for the queried entity and rank based on that association. For example, if you + wanted to query the city of London in England your query would look for `London` with the context of `England`. + - parameter sort: The sorting method for the relationships, can be `score` or `frequency`. `frequency` is the number of unique + times each entity is identified. The default is `score`. - parameter filter: Filters to apply to the relationship query. - parameter count: The number of results to return. The default is `10`. The maximum is `1000`. - - parameter evidenceCount: The number of evidence items to return for each result. The default is `0`. The maximum number of evidence items per query is 10,000. + - parameter evidenceCount: The number of evidence items to return for each result. The default is `0`. The maximum number of evidence items + per query is 10,000. - returns: An initialized `QueryRelations`. */ - public init(entities: [QueryRelationsEntity]? = nil, context: QueryEntitiesContext? = nil, sort: String? = nil, filter: QueryRelationsFilter? = nil, count: Int? = nil, evidenceCount: Int? = nil) { + public init( + entities: [QueryRelationsEntity]? = nil, + context: QueryEntitiesContext? = nil, + sort: String? = nil, + filter: QueryRelationsFilter? = nil, + count: Int? = nil, + evidenceCount: Int? = nil + ) + { self.entities = entities self.context = context self.sort = sort diff --git a/Source/DiscoveryV1/Models/QueryRelationsEntity.swift b/Source/DiscoveryV1/Models/QueryRelationsEntity.swift index e61da2bc8..0cdb566f3 100644 --- a/Source/DiscoveryV1/Models/QueryRelationsEntity.swift +++ b/Source/DiscoveryV1/Models/QueryRelationsEntity.swift @@ -19,13 +19,19 @@ import Foundation /** QueryRelationsEntity. */ public struct QueryRelationsEntity: Encodable { - /// Entity text content. + /** + Entity text content. + */ public var text: String? - /// The type of the specified entity. + /** + The type of the specified entity. + */ public var type: String? - /// If false, implicit querying is performed. The default is `false`. + /** + If false, implicit querying is performed. The default is `false`. + */ public var exact: Bool? // Map each property name to the key that shall be used for encoding/decoding. @@ -44,7 +50,12 @@ public struct QueryRelationsEntity: Encodable { - returns: An initialized `QueryRelationsEntity`. */ - public init(text: String? = nil, type: String? = nil, exact: Bool? = nil) { + public init( + text: String? = nil, + type: String? = nil, + exact: Bool? = nil + ) + { self.text = text self.type = type self.exact = exact diff --git a/Source/DiscoveryV1/Models/QueryRelationsFilter.swift b/Source/DiscoveryV1/Models/QueryRelationsFilter.swift index 3a78f1ca4..40ee6ab7b 100644 --- a/Source/DiscoveryV1/Models/QueryRelationsFilter.swift +++ b/Source/DiscoveryV1/Models/QueryRelationsFilter.swift @@ -19,13 +19,19 @@ import Foundation /** QueryRelationsFilter. */ public struct QueryRelationsFilter: Encodable { - /// A list of relation types to include or exclude from the query. + /** + A list of relation types to include or exclude from the query. + */ public var relationTypes: QueryFilterType? - /// A list of entity types to include or exclude from the query. + /** + A list of entity types to include or exclude from the query. + */ public var entityTypes: QueryFilterType? - /// A comma-separated list of document IDs to include in the query. + /** + A comma-separated list of document IDs to include in the query. + */ public var documentIds: [String]? // Map each property name to the key that shall be used for encoding/decoding. @@ -44,7 +50,12 @@ public struct QueryRelationsFilter: Encodable { - returns: An initialized `QueryRelationsFilter`. */ - public init(relationTypes: QueryFilterType? = nil, entityTypes: QueryFilterType? = nil, documentIds: [String]? = nil) { + public init( + relationTypes: QueryFilterType? = nil, + entityTypes: QueryFilterType? = nil, + documentIds: [String]? = nil + ) + { self.relationTypes = relationTypes self.entityTypes = entityTypes self.documentIds = documentIds diff --git a/Source/DiscoveryV1/Models/QueryRelationsRelationship.swift b/Source/DiscoveryV1/Models/QueryRelationsRelationship.swift index aae0e5f26..dabd29615 100644 --- a/Source/DiscoveryV1/Models/QueryRelationsRelationship.swift +++ b/Source/DiscoveryV1/Models/QueryRelationsRelationship.swift @@ -19,16 +19,24 @@ import Foundation /** QueryRelationsRelationship. */ public struct QueryRelationsRelationship: Decodable { - /// The identified relationship type. + /** + The identified relationship type. + */ public var type: String? - /// The number of times the relationship is mentioned. + /** + The number of times the relationship is mentioned. + */ public var frequency: Int? - /// Information about the relationship. + /** + Information about the relationship. + */ public var arguments: [QueryRelationsArgument]? - /// List of different evidentiary items to support the result. + /** + List of different evidentiary items to support the result. + */ public var evidence: [QueryEvidence]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/QueryResult.swift b/Source/DiscoveryV1/Models/QueryResult.swift index 592c35e97..b10638b2d 100644 --- a/Source/DiscoveryV1/Models/QueryResult.swift +++ b/Source/DiscoveryV1/Models/QueryResult.swift @@ -19,19 +19,29 @@ import Foundation /** QueryResult. */ public struct QueryResult: Decodable { - /// The unique identifier of the document. + /** + The unique identifier of the document. + */ public var id: String? - /// *Deprecated* This field is now part of the `result_metadata` object. + /** + *Deprecated* This field is now part of the `result_metadata` object. + */ public var score: Double? - /// Metadata of the document. + /** + Metadata of the document. + */ public var metadata: [String: JSON]? - /// The collection ID of the collection containing the document for this result. + /** + The collection ID of the collection containing the document for this result. + */ public var collectionID: String? - /// Metadata of the query result. + /** + Metadata of the query result. + */ public var resultMetadata: QueryResultMetadata? /// Additional properties associated with this model. diff --git a/Source/DiscoveryV1/Models/QueryResultMetadata.swift b/Source/DiscoveryV1/Models/QueryResultMetadata.swift index 3a5645846..dc51b3c12 100644 --- a/Source/DiscoveryV1/Models/QueryResultMetadata.swift +++ b/Source/DiscoveryV1/Models/QueryResultMetadata.swift @@ -19,7 +19,9 @@ import Foundation /** Metadata of a query result. */ public struct QueryResultMetadata: Decodable { - /// The confidence score of the result's analysis. A higher score indicating greater confidence. + /** + The confidence score of the result's analysis. A higher score indicating greater confidence. + */ public var score: Double? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/SegmentSettings.swift b/Source/DiscoveryV1/Models/SegmentSettings.swift index aa6dc106f..2dfbd596e 100644 --- a/Source/DiscoveryV1/Models/SegmentSettings.swift +++ b/Source/DiscoveryV1/Models/SegmentSettings.swift @@ -19,10 +19,14 @@ import Foundation /** A list of Document Segmentation settings. */ public struct SegmentSettings: Codable { - /// Enables/disables the Document Segmentation feature. + /** + Enables/disables the Document Segmentation feature. + */ public var enabled: Bool? - /// Defines the heading level that splits into document segments. Valid values are h1, h2, h3, h4, h5, h6. + /** + Defines the heading level that splits into document segments. Valid values are h1, h2, h3, h4, h5, h6. + */ public var selectorTags: [String]? // Map each property name to the key that shall be used for encoding/decoding. @@ -39,7 +43,11 @@ public struct SegmentSettings: Codable { - returns: An initialized `SegmentSettings`. */ - public init(enabled: Bool? = nil, selectorTags: [String]? = nil) { + public init( + enabled: Bool? = nil, + selectorTags: [String]? = nil + ) + { self.enabled = enabled self.selectorTags = selectorTags } diff --git a/Source/DiscoveryV1/Models/Term.swift b/Source/DiscoveryV1/Models/Term.swift index 1d793290d..cb7a48cca 100644 --- a/Source/DiscoveryV1/Models/Term.swift +++ b/Source/DiscoveryV1/Models/Term.swift @@ -19,18 +19,26 @@ import Foundation /** Term. */ public struct Term: Decodable { - /// The type of aggregation command used. For example: term, filter, max, min, etc. + /** + The type of aggregation command used. For example: term, filter, max, min, etc. + */ public var type: String? public var results: [AggregationResult]? - /// Number of matching results. + /** + Number of matching results. + */ public var matchingResults: Int? - /// Aggregations returned by the Discovery service. + /** + Aggregations returned by the Discovery service. + */ public var aggregations: [QueryAggregation]? - /// The field where the aggregation is located in the document. + /** + The field where the aggregation is located in the document. + */ public var field: String? public var count: Int? diff --git a/Source/DiscoveryV1/Models/TestDocument.swift b/Source/DiscoveryV1/Models/TestDocument.swift index efe6cfb0f..839f70da5 100644 --- a/Source/DiscoveryV1/Models/TestDocument.swift +++ b/Source/DiscoveryV1/Models/TestDocument.swift @@ -19,22 +19,35 @@ import Foundation /** TestDocument. */ public struct TestDocument: Decodable { - /// The unique identifier for the configuration. + /** + The unique identifier for the configuration. + */ public var configurationID: String? - /// Status of the preview operation. + /** + Status of the preview operation. + */ public var status: String? - /// The number of 10-kB chunks of field data that were enriched. This can be used to estimate the cost of running a real ingestion. + /** + The number of 10-kB chunks of field data that were enriched. This can be used to estimate the cost of running a + real ingestion. + */ public var enrichedFieldUnits: Int? - /// Format of the test document. + /** + Format of the test document. + */ public var originalMediaType: String? - /// An array of objects that describe each step in the preview process. + /** + An array of objects that describe each step in the preview process. + */ public var snapshots: [DocumentSnapshot]? - /// An array of notice messages about the preview operation. + /** + An array of notice messages about the preview operation. + */ public var notices: [Notice]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/Timeslice.swift b/Source/DiscoveryV1/Models/Timeslice.swift index 882337c4c..48b782a1a 100644 --- a/Source/DiscoveryV1/Models/Timeslice.swift +++ b/Source/DiscoveryV1/Models/Timeslice.swift @@ -19,24 +19,38 @@ import Foundation /** Timeslice. */ public struct Timeslice: Decodable { - /// The type of aggregation command used. For example: term, filter, max, min, etc. + /** + The type of aggregation command used. For example: term, filter, max, min, etc. + */ public var type: String? public var results: [AggregationResult]? - /// Number of matching results. + /** + Number of matching results. + */ public var matchingResults: Int? - /// Aggregations returned by the Discovery service. + /** + Aggregations returned by the Discovery service. + */ public var aggregations: [QueryAggregation]? - /// The field where the aggregation is located in the document. + /** + The field where the aggregation is located in the document. + */ public var field: String? - /// Interval of the aggregation. Valid date interval values are second/seconds minute/minutes, hour/hours, day/days, week/weeks, month/months, and year/years. + /** + Interval of the aggregation. Valid date interval values are second/seconds minute/minutes, hour/hours, day/days, + week/weeks, month/months, and year/years. + */ public var interval: String? - /// Used to inducate that anomaly detection should be performed. Anomaly detection is used to locate unusual datapoints within a time series. + /** + Used to inducate that anomaly detection should be performed. Anomaly detection is used to locate unusual datapoints + within a time series. + */ public var anomaly: Bool? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/TopHits.swift b/Source/DiscoveryV1/Models/TopHits.swift index 3adaf4baf..a7381a8c6 100644 --- a/Source/DiscoveryV1/Models/TopHits.swift +++ b/Source/DiscoveryV1/Models/TopHits.swift @@ -19,18 +19,26 @@ import Foundation /** TopHits. */ public struct TopHits: Decodable { - /// The type of aggregation command used. For example: term, filter, max, min, etc. + /** + The type of aggregation command used. For example: term, filter, max, min, etc. + */ public var type: String? public var results: [AggregationResult]? - /// Number of matching results. + /** + Number of matching results. + */ public var matchingResults: Int? - /// Aggregations returned by the Discovery service. + /** + Aggregations returned by the Discovery service. + */ public var aggregations: [QueryAggregation]? - /// Number of top hits returned by the aggregation. + /** + Number of top hits returned by the aggregation. + */ public var size: Int? public var hits: TopHitsResults? diff --git a/Source/DiscoveryV1/Models/TopHitsResults.swift b/Source/DiscoveryV1/Models/TopHitsResults.swift index 11f5b642b..360ca2c3a 100644 --- a/Source/DiscoveryV1/Models/TopHitsResults.swift +++ b/Source/DiscoveryV1/Models/TopHitsResults.swift @@ -19,10 +19,14 @@ import Foundation /** TopHitsResults. */ public struct TopHitsResults: Decodable { - /// Number of matching results. + /** + Number of matching results. + */ public var matchingResults: Int? - /// Top results returned by the aggregation. + /** + Top results returned by the aggregation. + */ public var hits: [QueryResult]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/DiscoveryV1/Models/TrainingExample.swift b/Source/DiscoveryV1/Models/TrainingExample.swift index 31ae8dda4..08814d65f 100644 --- a/Source/DiscoveryV1/Models/TrainingExample.swift +++ b/Source/DiscoveryV1/Models/TrainingExample.swift @@ -41,7 +41,12 @@ public struct TrainingExample: Codable { - returns: An initialized `TrainingExample`. */ - public init(documentID: String? = nil, crossReference: String? = nil, relevance: Int? = nil) { + public init( + documentID: String? = nil, + crossReference: String? = nil, + relevance: Int? = nil + ) + { self.documentID = documentID self.crossReference = crossReference self.relevance = relevance diff --git a/Source/DiscoveryV1/Models/TrainingExamplePatch.swift b/Source/DiscoveryV1/Models/TrainingExamplePatch.swift index 76912a4cc..6bf3d0d5e 100644 --- a/Source/DiscoveryV1/Models/TrainingExamplePatch.swift +++ b/Source/DiscoveryV1/Models/TrainingExamplePatch.swift @@ -37,7 +37,11 @@ internal struct TrainingExamplePatch: Encodable { - returns: An initialized `TrainingExamplePatch`. */ - public init(crossReference: String? = nil, relevance: Int? = nil) { + public init( + crossReference: String? = nil, + relevance: Int? = nil + ) + { self.crossReference = crossReference self.relevance = relevance } diff --git a/Source/DiscoveryV1/Models/UpdateCollectionRequest.swift b/Source/DiscoveryV1/Models/UpdateCollectionRequest.swift index 941e2ffd7..f207aecd8 100644 --- a/Source/DiscoveryV1/Models/UpdateCollectionRequest.swift +++ b/Source/DiscoveryV1/Models/UpdateCollectionRequest.swift @@ -19,13 +19,19 @@ import Foundation /** UpdateCollectionRequest. */ internal struct UpdateCollectionRequest: Encodable { - /// The name of the collection. + /** + The name of the collection. + */ public var name: String - /// A description of the collection. + /** + A description of the collection. + */ public var description: String? - /// The ID of the configuration in which the collection is to be updated. + /** + The ID of the configuration in which the collection is to be updated. + */ public var configurationID: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -44,7 +50,12 @@ internal struct UpdateCollectionRequest: Encodable { - returns: An initialized `UpdateCollectionRequest`. */ - public init(name: String, description: String? = nil, configurationID: String? = nil) { + public init( + name: String, + description: String? = nil, + configurationID: String? = nil + ) + { self.name = name self.description = description self.configurationID = configurationID diff --git a/Source/DiscoveryV1/Models/UpdateEnvironmentRequest.swift b/Source/DiscoveryV1/Models/UpdateEnvironmentRequest.swift index bd7426afa..6ed15a0a5 100644 --- a/Source/DiscoveryV1/Models/UpdateEnvironmentRequest.swift +++ b/Source/DiscoveryV1/Models/UpdateEnvironmentRequest.swift @@ -19,10 +19,14 @@ import Foundation /** UpdateEnvironmentRequest. */ internal struct UpdateEnvironmentRequest: Encodable { - /// Name that identifies the environment. + /** + Name that identifies the environment. + */ public var name: String? - /// Description of the environment. + /** + Description of the environment. + */ public var description: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -39,7 +43,11 @@ internal struct UpdateEnvironmentRequest: Encodable { - returns: An initialized `UpdateEnvironmentRequest`. */ - public init(name: String? = nil, description: String? = nil) { + public init( + name: String? = nil, + description: String? = nil + ) + { self.name = name self.description = description } diff --git a/Source/DiscoveryV1/Models/WordHeadingDetection.swift b/Source/DiscoveryV1/Models/WordHeadingDetection.swift index e91c71ca0..636028827 100644 --- a/Source/DiscoveryV1/Models/WordHeadingDetection.swift +++ b/Source/DiscoveryV1/Models/WordHeadingDetection.swift @@ -37,7 +37,11 @@ public struct WordHeadingDetection: Codable { - returns: An initialized `WordHeadingDetection`. */ - public init(fonts: [FontSetting]? = nil, styles: [WordStyle]? = nil) { + public init( + fonts: [FontSetting]? = nil, + styles: [WordStyle]? = nil + ) + { self.fonts = fonts self.styles = styles } diff --git a/Source/DiscoveryV1/Models/WordSettings.swift b/Source/DiscoveryV1/Models/WordSettings.swift index 57a7fc5d5..ca7bfa818 100644 --- a/Source/DiscoveryV1/Models/WordSettings.swift +++ b/Source/DiscoveryV1/Models/WordSettings.swift @@ -33,7 +33,10 @@ public struct WordSettings: Codable { - returns: An initialized `WordSettings`. */ - public init(heading: WordHeadingDetection? = nil) { + public init( + heading: WordHeadingDetection? = nil + ) + { self.heading = heading } diff --git a/Source/DiscoveryV1/Models/WordStyle.swift b/Source/DiscoveryV1/Models/WordStyle.swift index 9a11cd28c..f69f88b24 100644 --- a/Source/DiscoveryV1/Models/WordStyle.swift +++ b/Source/DiscoveryV1/Models/WordStyle.swift @@ -37,7 +37,11 @@ public struct WordStyle: Codable { - returns: An initialized `WordStyle`. */ - public init(level: Int? = nil, names: [String]? = nil) { + public init( + level: Int? = nil, + names: [String]? = nil + ) + { self.level = level self.names = names } diff --git a/Source/DiscoveryV1/Models/XPathPatterns.swift b/Source/DiscoveryV1/Models/XPathPatterns.swift index 85cbd2a13..435e1d35f 100644 --- a/Source/DiscoveryV1/Models/XPathPatterns.swift +++ b/Source/DiscoveryV1/Models/XPathPatterns.swift @@ -33,7 +33,10 @@ public struct XPathPatterns: Codable { - returns: An initialized `XPathPatterns`. */ - public init(xpaths: [String]? = nil) { + public init( + xpaths: [String]? = nil + ) + { self.xpaths = xpaths } diff --git a/Source/LanguageTranslatorV2/LanguageTranslator.swift b/Source/LanguageTranslatorV2/LanguageTranslator.swift index 5e72b914f..34bef62de 100644 --- a/Source/LanguageTranslatorV2/LanguageTranslator.swift +++ b/Source/LanguageTranslatorV2/LanguageTranslator.swift @@ -17,7 +17,7 @@ import Foundation /** - IBM Watson Language Translator translates text from one language to another. The service offers multiple + IBM Watson™ Language Translator translates text from one language to another. The service offers multiple domain-specific models that you can customize based on your unique terminology and language. Use Language Translator to take news from across the globe and present it in your language, communicate with your customers in their own language, and more. @@ -255,8 +255,8 @@ public class LanguageTranslator { - parameter source: Specify a language code to filter results by source language. - parameter target: Specify a language code to filter results by target language. - parameter defaultModels: If the default parameter isn't specified, the service will return all models (default and non-default) for each - language pair. To return only default models, set this to `true`. To return only non-default models, set this to - `false`. + language pair. To return only default models, set this to `true`. To return only non-default models, set this to + `false`. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -313,17 +313,18 @@ public class LanguageTranslator { /** Create model. - Uploads a TMX glossary file on top of a domain to customize a translation model. Depending on the size of the - file, training can range from minutes for a glossary to several hours for a large parallel corpus. Glossary files - must be less than 10 MB. The cumulative file size of all uploaded glossary and corpus files is limited to 250 MB. + Uploads a TMX glossary file on top of a domain to customize a translation model. + Depending on the size of the file, training can range from minutes for a glossary to several hours for a large + parallel corpus. Glossary files must be less than 10 MB. The cumulative file size of all uploaded glossary and + corpus files is limited to 250 MB. - parameter baseModelID: The model ID of the model to use as the base for customization. To see available models, use the `List models` - method. + method. - parameter name: An optional model name that you can use to identify the model. Valid characters are letters, numbers, dashes, - underscores, spaces and apostrophes. The maximum length is 32 characters. + underscores, spaces and apostrophes. The maximum length is 32 characters. - parameter forcedGlossary: A TMX file with your customizations. The customizations in the file completely overwrite the domain translaton - data, including high frequency or high confidence phrase translations. You can upload only one glossary with a file - size less than 10 MB per call. + data, including high frequency or high confidence phrase translations. You can upload only one glossary with a + file size less than 10 MB per call. - parameter parallelCorpus: A TMX file that contains entries that are treated as a parallel corpus instead of a glossary. - parameter monolingualCorpus: A UTF-8 encoded plain text file that is used to customize the target language model. - parameter headers: A dictionary of request headers to be sent with this request. diff --git a/Source/LanguageTranslatorV2/Models/DeleteModelResult.swift b/Source/LanguageTranslatorV2/Models/DeleteModelResult.swift index efc8bc0e0..bff50deaf 100644 --- a/Source/LanguageTranslatorV2/Models/DeleteModelResult.swift +++ b/Source/LanguageTranslatorV2/Models/DeleteModelResult.swift @@ -19,7 +19,9 @@ import Foundation /** DeleteModelResult. */ public struct DeleteModelResult: Decodable { - /// "OK" indicates that the model was successfully deleted. + /** + "OK" indicates that the model was successfully deleted. + */ public var status: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/LanguageTranslatorV2/Models/IdentifiableLanguage.swift b/Source/LanguageTranslatorV2/Models/IdentifiableLanguage.swift index 03f098866..bef9b15d7 100644 --- a/Source/LanguageTranslatorV2/Models/IdentifiableLanguage.swift +++ b/Source/LanguageTranslatorV2/Models/IdentifiableLanguage.swift @@ -19,10 +19,14 @@ import Foundation /** IdentifiableLanguage. */ public struct IdentifiableLanguage: Decodable { - /// The language code for an identifiable language. + /** + The language code for an identifiable language. + */ public var language: String - /// The name of the identifiable language. + /** + The name of the identifiable language. + */ public var name: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/LanguageTranslatorV2/Models/IdentifiableLanguages.swift b/Source/LanguageTranslatorV2/Models/IdentifiableLanguages.swift index 42577a3c1..1f184d813 100644 --- a/Source/LanguageTranslatorV2/Models/IdentifiableLanguages.swift +++ b/Source/LanguageTranslatorV2/Models/IdentifiableLanguages.swift @@ -19,7 +19,9 @@ import Foundation /** IdentifiableLanguages. */ public struct IdentifiableLanguages: Decodable { - /// A list of all languages that the service can identify. + /** + A list of all languages that the service can identify. + */ public var languages: [IdentifiableLanguage] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/LanguageTranslatorV2/Models/IdentifiedLanguage.swift b/Source/LanguageTranslatorV2/Models/IdentifiedLanguage.swift index 8cfa69ec0..442b80ec8 100644 --- a/Source/LanguageTranslatorV2/Models/IdentifiedLanguage.swift +++ b/Source/LanguageTranslatorV2/Models/IdentifiedLanguage.swift @@ -19,10 +19,14 @@ import Foundation /** IdentifiedLanguage. */ public struct IdentifiedLanguage: Decodable { - /// The language code for an identified language. + /** + The language code for an identified language. + */ public var language: String - /// The confidence score for the identified language. + /** + The confidence score for the identified language. + */ public var confidence: Double // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/LanguageTranslatorV2/Models/IdentifiedLanguages.swift b/Source/LanguageTranslatorV2/Models/IdentifiedLanguages.swift index 3f1cd0c9a..d1aedf73e 100644 --- a/Source/LanguageTranslatorV2/Models/IdentifiedLanguages.swift +++ b/Source/LanguageTranslatorV2/Models/IdentifiedLanguages.swift @@ -19,7 +19,9 @@ import Foundation /** IdentifiedLanguages. */ public struct IdentifiedLanguages: Decodable { - /// A ranking of identified languages with confidence scores. + /** + A ranking of identified languages with confidence scores. + */ public var languages: [IdentifiedLanguage] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/LanguageTranslatorV2/Models/TranslateRequest.swift b/Source/LanguageTranslatorV2/Models/TranslateRequest.swift index 5f210d5f8..98616d98c 100644 --- a/Source/LanguageTranslatorV2/Models/TranslateRequest.swift +++ b/Source/LanguageTranslatorV2/Models/TranslateRequest.swift @@ -19,16 +19,28 @@ import Foundation /** TranslateRequest. */ public struct TranslateRequest: Encodable { - /// Input text in UTF-8 encoding. Multiple entries will result in multiple translations in the response. + /** + Input text in UTF-8 encoding. Multiple entries will result in multiple translations in the response. + */ public var text: [String] - /// Model ID of the translation model to use. If this is specified, the **source** and **target** parameters will be ignored. The method requires either a model ID or both the **source** and **target** parameters. + /** + Model ID of the translation model to use. If this is specified, the **source** and **target** parameters will be + ignored. The method requires either a model ID or both the **source** and **target** parameters. + */ public var modelID: String? - /// Language code of the source text language. Use with `target` as an alternative way to select a translation model. When `source` and `target` are set, and a model ID is not set, the system chooses a default model for the language pair (usually the model based on the news domain). + /** + Language code of the source text language. Use with `target` as an alternative way to select a translation model. + When `source` and `target` are set, and a model ID is not set, the system chooses a default model for the language + pair (usually the model based on the news domain). + */ public var source: String? - /// Language code of the translation target language. Use with source as an alternative way to select a translation model. + /** + Language code of the translation target language. Use with source as an alternative way to select a translation + model. + */ public var target: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -43,13 +55,23 @@ public struct TranslateRequest: Encodable { Initialize a `TranslateRequest` with member variables. - parameter text: Input text in UTF-8 encoding. Multiple entries will result in multiple translations in the response. - - parameter modelID: Model ID of the translation model to use. If this is specified, the **source** and **target** parameters will be ignored. The method requires either a model ID or both the **source** and **target** parameters. - - parameter source: Language code of the source text language. Use with `target` as an alternative way to select a translation model. When `source` and `target` are set, and a model ID is not set, the system chooses a default model for the language pair (usually the model based on the news domain). - - parameter target: Language code of the translation target language. Use with source as an alternative way to select a translation model. + - parameter modelID: Model ID of the translation model to use. If this is specified, the **source** and **target** parameters will be + ignored. The method requires either a model ID or both the **source** and **target** parameters. + - parameter source: Language code of the source text language. Use with `target` as an alternative way to select a translation model. + When `source` and `target` are set, and a model ID is not set, the system chooses a default model for the + language pair (usually the model based on the news domain). + - parameter target: Language code of the translation target language. Use with source as an alternative way to select a translation + model. - returns: An initialized `TranslateRequest`. */ - public init(text: [String], modelID: String? = nil, source: String? = nil, target: String? = nil) { + public init( + text: [String], + modelID: String? = nil, + source: String? = nil, + target: String? = nil + ) + { self.text = text self.modelID = modelID self.source = source diff --git a/Source/LanguageTranslatorV2/Models/Translation.swift b/Source/LanguageTranslatorV2/Models/Translation.swift index 257aaf4ec..cb9742e98 100644 --- a/Source/LanguageTranslatorV2/Models/Translation.swift +++ b/Source/LanguageTranslatorV2/Models/Translation.swift @@ -19,7 +19,9 @@ import Foundation /** Translation. */ public struct Translation: Decodable { - /// Translation output in UTF-8. + /** + Translation output in UTF-8. + */ public var translationOutput: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/LanguageTranslatorV2/Models/TranslationModel.swift b/Source/LanguageTranslatorV2/Models/TranslationModel.swift index 422261d52..37fe554f2 100644 --- a/Source/LanguageTranslatorV2/Models/TranslationModel.swift +++ b/Source/LanguageTranslatorV2/Models/TranslationModel.swift @@ -19,7 +19,9 @@ import Foundation /** Response payload for models. */ public struct TranslationModel: Decodable { - /// Availability of a model. + /** + Availability of a model. + */ public enum Status: String { case uploading = "uploading" case uploaded = "uploaded" @@ -33,34 +35,58 @@ public struct TranslationModel: Decodable { case error = "error" } - /// A globally unique string that identifies the underlying model that is used for translation. + /** + A globally unique string that identifies the underlying model that is used for translation. + */ public var modelID: String - /// Optional name that can be specified when the model is created. + /** + Optional name that can be specified when the model is created. + */ public var name: String? - /// Translation source language code. + /** + Translation source language code. + */ public var source: String? - /// Translation target language code. + /** + Translation target language code. + */ public var target: String? - /// Model ID of the base model that was used to customize the model. If the model is not a custom model, this will be an empty string. + /** + Model ID of the base model that was used to customize the model. If the model is not a custom model, this will be + an empty string. + */ public var baseModelID: String? - /// The domain of the translation model. + /** + The domain of the translation model. + */ public var domain: String? - /// Whether this model can be used as a base for customization. Customized models are not further customizable, and some base models are not customizable. + /** + Whether this model can be used as a base for customization. Customized models are not further customizable, and + some base models are not customizable. + */ public var customizable: Bool? - /// Whether or not the model is a default model. A default model is the model for a given language pair that will be used when that language pair is specified in the source and target parameters. + /** + Whether or not the model is a default model. A default model is the model for a given language pair that will be + used when that language pair is specified in the source and target parameters. + */ public var defaultModel: Bool? - /// Either an empty string, indicating the model is not a custom model, or the ID of the service instance that created the model. + /** + Either an empty string, indicating the model is not a custom model, or the ID of the service instance that created + the model. + */ public var owner: String? - /// Availability of a model. + /** + Availability of a model. + */ public var status: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/LanguageTranslatorV2/Models/TranslationModels.swift b/Source/LanguageTranslatorV2/Models/TranslationModels.swift index 9932ed4f2..aa7be5182 100644 --- a/Source/LanguageTranslatorV2/Models/TranslationModels.swift +++ b/Source/LanguageTranslatorV2/Models/TranslationModels.swift @@ -19,7 +19,9 @@ import Foundation /** The response type for listing existing translation models. */ public struct TranslationModels: Decodable { - /// An array of available models. + /** + An array of available models. + */ public var models: [TranslationModel] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/LanguageTranslatorV2/Models/TranslationResult.swift b/Source/LanguageTranslatorV2/Models/TranslationResult.swift index bc5675c17..210c0daff 100644 --- a/Source/LanguageTranslatorV2/Models/TranslationResult.swift +++ b/Source/LanguageTranslatorV2/Models/TranslationResult.swift @@ -19,13 +19,19 @@ import Foundation /** TranslationResult. */ public struct TranslationResult: Decodable { - /// Number of words in the input text. + /** + Number of words in the input text. + */ public var wordCount: Int - /// Number of characters in the input text. + /** + Number of characters in the input text. + */ public var characterCount: Int - /// List of translation output in UTF-8, corresponding to the input text entries. + /** + List of translation output in UTF-8, corresponding to the input text entries. + */ public var translations: [Translation] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/LanguageTranslatorV3/LanguageTranslator.swift b/Source/LanguageTranslatorV3/LanguageTranslator.swift new file mode 100644 index 000000000..4d02cd384 --- /dev/null +++ b/Source/LanguageTranslatorV3/LanguageTranslator.swift @@ -0,0 +1,530 @@ +/** + * Copyright IBM Corporation 2018 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + +import Foundation + +/** + IBM Watson™ Language Translator translates text from one language to another. The service offers multiple IBM + provided translation models that you can customize based on your unique terminology and language. Use Language + Translator to take news from across the globe and present it in your language, communicate with your customers in their + own language, and more. + */ +public class LanguageTranslator { + + /// The base URL to use when contacting the service. + public var serviceURL = "https://gateway.watsonplatform.net/language-translator/api" + + /// The default HTTP headers for all requests to the service. + public var defaultHeaders = [String: String]() + + private var authMethod: AuthenticationMethod + private let domain = "com.ibm.watson.developer-cloud.LanguageTranslatorV3" + private let version: String + + /** + Create a `LanguageTranslator` object. + + - parameter username: The username used to authenticate with the service. + - parameter password: The password used to authenticate with the service. + - parameter version: The release date of the version of the API to use. Specify the date + in "YYYY-MM-DD" format. + */ + public init(username: String, password: String, version: String) { + self.authMethod = BasicAuthentication(username: username, password: password) + self.version = version + } + + /** + Create a `LanguageTranslator` object. + + - parameter version: The release date of the version of the API to use. Specify the date + in "YYYY-MM-DD" format. + - parameter apiKey: An API key for IAM that can be used to obtain access tokens for the service. + - parameter iamUrl: The URL for the IAM service. + */ + public init(version: String, apiKey: String, iamUrl: String? = nil) { + self.version = version + self.authMethod = IAMAuthentication(apiKey: apiKey, url: iamUrl) + } + + /** + Create a `LanguageTranslator` object. + + - parameter version: The release date of the version of the API to use. Specify the date + in "YYYY-MM-DD" format. + - parameter accessToken: An access token for the service. + */ + public init(version: String, accessToken: String) { + self.version = version + self.authMethod = IAMAccessToken(accessToken: accessToken) + } + + public func accessToken(_ newToken: String) { + if self.authMethod is IAMAccessToken { + self.authMethod = IAMAccessToken(accessToken: newToken) + } + } + + /** + If the response or data represents an error returned by the Language Translator service, + then return NSError with information about the error that occured. Otherwise, return nil. + + - parameter response: the URL response returned from the service. + - parameter data: Raw data returned from the service that may represent an error. + */ + private func responseToError(response: HTTPURLResponse?, data: Data?) -> NSError? { + + // First check http status code in response + if let response = response { + if (200..<300).contains(response.statusCode) { + return nil + } + } + + // ensure data is not nil + guard let data = data else { + if let code = response?.statusCode { + return NSError(domain: domain, code: code, userInfo: nil) + } + return nil // RestKit will generate error for this case + } + + let code = response?.statusCode ?? 400 + do { + let json = try JSONDecoder().decode([String: JSON].self, from: data) + var userInfo: [String: Any] = [:] + if case let .some(.string(message)) = json["error"] { + userInfo[NSLocalizedDescriptionKey] = message + } + return NSError(domain: domain, code: code, userInfo: userInfo) + } catch { + return NSError(domain: domain, code: code, userInfo: nil) + } + } + + /** + Translate. + + Translates the input text from the source language to the target language. + + - parameter request: The translate request containing the text, and either a model ID or source and target language pair. + - parameter headers: A dictionary of request headers to be sent with this request. + - parameter failure: A function executed if an error occurs. + - parameter success: A function executed with the successful result. + */ + public func translate( + request: TranslateRequest, + headers: [String: String]? = nil, + failure: ((Error) -> Void)? = nil, + success: @escaping (TranslationResult) -> Void) + { + // construct body + guard let body = try? JSONEncoder().encode(request) else { + failure?(RestError.serializationError) + return + } + + // construct header parameters + var headerParameters = defaultHeaders + if let headers = headers { + headerParameters.merge(headers) { (_, new) in new } + } + headerParameters["Accept"] = "application/json" + headerParameters["Content-Type"] = "application/json" + + // construct query parameters + var queryParameters = [URLQueryItem]() + queryParameters.append(URLQueryItem(name: "version", value: version)) + + // construct REST request + let request = RestRequest( + method: "POST", + url: serviceURL + "/v3/translate", + authMethod: authMethod, + headerParameters: headerParameters, + queryItems: queryParameters, + messageBody: body + ) + + // execute REST request + request.responseObject(responseToError: responseToError) { + (response: RestResponse) in + switch response.result { + case .success(let retval): success(retval) + case .failure(let error): failure?(error) + } + } + } + + /** + List identifiable languages. + + Lists the languages that the service can identify. Returns the language code (for example, `en` for English or `es` + for Spanish) and name of each language. + + - parameter headers: A dictionary of request headers to be sent with this request. + - parameter failure: A function executed if an error occurs. + - parameter success: A function executed with the successful result. + */ + public func listIdentifiableLanguages( + headers: [String: String]? = nil, + failure: ((Error) -> Void)? = nil, + success: @escaping (IdentifiableLanguages) -> Void) + { + // construct header parameters + var headerParameters = defaultHeaders + if let headers = headers { + headerParameters.merge(headers) { (_, new) in new } + } + headerParameters["Accept"] = "application/json" + + // construct query parameters + var queryParameters = [URLQueryItem]() + queryParameters.append(URLQueryItem(name: "version", value: version)) + + // construct REST request + let request = RestRequest( + method: "GET", + url: serviceURL + "/v3/identifiable_languages", + authMethod: authMethod, + headerParameters: headerParameters, + queryItems: queryParameters + ) + + // execute REST request + request.responseObject(responseToError: responseToError) { + (response: RestResponse) in + switch response.result { + case .success(let retval): success(retval) + case .failure(let error): failure?(error) + } + } + } + + /** + Identify language. + + Identifies the language of the input text. + + - parameter text: Input text in UTF-8 format. + - parameter headers: A dictionary of request headers to be sent with this request. + - parameter failure: A function executed if an error occurs. + - parameter success: A function executed with the successful result. + */ + public func identify( + text: String, + headers: [String: String]? = nil, + failure: ((Error) -> Void)? = nil, + success: @escaping (IdentifiedLanguages) -> Void) + { + // construct body + // convert body parameter to NSData with UTF-8 encoding + guard let body = text.data(using: .utf8) else { + let message = "text could not be encoded to NSData with NSUTF8StringEncoding." + let userInfo = [NSLocalizedDescriptionKey: message] + let error = NSError(domain: domain, code: 0, userInfo: userInfo) + failure?(error) + return + } + + // construct header parameters + var headerParameters = defaultHeaders + if let headers = headers { + headerParameters.merge(headers) { (_, new) in new } + } + headerParameters["Accept"] = "application/json" + headerParameters["Content-Type"] = "text/plain" + + // construct query parameters + var queryParameters = [URLQueryItem]() + queryParameters.append(URLQueryItem(name: "version", value: version)) + + // construct REST request + let request = RestRequest( + method: "POST", + url: serviceURL + "/v3/identify", + authMethod: authMethod, + headerParameters: headerParameters, + queryItems: queryParameters, + messageBody: body + ) + + // execute REST request + request.responseObject(responseToError: responseToError) { + (response: RestResponse) in + switch response.result { + case .success(let retval): success(retval) + case .failure(let error): failure?(error) + } + } + } + + /** + List models. + + Lists available translation models. + + - parameter source: Specify a language code to filter results by source language. + - parameter target: Specify a language code to filter results by target language. + - parameter defaultModels: If the default parameter isn't specified, the service will return all models (default and non-default) for each + language pair. To return only default models, set this to `true`. To return only non-default models, set this to + `false`. There is exactly one default model per language pair, the IBM provided base model. + - parameter headers: A dictionary of request headers to be sent with this request. + - parameter failure: A function executed if an error occurs. + - parameter success: A function executed with the successful result. + */ + public func listModels( + source: String? = nil, + target: String? = nil, + defaultModels: Bool? = nil, + headers: [String: String]? = nil, + failure: ((Error) -> Void)? = nil, + success: @escaping (TranslationModels) -> Void) + { + // construct header parameters + var headerParameters = defaultHeaders + if let headers = headers { + headerParameters.merge(headers) { (_, new) in new } + } + headerParameters["Accept"] = "application/json" + + // construct query parameters + var queryParameters = [URLQueryItem]() + queryParameters.append(URLQueryItem(name: "version", value: version)) + if let source = source { + let queryParameter = URLQueryItem(name: "source", value: source) + queryParameters.append(queryParameter) + } + if let target = target { + let queryParameter = URLQueryItem(name: "target", value: target) + queryParameters.append(queryParameter) + } + if let defaultModels = defaultModels { + let queryParameter = URLQueryItem(name: "default", value: "\(defaultModels)") + queryParameters.append(queryParameter) + } + + // construct REST request + let request = RestRequest( + method: "GET", + url: serviceURL + "/v3/models", + authMethod: authMethod, + headerParameters: headerParameters, + queryItems: queryParameters + ) + + // execute REST request + request.responseObject(responseToError: responseToError) { + (response: RestResponse) in + switch response.result { + case .success(let retval): success(retval) + case .failure(let error): failure?(error) + } + } + } + + /** + Create model. + + Uploads Translation Memory eXchange (TMX) files to customize a translation model. + You can either customize a model with a forced glossary or with a corpus that contains parallel sentences. To + create a model that is customized with a parallel corpus and a forced glossary, proceed in two steps: + customize with a parallel corpus first and then customize the resulting model with a glossary. Depending on the + type of customization and the size of the uploaded corpora, training can range from minutes for a glossary to + several hours for a large parallel corpus. You can upload a single forced glossary file and this file must be less + than 10 MB. You can upload multiple parallel corpora tmx files. The cumulative file size of all uploaded + files is limited to 250 MB. To successfully train with a parallel corpus you must have at least 5,000 + parallel sentences in your corpus. + You can have a maxium of 10 custom models per language pair. + + - parameter baseModelID: The model ID of the model to use as the base for customization. To see available models, use the `List models` + method. Usually all IBM provided models are customizable. In addition, all your models that have been created via + parallel corpus customization, can be further customized with a forced glossary. + - parameter name: An optional model name that you can use to identify the model. Valid characters are letters, numbers, dashes, + underscores, spaces and apostrophes. The maximum length is 32 characters. + - parameter forcedGlossary: A TMX file with your customizations. The customizations in the file completely overwrite the domain translaton + data, including high frequency or high confidence phrase translations. You can upload only one glossary with a + file size less than 10 MB per call. A forced glossary should contain single words or short phrases. + - parameter parallelCorpus: A TMX file with parallel sentences for source and target language. You can upload multiple parallel_corpus files + in one request. All uploaded parallel_corpus files combined, your parallel corpus must contain at least 5,000 + parallel sentences to train successfully. + - parameter headers: A dictionary of request headers to be sent with this request. + - parameter failure: A function executed if an error occurs. + - parameter success: A function executed with the successful result. + */ + public func createModel( + baseModelID: String, + name: String? = nil, + forcedGlossary: URL? = nil, + parallelCorpus: URL? = nil, + headers: [String: String]? = nil, + failure: ((Error) -> Void)? = nil, + success: @escaping (TranslationModel) -> Void) + { + // construct body + let multipartFormData = MultipartFormData() + if let forcedGlossary = forcedGlossary { + multipartFormData.append(forcedGlossary, withName: "forced_glossary") + } + if let parallelCorpus = parallelCorpus { + multipartFormData.append(parallelCorpus, withName: "parallel_corpus") + } + guard let body = try? multipartFormData.toData() else { + failure?(RestError.encodingError) + return + } + + // construct header parameters + var headerParameters = defaultHeaders + if let headers = headers { + headerParameters.merge(headers) { (_, new) in new } + } + headerParameters["Accept"] = "application/json" + headerParameters["Content-Type"] = multipartFormData.contentType + + // construct query parameters + var queryParameters = [URLQueryItem]() + queryParameters.append(URLQueryItem(name: "version", value: version)) + queryParameters.append(URLQueryItem(name: "base_model_id", value: baseModelID)) + if let name = name { + let queryParameter = URLQueryItem(name: "name", value: name) + queryParameters.append(queryParameter) + } + + // construct REST request + let request = RestRequest( + method: "POST", + url: serviceURL + "/v3/models", + authMethod: authMethod, + headerParameters: headerParameters, + queryItems: queryParameters, + messageBody: body + ) + + // execute REST request + request.responseObject(responseToError: responseToError) { + (response: RestResponse) in + switch response.result { + case .success(let retval): success(retval) + case .failure(let error): failure?(error) + } + } + } + + /** + Delete model. + + Deletes a custom translation model. + + - parameter modelID: Model ID of the model to delete. + - parameter headers: A dictionary of request headers to be sent with this request. + - parameter failure: A function executed if an error occurs. + - parameter success: A function executed with the successful result. + */ + public func deleteModel( + modelID: String, + headers: [String: String]? = nil, + failure: ((Error) -> Void)? = nil, + success: @escaping (DeleteModelResult) -> Void) + { + // construct header parameters + var headerParameters = defaultHeaders + if let headers = headers { + headerParameters.merge(headers) { (_, new) in new } + } + headerParameters["Accept"] = "application/json" + + // construct query parameters + var queryParameters = [URLQueryItem]() + queryParameters.append(URLQueryItem(name: "version", value: version)) + + // construct REST request + let path = "/v3/models/\(modelID)" + guard let encodedPath = path.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) else { + failure?(RestError.encodingError) + return + } + let request = RestRequest( + method: "DELETE", + url: serviceURL + encodedPath, + authMethod: authMethod, + headerParameters: headerParameters, + queryItems: queryParameters + ) + + // execute REST request + request.responseObject(responseToError: responseToError) { + (response: RestResponse) in + switch response.result { + case .success(let retval): success(retval) + case .failure(let error): failure?(error) + } + } + } + + /** + Get model details. + + Gets information about a translation model, including training status for custom models. Use this API call to poll + the status of your customization request. A successfully completed training will have a status of `available`. + + - parameter modelID: Model ID of the model to get. + - parameter headers: A dictionary of request headers to be sent with this request. + - parameter failure: A function executed if an error occurs. + - parameter success: A function executed with the successful result. + */ + public func getModel( + modelID: String, + headers: [String: String]? = nil, + failure: ((Error) -> Void)? = nil, + success: @escaping (TranslationModel) -> Void) + { + // construct header parameters + var headerParameters = defaultHeaders + if let headers = headers { + headerParameters.merge(headers) { (_, new) in new } + } + headerParameters["Accept"] = "application/json" + + // construct query parameters + var queryParameters = [URLQueryItem]() + queryParameters.append(URLQueryItem(name: "version", value: version)) + + // construct REST request + let path = "/v3/models/\(modelID)" + guard let encodedPath = path.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) else { + failure?(RestError.encodingError) + return + } + let request = RestRequest( + method: "GET", + url: serviceURL + encodedPath, + authMethod: authMethod, + headerParameters: headerParameters, + queryItems: queryParameters + ) + + // execute REST request + request.responseObject(responseToError: responseToError) { + (response: RestResponse) in + switch response.result { + case .success(let retval): success(retval) + case .failure(let error): failure?(error) + } + } + } + +} diff --git a/Source/LanguageTranslatorV3/Models/DeleteModelResult.swift b/Source/LanguageTranslatorV3/Models/DeleteModelResult.swift new file mode 100644 index 000000000..bff50deaf --- /dev/null +++ b/Source/LanguageTranslatorV3/Models/DeleteModelResult.swift @@ -0,0 +1,32 @@ +/** + * Copyright IBM Corporation 2018 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + +import Foundation + +/** DeleteModelResult. */ +public struct DeleteModelResult: Decodable { + + /** + "OK" indicates that the model was successfully deleted. + */ + public var status: String + + // Map each property name to the key that shall be used for encoding/decoding. + private enum CodingKeys: String, CodingKey { + case status = "status" + } + +} diff --git a/Source/LanguageTranslatorV3/Models/IdentifiableLanguage.swift b/Source/LanguageTranslatorV3/Models/IdentifiableLanguage.swift new file mode 100644 index 000000000..bef9b15d7 --- /dev/null +++ b/Source/LanguageTranslatorV3/Models/IdentifiableLanguage.swift @@ -0,0 +1,38 @@ +/** + * Copyright IBM Corporation 2018 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + +import Foundation + +/** IdentifiableLanguage. */ +public struct IdentifiableLanguage: Decodable { + + /** + The language code for an identifiable language. + */ + public var language: String + + /** + The name of the identifiable language. + */ + public var name: String + + // Map each property name to the key that shall be used for encoding/decoding. + private enum CodingKeys: String, CodingKey { + case language = "language" + case name = "name" + } + +} diff --git a/Source/LanguageTranslatorV3/Models/IdentifiableLanguages.swift b/Source/LanguageTranslatorV3/Models/IdentifiableLanguages.swift new file mode 100644 index 000000000..1f184d813 --- /dev/null +++ b/Source/LanguageTranslatorV3/Models/IdentifiableLanguages.swift @@ -0,0 +1,32 @@ +/** + * Copyright IBM Corporation 2018 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + +import Foundation + +/** IdentifiableLanguages. */ +public struct IdentifiableLanguages: Decodable { + + /** + A list of all languages that the service can identify. + */ + public var languages: [IdentifiableLanguage] + + // Map each property name to the key that shall be used for encoding/decoding. + private enum CodingKeys: String, CodingKey { + case languages = "languages" + } + +} diff --git a/Source/LanguageTranslatorV3/Models/IdentifiedLanguage.swift b/Source/LanguageTranslatorV3/Models/IdentifiedLanguage.swift new file mode 100644 index 000000000..442b80ec8 --- /dev/null +++ b/Source/LanguageTranslatorV3/Models/IdentifiedLanguage.swift @@ -0,0 +1,38 @@ +/** + * Copyright IBM Corporation 2018 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + +import Foundation + +/** IdentifiedLanguage. */ +public struct IdentifiedLanguage: Decodable { + + /** + The language code for an identified language. + */ + public var language: String + + /** + The confidence score for the identified language. + */ + public var confidence: Double + + // Map each property name to the key that shall be used for encoding/decoding. + private enum CodingKeys: String, CodingKey { + case language = "language" + case confidence = "confidence" + } + +} diff --git a/Source/LanguageTranslatorV3/Models/IdentifiedLanguages.swift b/Source/LanguageTranslatorV3/Models/IdentifiedLanguages.swift new file mode 100644 index 000000000..d1aedf73e --- /dev/null +++ b/Source/LanguageTranslatorV3/Models/IdentifiedLanguages.swift @@ -0,0 +1,32 @@ +/** + * Copyright IBM Corporation 2018 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + +import Foundation + +/** IdentifiedLanguages. */ +public struct IdentifiedLanguages: Decodable { + + /** + A ranking of identified languages with confidence scores. + */ + public var languages: [IdentifiedLanguage] + + // Map each property name to the key that shall be used for encoding/decoding. + private enum CodingKeys: String, CodingKey { + case languages = "languages" + } + +} diff --git a/Source/LanguageTranslatorV3/Models/TranslateRequest.swift b/Source/LanguageTranslatorV3/Models/TranslateRequest.swift new file mode 100644 index 000000000..98616d98c --- /dev/null +++ b/Source/LanguageTranslatorV3/Models/TranslateRequest.swift @@ -0,0 +1,81 @@ +/** + * Copyright IBM Corporation 2018 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + +import Foundation + +/** TranslateRequest. */ +public struct TranslateRequest: Encodable { + + /** + Input text in UTF-8 encoding. Multiple entries will result in multiple translations in the response. + */ + public var text: [String] + + /** + Model ID of the translation model to use. If this is specified, the **source** and **target** parameters will be + ignored. The method requires either a model ID or both the **source** and **target** parameters. + */ + public var modelID: String? + + /** + Language code of the source text language. Use with `target` as an alternative way to select a translation model. + When `source` and `target` are set, and a model ID is not set, the system chooses a default model for the language + pair (usually the model based on the news domain). + */ + public var source: String? + + /** + Language code of the translation target language. Use with source as an alternative way to select a translation + model. + */ + public var target: String? + + // Map each property name to the key that shall be used for encoding/decoding. + private enum CodingKeys: String, CodingKey { + case text = "text" + case modelID = "model_id" + case source = "source" + case target = "target" + } + + /** + Initialize a `TranslateRequest` with member variables. + + - parameter text: Input text in UTF-8 encoding. Multiple entries will result in multiple translations in the response. + - parameter modelID: Model ID of the translation model to use. If this is specified, the **source** and **target** parameters will be + ignored. The method requires either a model ID or both the **source** and **target** parameters. + - parameter source: Language code of the source text language. Use with `target` as an alternative way to select a translation model. + When `source` and `target` are set, and a model ID is not set, the system chooses a default model for the + language pair (usually the model based on the news domain). + - parameter target: Language code of the translation target language. Use with source as an alternative way to select a translation + model. + + - returns: An initialized `TranslateRequest`. + */ + public init( + text: [String], + modelID: String? = nil, + source: String? = nil, + target: String? = nil + ) + { + self.text = text + self.modelID = modelID + self.source = source + self.target = target + } + +} diff --git a/Source/LanguageTranslatorV3/Models/Translation.swift b/Source/LanguageTranslatorV3/Models/Translation.swift new file mode 100644 index 000000000..cb9742e98 --- /dev/null +++ b/Source/LanguageTranslatorV3/Models/Translation.swift @@ -0,0 +1,32 @@ +/** + * Copyright IBM Corporation 2018 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + +import Foundation + +/** Translation. */ +public struct Translation: Decodable { + + /** + Translation output in UTF-8. + */ + public var translationOutput: String + + // Map each property name to the key that shall be used for encoding/decoding. + private enum CodingKeys: String, CodingKey { + case translationOutput = "translation" + } + +} diff --git a/Source/LanguageTranslatorV3/Models/TranslationModel.swift b/Source/LanguageTranslatorV3/Models/TranslationModel.swift new file mode 100644 index 000000000..37fe554f2 --- /dev/null +++ b/Source/LanguageTranslatorV3/Models/TranslationModel.swift @@ -0,0 +1,106 @@ +/** + * Copyright IBM Corporation 2018 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + +import Foundation + +/** Response payload for models. */ +public struct TranslationModel: Decodable { + + /** + Availability of a model. + */ + public enum Status: String { + case uploading = "uploading" + case uploaded = "uploaded" + case dispatching = "dispatching" + case queued = "queued" + case training = "training" + case trained = "trained" + case publishing = "publishing" + case available = "available" + case deleted = "deleted" + case error = "error" + } + + /** + A globally unique string that identifies the underlying model that is used for translation. + */ + public var modelID: String + + /** + Optional name that can be specified when the model is created. + */ + public var name: String? + + /** + Translation source language code. + */ + public var source: String? + + /** + Translation target language code. + */ + public var target: String? + + /** + Model ID of the base model that was used to customize the model. If the model is not a custom model, this will be + an empty string. + */ + public var baseModelID: String? + + /** + The domain of the translation model. + */ + public var domain: String? + + /** + Whether this model can be used as a base for customization. Customized models are not further customizable, and + some base models are not customizable. + */ + public var customizable: Bool? + + /** + Whether or not the model is a default model. A default model is the model for a given language pair that will be + used when that language pair is specified in the source and target parameters. + */ + public var defaultModel: Bool? + + /** + Either an empty string, indicating the model is not a custom model, or the ID of the service instance that created + the model. + */ + public var owner: String? + + /** + Availability of a model. + */ + public var status: String? + + // Map each property name to the key that shall be used for encoding/decoding. + private enum CodingKeys: String, CodingKey { + case modelID = "model_id" + case name = "name" + case source = "source" + case target = "target" + case baseModelID = "base_model_id" + case domain = "domain" + case customizable = "customizable" + case defaultModel = "default_model" + case owner = "owner" + case status = "status" + } + +} diff --git a/Source/LanguageTranslatorV3/Models/TranslationModels.swift b/Source/LanguageTranslatorV3/Models/TranslationModels.swift new file mode 100644 index 000000000..aa7be5182 --- /dev/null +++ b/Source/LanguageTranslatorV3/Models/TranslationModels.swift @@ -0,0 +1,32 @@ +/** + * Copyright IBM Corporation 2018 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + +import Foundation + +/** The response type for listing existing translation models. */ +public struct TranslationModels: Decodable { + + /** + An array of available models. + */ + public var models: [TranslationModel] + + // Map each property name to the key that shall be used for encoding/decoding. + private enum CodingKeys: String, CodingKey { + case models = "models" + } + +} diff --git a/Source/LanguageTranslatorV3/Models/TranslationResult.swift b/Source/LanguageTranslatorV3/Models/TranslationResult.swift new file mode 100644 index 000000000..210c0daff --- /dev/null +++ b/Source/LanguageTranslatorV3/Models/TranslationResult.swift @@ -0,0 +1,44 @@ +/** + * Copyright IBM Corporation 2018 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + +import Foundation + +/** TranslationResult. */ +public struct TranslationResult: Decodable { + + /** + Number of words in the input text. + */ + public var wordCount: Int + + /** + Number of characters in the input text. + */ + public var characterCount: Int + + /** + List of translation output in UTF-8, corresponding to the input text entries. + */ + public var translations: [Translation] + + // Map each property name to the key that shall be used for encoding/decoding. + private enum CodingKeys: String, CodingKey { + case wordCount = "word_count" + case characterCount = "character_count" + case translations = "translations" + } + +} diff --git a/Source/LanguageTranslatorV3/RestKit/Authentication.swift b/Source/LanguageTranslatorV3/RestKit/Authentication.swift new file mode 120000 index 000000000..019d0d58c --- /dev/null +++ b/Source/LanguageTranslatorV3/RestKit/Authentication.swift @@ -0,0 +1 @@ +../../RestKit/Authentication.swift \ No newline at end of file diff --git a/Source/LanguageTranslatorV3/RestKit/CodableExtensions.swift b/Source/LanguageTranslatorV3/RestKit/CodableExtensions.swift new file mode 120000 index 000000000..4fa90e0c3 --- /dev/null +++ b/Source/LanguageTranslatorV3/RestKit/CodableExtensions.swift @@ -0,0 +1 @@ +../../RestKit/CodableExtensions.swift \ No newline at end of file diff --git a/Source/LanguageTranslatorV3/RestKit/JSON.swift b/Source/LanguageTranslatorV3/RestKit/JSON.swift new file mode 120000 index 000000000..00634abc2 --- /dev/null +++ b/Source/LanguageTranslatorV3/RestKit/JSON.swift @@ -0,0 +1 @@ +../../RestKit/JSON.swift \ No newline at end of file diff --git a/Source/LanguageTranslatorV3/RestKit/MultipartFormData.swift b/Source/LanguageTranslatorV3/RestKit/MultipartFormData.swift new file mode 120000 index 000000000..f5da27769 --- /dev/null +++ b/Source/LanguageTranslatorV3/RestKit/MultipartFormData.swift @@ -0,0 +1 @@ +../../RestKit/MultipartFormData.swift \ No newline at end of file diff --git a/Source/LanguageTranslatorV3/RestKit/RestError.swift b/Source/LanguageTranslatorV3/RestKit/RestError.swift new file mode 120000 index 000000000..b74bef625 --- /dev/null +++ b/Source/LanguageTranslatorV3/RestKit/RestError.swift @@ -0,0 +1 @@ +../../RestKit/RestError.swift \ No newline at end of file diff --git a/Source/LanguageTranslatorV3/RestKit/RestRequest.swift b/Source/LanguageTranslatorV3/RestKit/RestRequest.swift new file mode 120000 index 000000000..fef8b11c2 --- /dev/null +++ b/Source/LanguageTranslatorV3/RestKit/RestRequest.swift @@ -0,0 +1 @@ +../../RestKit/RestRequest.swift \ No newline at end of file diff --git a/Source/LanguageTranslatorV3/RestKit/RestToken.swift b/Source/LanguageTranslatorV3/RestKit/RestToken.swift new file mode 120000 index 000000000..8de685137 --- /dev/null +++ b/Source/LanguageTranslatorV3/RestKit/RestToken.swift @@ -0,0 +1 @@ +../../RestKit/RestToken.swift \ No newline at end of file diff --git a/Source/LanguageTranslatorV3/RestKit/RestUtilities.swift b/Source/LanguageTranslatorV3/RestKit/RestUtilities.swift new file mode 120000 index 000000000..5888cf785 --- /dev/null +++ b/Source/LanguageTranslatorV3/RestKit/RestUtilities.swift @@ -0,0 +1 @@ +../../RestKit/RestUtilities.swift \ No newline at end of file diff --git a/Source/NaturalLanguageClassifierV1/Models/Classification.swift b/Source/NaturalLanguageClassifierV1/Models/Classification.swift index 54d65a229..b55409986 100644 --- a/Source/NaturalLanguageClassifierV1/Models/Classification.swift +++ b/Source/NaturalLanguageClassifierV1/Models/Classification.swift @@ -19,19 +19,29 @@ import Foundation /** Response from the classifier for a phrase. */ public struct Classification: Decodable { - /// Unique identifier for this classifier. + /** + Unique identifier for this classifier. + */ public var classifierID: String? - /// Link to the classifier. + /** + Link to the classifier. + */ public var url: String? - /// The submitted phrase. + /** + The submitted phrase. + */ public var text: String? - /// The class with the highest confidence. + /** + The class with the highest confidence. + */ public var topClass: String? - /// An array of up to ten class-confidence pairs sorted in descending order of confidence. + /** + An array of up to ten class-confidence pairs sorted in descending order of confidence. + */ public var classes: [ClassifiedClass]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageClassifierV1/Models/ClassificationCollection.swift b/Source/NaturalLanguageClassifierV1/Models/ClassificationCollection.swift index 853c847ab..58ab7b4b2 100644 --- a/Source/NaturalLanguageClassifierV1/Models/ClassificationCollection.swift +++ b/Source/NaturalLanguageClassifierV1/Models/ClassificationCollection.swift @@ -19,13 +19,19 @@ import Foundation /** Response from the classifier for multiple phrases. */ public struct ClassificationCollection: Decodable { - /// Unique identifier for this classifier. + /** + Unique identifier for this classifier. + */ public var classifierID: String? - /// Link to the classifier. + /** + Link to the classifier. + */ public var url: String? - /// An array of classifier responses for each submitted phrase. + /** + An array of classifier responses for each submitted phrase. + */ public var collection: [CollectionItem]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageClassifierV1/Models/ClassifiedClass.swift b/Source/NaturalLanguageClassifierV1/Models/ClassifiedClass.swift index a1ea64447..83853672e 100644 --- a/Source/NaturalLanguageClassifierV1/Models/ClassifiedClass.swift +++ b/Source/NaturalLanguageClassifierV1/Models/ClassifiedClass.swift @@ -19,10 +19,15 @@ import Foundation /** Class and confidence. */ public struct ClassifiedClass: Decodable { - /// A decimal percentage that represents the confidence that Watson has in this class. Higher values represent higher confidences. + /** + A decimal percentage that represents the confidence that Watson has in this class. Higher values represent higher + confidences. + */ public var confidence: Double? - /// Class label. + /** + Class label. + */ public var className: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageClassifierV1/Models/Classifier.swift b/Source/NaturalLanguageClassifierV1/Models/Classifier.swift index 128fdeaa5..4cbe194e5 100644 --- a/Source/NaturalLanguageClassifierV1/Models/Classifier.swift +++ b/Source/NaturalLanguageClassifierV1/Models/Classifier.swift @@ -19,7 +19,9 @@ import Foundation /** A classifier for natural language phrases. */ public struct Classifier: Decodable { - /// The state of the classifier. + /** + The state of the classifier. + */ public enum Status: String { case nonExistent = "Non Existent" case training = "Training" @@ -28,25 +30,39 @@ public struct Classifier: Decodable { case unavailable = "Unavailable" } - /// User-supplied name for the classifier. + /** + User-supplied name for the classifier. + */ public var name: String? - /// Link to the classifier. + /** + Link to the classifier. + */ public var url: String - /// The state of the classifier. + /** + The state of the classifier. + */ public var status: String? - /// Unique identifier for this classifier. + /** + Unique identifier for this classifier. + */ public var classifierID: String - /// Date and time (UTC) the classifier was created. + /** + Date and time (UTC) the classifier was created. + */ public var created: String? - /// Additional detail about the status. + /** + Additional detail about the status. + */ public var statusDescription: String? - /// The language used for the classifier. + /** + The language used for the classifier. + */ public var language: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageClassifierV1/Models/ClassifierList.swift b/Source/NaturalLanguageClassifierV1/Models/ClassifierList.swift index 10899ccd9..ea5434325 100644 --- a/Source/NaturalLanguageClassifierV1/Models/ClassifierList.swift +++ b/Source/NaturalLanguageClassifierV1/Models/ClassifierList.swift @@ -19,7 +19,9 @@ import Foundation /** List of available classifiers. */ public struct ClassifierList: Decodable { - /// The classifiers available to the user. Returns an empty array if no classifiers are available. + /** + The classifiers available to the user. Returns an empty array if no classifiers are available. + */ public var classifiers: [Classifier] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageClassifierV1/Models/ClassifyCollectionInput.swift b/Source/NaturalLanguageClassifierV1/Models/ClassifyCollectionInput.swift index eac1d766a..c56306732 100644 --- a/Source/NaturalLanguageClassifierV1/Models/ClassifyCollectionInput.swift +++ b/Source/NaturalLanguageClassifierV1/Models/ClassifyCollectionInput.swift @@ -19,7 +19,9 @@ import Foundation /** Request payload to classify. */ public struct ClassifyCollectionInput: Encodable { - /// The submitted phrases. + /** + The submitted phrases. + */ public var collection: [ClassifyInput] // Map each property name to the key that shall be used for encoding/decoding. @@ -34,7 +36,10 @@ public struct ClassifyCollectionInput: Encodable { - returns: An initialized `ClassifyCollectionInput`. */ - public init(collection: [ClassifyInput]) { + public init( + collection: [ClassifyInput] + ) + { self.collection = collection } diff --git a/Source/NaturalLanguageClassifierV1/Models/ClassifyInput.swift b/Source/NaturalLanguageClassifierV1/Models/ClassifyInput.swift index 397d8f641..1651b843d 100644 --- a/Source/NaturalLanguageClassifierV1/Models/ClassifyInput.swift +++ b/Source/NaturalLanguageClassifierV1/Models/ClassifyInput.swift @@ -19,7 +19,9 @@ import Foundation /** Request payload to classify. */ public struct ClassifyInput: Encodable { - /// The submitted phrase. + /** + The submitted phrase. + */ public var text: String // Map each property name to the key that shall be used for encoding/decoding. @@ -34,7 +36,10 @@ public struct ClassifyInput: Encodable { - returns: An initialized `ClassifyInput`. */ - public init(text: String) { + public init( + text: String + ) + { self.text = text } diff --git a/Source/NaturalLanguageClassifierV1/Models/CollectionItem.swift b/Source/NaturalLanguageClassifierV1/Models/CollectionItem.swift index 6d427c928..2249ffeb5 100644 --- a/Source/NaturalLanguageClassifierV1/Models/CollectionItem.swift +++ b/Source/NaturalLanguageClassifierV1/Models/CollectionItem.swift @@ -19,13 +19,19 @@ import Foundation /** Response from the classifier for a phrase in a collection. */ public struct CollectionItem: Decodable { - /// The submitted phrase. + /** + The submitted phrase. + */ public var text: String? - /// The class with the highest confidence. + /** + The class with the highest confidence. + */ public var topClass: String? - /// An array of up to ten class-confidence pairs sorted in descending order of confidence. + /** + An array of up to ten class-confidence pairs sorted in descending order of confidence. + */ public var classes: [ClassifiedClass]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageClassifierV1/NaturalLanguageClassifier.swift b/Source/NaturalLanguageClassifierV1/NaturalLanguageClassifier.swift index e0368cffc..d1df7f38f 100644 --- a/Source/NaturalLanguageClassifierV1/NaturalLanguageClassifier.swift +++ b/Source/NaturalLanguageClassifierV1/NaturalLanguageClassifier.swift @@ -17,9 +17,9 @@ import Foundation /** - IBM Watson Natural Language Classifier uses machine learning algorithms to return the top matching predefined classes - for short text input. You create and train a classifier to connect predefined classes to example texts so that the - service can apply those classes to new inputs. + IBM Watson™ Natural Language Classifier uses machine learning algorithms to return the top matching predefined + classes for short text input. You create and train a classifier to connect predefined classes to example texts so that + the service can apply those classes to new inputs. */ public class NaturalLanguageClassifier { @@ -144,7 +144,8 @@ public class NaturalLanguageClassifier { Classify multiple phrases. Returns label information for multiple phrases. The status must be `Available` before you can use the classifier to - classify text. Note that classifying Japanese texts is a beta feature. + classify text. + Note that classifying Japanese texts is a beta feature. - parameter classifierID: Classifier ID to use. - parameter collection: The submitted phrases. @@ -204,12 +205,12 @@ public class NaturalLanguageClassifier { Sends data to create and train a classifier and returns information about the new classifier. - parameter metadata: Metadata in JSON format. The metadata identifies the language of the data, and an optional name to identify the - classifier. Specify the language with the 2-letter primary language code as assigned in ISO standard 639. - Supported languages are English (`en`), Arabic (`ar`), French (`fr`), German, (`de`), Italian (`it`), Japanese - (`ja`), Korean (`ko`), Brazilian Portuguese (`pt`), and Spanish (`es`). + classifier. Specify the language with the 2-letter primary language code as assigned in ISO standard 639. + Supported languages are English (`en`), Arabic (`ar`), French (`fr`), German, (`de`), Italian (`it`), Japanese + (`ja`), Korean (`ko`), Brazilian Portuguese (`pt`), and Spanish (`es`). - parameter trainingData: Training data in CSV format. Each text value must have at least one class. The data can include up to 20,000 - records. For details, see [Data - preparation](https://console.bluemix.net/docs/services/natural-language-classifier/using-your-data.html). + records. For details, see [Data + preparation](https://console.bluemix.net/docs/services/natural-language-classifier/using-your-data.html). - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/AnalysisResults.swift b/Source/NaturalLanguageUnderstandingV1/Models/AnalysisResults.swift index 3ef9b4d1b..8dfa1852e 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/AnalysisResults.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/AnalysisResults.swift @@ -19,43 +19,69 @@ import Foundation /** Results of the analysis, organized by feature. */ public struct AnalysisResults: Decodable { - /// Language used to analyze the text. + /** + Language used to analyze the text. + */ public var language: String? - /// Text that was used in the analysis. + /** + Text that was used in the analysis. + */ public var analyzedText: String? - /// URL that was used to retrieve HTML content. + /** + URL that was used to retrieve HTML content. + */ public var retrievedUrl: String? - /// API usage information for the request. + /** + API usage information for the request. + */ public var usage: Usage? - /// The general concepts referenced or alluded to in the specified content. + /** + The general concepts referenced or alluded to in the specified content. + */ public var concepts: [ConceptsResult]? - /// The important entities in the specified content. + /** + The important entities in the specified content. + */ public var entities: [EntitiesResult]? - /// The important keywords in content organized by relevance. + /** + The important keywords in content organized by relevance. + */ public var keywords: [KeywordsResult]? - /// The hierarchical 5-level taxonomy the content is categorized into. + /** + The hierarchical 5-level taxonomy the content is categorized into. + */ public var categories: [CategoriesResult]? - /// The anger, disgust, fear, joy, or sadness conveyed by the content. + /** + The anger, disgust, fear, joy, or sadness conveyed by the content. + */ public var emotion: EmotionResult? - /// The metadata holds author information, publication date and the title of the text/HTML content. + /** + The metadata holds author information, publication date and the title of the text/HTML content. + */ public var metadata: MetadataResult? - /// The relationships between entities in the content. + /** + The relationships between entities in the content. + */ public var relations: [RelationsResult]? - /// The subjects of actions and the objects the actions act upon. + /** + The subjects of actions and the objects the actions act upon. + */ public var semanticRoles: [SemanticRolesResult]? - /// The sentiment of the content. + /** + The sentiment of the content. + */ public var sentiment: SentimentResult? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/Author.swift b/Source/NaturalLanguageUnderstandingV1/Models/Author.swift index f257e6e16..df0d04dca 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/Author.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/Author.swift @@ -19,7 +19,9 @@ import Foundation /** The author of the analyzed content. */ public struct Author: Decodable { - /// Name of the author. + /** + Name of the author. + */ public var name: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/CategoriesOptions.swift b/Source/NaturalLanguageUnderstandingV1/Models/CategoriesOptions.swift index f6295a337..6a78e17df 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/CategoriesOptions.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/CategoriesOptions.swift @@ -27,7 +27,10 @@ public struct CategoriesOptions: Encodable { - returns: An initialized `CategoriesOptions`. */ - public init(additionalProperties: [String: JSON] = [:]) { + public init( + additionalProperties: [String: JSON] = [:] + ) + { self.additionalProperties = additionalProperties } diff --git a/Source/NaturalLanguageUnderstandingV1/Models/CategoriesResult.swift b/Source/NaturalLanguageUnderstandingV1/Models/CategoriesResult.swift index c3369c5cc..3c5216ec3 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/CategoriesResult.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/CategoriesResult.swift @@ -19,10 +19,14 @@ import Foundation /** The hierarchical 5-level taxonomy the content is categorized into. */ public struct CategoriesResult: Decodable { - /// The path to the category through the taxonomy hierarchy. + /** + The path to the category through the taxonomy hierarchy. + */ public var label: String? - /// Confidence score for the category classification. Higher values indicate greater confidence. + /** + Confidence score for the category classification. Higher values indicate greater confidence. + */ public var score: Double? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/ConceptsOptions.swift b/Source/NaturalLanguageUnderstandingV1/Models/ConceptsOptions.swift index 18d8737b2..387e161bc 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/ConceptsOptions.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/ConceptsOptions.swift @@ -19,7 +19,9 @@ import Foundation /** Whether or not to analyze content for general concepts that are referenced or alluded to. */ public struct ConceptsOptions: Encodable { - /// Maximum number of concepts to return. + /** + Maximum number of concepts to return. + */ public var limit: Int? // Map each property name to the key that shall be used for encoding/decoding. @@ -34,7 +36,10 @@ public struct ConceptsOptions: Encodable { - returns: An initialized `ConceptsOptions`. */ - public init(limit: Int? = nil) { + public init( + limit: Int? = nil + ) + { self.limit = limit } diff --git a/Source/NaturalLanguageUnderstandingV1/Models/ConceptsResult.swift b/Source/NaturalLanguageUnderstandingV1/Models/ConceptsResult.swift index 657ad1db4..7d1b8c969 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/ConceptsResult.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/ConceptsResult.swift @@ -19,13 +19,19 @@ import Foundation /** The general concepts referenced or alluded to in the specified content. */ public struct ConceptsResult: Decodable { - /// Name of the concept. + /** + Name of the concept. + */ public var text: String? - /// Relevance score between 0 and 1. Higher scores indicate greater relevance. + /** + Relevance score between 0 and 1. Higher scores indicate greater relevance. + */ public var relevance: Double? - /// Link to the corresponding DBpedia resource. + /** + Link to the corresponding DBpedia resource. + */ public var dbpediaResource: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/DisambiguationResult.swift b/Source/NaturalLanguageUnderstandingV1/Models/DisambiguationResult.swift index 71dcde3b4..ef7848dec 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/DisambiguationResult.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/DisambiguationResult.swift @@ -19,13 +19,19 @@ import Foundation /** Disambiguation information for the entity. */ public struct DisambiguationResult: Decodable { - /// Common entity name. + /** + Common entity name. + */ public var name: String? - /// Link to the corresponding DBpedia resource. + /** + Link to the corresponding DBpedia resource. + */ public var dbpediaResource: String? - /// Entity subtype information. + /** + Entity subtype information. + */ public var subtype: [String]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/DocumentEmotionResults.swift b/Source/NaturalLanguageUnderstandingV1/Models/DocumentEmotionResults.swift index a7312cd53..304b98623 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/DocumentEmotionResults.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/DocumentEmotionResults.swift @@ -19,7 +19,9 @@ import Foundation /** An object containing the emotion results of a document. */ public struct DocumentEmotionResults: Decodable { - /// An object containing the emotion results for the document. + /** + An object containing the emotion results for the document. + */ public var emotion: EmotionScores? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/DocumentSentimentResults.swift b/Source/NaturalLanguageUnderstandingV1/Models/DocumentSentimentResults.swift index cef55f137..d50d6ebfa 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/DocumentSentimentResults.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/DocumentSentimentResults.swift @@ -19,10 +19,14 @@ import Foundation /** DocumentSentimentResults. */ public struct DocumentSentimentResults: Decodable { - /// Indicates whether the sentiment is positive, neutral, or negative. + /** + Indicates whether the sentiment is positive, neutral, or negative. + */ public var label: String? - /// Sentiment score from -1 (negative) to 1 (positive). + /** + Sentiment score from -1 (negative) to 1 (positive). + */ public var score: Double? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/EmotionOptions.swift b/Source/NaturalLanguageUnderstandingV1/Models/EmotionOptions.swift index 3d0490c92..6b186b868 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/EmotionOptions.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/EmotionOptions.swift @@ -19,10 +19,14 @@ import Foundation /** Whether or not to return emotion analysis of the content. */ public struct EmotionOptions: Encodable { - /// Set this to false to hide document-level emotion results. + /** + Set this to false to hide document-level emotion results. + */ public var document: Bool? - /// Emotion results will be returned for each target string that is found in the document. + /** + Emotion results will be returned for each target string that is found in the document. + */ public var targets: [String]? // Map each property name to the key that shall be used for encoding/decoding. @@ -39,7 +43,11 @@ public struct EmotionOptions: Encodable { - returns: An initialized `EmotionOptions`. */ - public init(document: Bool? = nil, targets: [String]? = nil) { + public init( + document: Bool? = nil, + targets: [String]? = nil + ) + { self.document = document self.targets = targets } diff --git a/Source/NaturalLanguageUnderstandingV1/Models/EmotionResult.swift b/Source/NaturalLanguageUnderstandingV1/Models/EmotionResult.swift index c01d137ed..b527ec8e6 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/EmotionResult.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/EmotionResult.swift @@ -19,10 +19,14 @@ import Foundation /** The detected anger, disgust, fear, joy, or sadness that is conveyed by the content. Emotion information can be returned for detected entities, keywords, or user-specified target phrases found in the text. */ public struct EmotionResult: Decodable { - /// The returned emotion results across the document. + /** + The returned emotion results across the document. + */ public var document: DocumentEmotionResults? - /// The returned emotion results per specified target. + /** + The returned emotion results per specified target. + */ public var targets: [TargetedEmotionResults]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/EmotionScores.swift b/Source/NaturalLanguageUnderstandingV1/Models/EmotionScores.swift index 324176083..d28eaa3bc 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/EmotionScores.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/EmotionScores.swift @@ -19,19 +19,29 @@ import Foundation /** EmotionScores. */ public struct EmotionScores: Decodable { - /// Anger score from 0 to 1. A higher score means that the text is more likely to convey anger. + /** + Anger score from 0 to 1. A higher score means that the text is more likely to convey anger. + */ public var anger: Double? - /// Disgust score from 0 to 1. A higher score means that the text is more likely to convey disgust. + /** + Disgust score from 0 to 1. A higher score means that the text is more likely to convey disgust. + */ public var disgust: Double? - /// Fear score from 0 to 1. A higher score means that the text is more likely to convey fear. + /** + Fear score from 0 to 1. A higher score means that the text is more likely to convey fear. + */ public var fear: Double? - /// Joy score from 0 to 1. A higher score means that the text is more likely to convey joy. + /** + Joy score from 0 to 1. A higher score means that the text is more likely to convey joy. + */ public var joy: Double? - /// Sadness score from 0 to 1. A higher score means that the text is more likely to convey sadness. + /** + Sadness score from 0 to 1. A higher score means that the text is more likely to convey sadness. + */ public var sadness: Double? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/EntitiesOptions.swift b/Source/NaturalLanguageUnderstandingV1/Models/EntitiesOptions.swift index 36835d238..9f4bc97e6 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/EntitiesOptions.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/EntitiesOptions.swift @@ -19,19 +19,29 @@ import Foundation /** Whether or not to return important people, places, geopolitical, and other entities detected in the analyzed content. */ public struct EntitiesOptions: Encodable { - /// Maximum number of entities to return. + /** + Maximum number of entities to return. + */ public var limit: Int? - /// Set this to true to return locations of entity mentions. + /** + Set this to true to return locations of entity mentions. + */ public var mentions: Bool? - /// Enter a custom model ID to override the standard entity detection model. + /** + Enter a custom model ID to override the standard entity detection model. + */ public var model: String? - /// Set this to true to return sentiment information for detected entities. + /** + Set this to true to return sentiment information for detected entities. + */ public var sentiment: Bool? - /// Set this to true to analyze emotion for detected keywords. + /** + Set this to true to analyze emotion for detected keywords. + */ public var emotion: Bool? // Map each property name to the key that shall be used for encoding/decoding. @@ -54,7 +64,14 @@ public struct EntitiesOptions: Encodable { - returns: An initialized `EntitiesOptions`. */ - public init(limit: Int? = nil, mentions: Bool? = nil, model: String? = nil, sentiment: Bool? = nil, emotion: Bool? = nil) { + public init( + limit: Int? = nil, + mentions: Bool? = nil, + model: String? = nil, + sentiment: Bool? = nil, + emotion: Bool? = nil + ) + { self.limit = limit self.mentions = mentions self.model = model diff --git a/Source/NaturalLanguageUnderstandingV1/Models/EntitiesResult.swift b/Source/NaturalLanguageUnderstandingV1/Models/EntitiesResult.swift index 16afc33ef..d7d45ec80 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/EntitiesResult.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/EntitiesResult.swift @@ -19,28 +19,44 @@ import Foundation /** The important people, places, geopolitical entities and other types of entities in your content. */ public struct EntitiesResult: Decodable { - /// Entity type. + /** + Entity type. + */ public var type: String? - /// The name of the entity. + /** + The name of the entity. + */ public var text: String? - /// Relevance score from 0 to 1. Higher values indicate greater relevance. + /** + Relevance score from 0 to 1. Higher values indicate greater relevance. + */ public var relevance: Double? - /// Entity mentions and locations. + /** + Entity mentions and locations. + */ public var mentions: [EntityMention]? - /// How many times the entity was mentioned in the text. + /** + How many times the entity was mentioned in the text. + */ public var count: Int? - /// Emotion analysis results for the entity, enabled with the "emotion" option. + /** + Emotion analysis results for the entity, enabled with the "emotion" option. + */ public var emotion: EmotionScores? - /// Sentiment analysis results for the entity, enabled with the "sentiment" option. + /** + Sentiment analysis results for the entity, enabled with the "sentiment" option. + */ public var sentiment: FeatureSentimentResults? - /// Disambiguation information for the entity. + /** + Disambiguation information for the entity. + */ public var disambiguation: DisambiguationResult? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/EntityMention.swift b/Source/NaturalLanguageUnderstandingV1/Models/EntityMention.swift index afce23df6..d2cd7bce6 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/EntityMention.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/EntityMention.swift @@ -19,10 +19,14 @@ import Foundation /** EntityMention. */ public struct EntityMention: Decodable { - /// Entity mention text. + /** + Entity mention text. + */ public var text: String? - /// Character offsets indicating the beginning and end of the mention in the analyzed text. + /** + Character offsets indicating the beginning and end of the mention in the analyzed text. + */ public var location: [Int]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/FeatureSentimentResults.swift b/Source/NaturalLanguageUnderstandingV1/Models/FeatureSentimentResults.swift index 0d6c57c07..0c308c6da 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/FeatureSentimentResults.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/FeatureSentimentResults.swift @@ -19,7 +19,9 @@ import Foundation /** FeatureSentimentResults. */ public struct FeatureSentimentResults: Decodable { - /// Sentiment score from -1 (negative) to 1 (positive). + /** + Sentiment score from -1 (negative) to 1 (positive). + */ public var score: Double? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/Features.swift b/Source/NaturalLanguageUnderstandingV1/Models/Features.swift index fb864731c..f7d05b1e5 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/Features.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/Features.swift @@ -19,31 +19,50 @@ import Foundation /** Analysis features and options. */ public struct Features: Encodable { - /// Whether or not to return the concepts that are mentioned in the analyzed text. + /** + Whether or not to return the concepts that are mentioned in the analyzed text. + */ public var concepts: ConceptsOptions? - /// Whether or not to extract the emotions implied in the analyzed text. + /** + Whether or not to extract the emotions implied in the analyzed text. + */ public var emotion: EmotionOptions? - /// Whether or not to extract detected entity objects from the analyzed text. + /** + Whether or not to extract detected entity objects from the analyzed text. + */ public var entities: EntitiesOptions? - /// Whether or not to return the keywords in the analyzed text. + /** + Whether or not to return the keywords in the analyzed text. + */ public var keywords: KeywordsOptions? - /// Whether or not the author, publication date, and title of the analyzed text should be returned. This parameter is only available for URL and HTML input. + /** + Whether or not the author, publication date, and title of the analyzed text should be returned. This parameter is + only available for URL and HTML input. + */ public var metadata: MetadataOptions? - /// Whether or not to return the relationships between detected entities in the analyzed text. + /** + Whether or not to return the relationships between detected entities in the analyzed text. + */ public var relations: RelationsOptions? - /// Whether or not to return the subject-action-object relations from the analyzed text. + /** + Whether or not to return the subject-action-object relations from the analyzed text. + */ public var semanticRoles: SemanticRolesOptions? - /// Whether or not to return the overall sentiment of the analyzed text. + /** + Whether or not to return the overall sentiment of the analyzed text. + */ public var sentiment: SentimentOptions? - /// Whether or not to return the high level category the content is categorized as (i.e. news, art). + /** + Whether or not to return the high level category the content is categorized as (i.e. news, art). + */ public var categories: CategoriesOptions? // Map each property name to the key that shall be used for encoding/decoding. @@ -66,7 +85,8 @@ public struct Features: Encodable { - parameter emotion: Whether or not to extract the emotions implied in the analyzed text. - parameter entities: Whether or not to extract detected entity objects from the analyzed text. - parameter keywords: Whether or not to return the keywords in the analyzed text. - - parameter metadata: Whether or not the author, publication date, and title of the analyzed text should be returned. This parameter is only available for URL and HTML input. + - parameter metadata: Whether or not the author, publication date, and title of the analyzed text should be returned. This parameter is + only available for URL and HTML input. - parameter relations: Whether or not to return the relationships between detected entities in the analyzed text. - parameter semanticRoles: Whether or not to return the subject-action-object relations from the analyzed text. - parameter sentiment: Whether or not to return the overall sentiment of the analyzed text. @@ -74,7 +94,18 @@ public struct Features: Encodable { - returns: An initialized `Features`. */ - public init(concepts: ConceptsOptions? = nil, emotion: EmotionOptions? = nil, entities: EntitiesOptions? = nil, keywords: KeywordsOptions? = nil, metadata: MetadataOptions? = nil, relations: RelationsOptions? = nil, semanticRoles: SemanticRolesOptions? = nil, sentiment: SentimentOptions? = nil, categories: CategoriesOptions? = nil) { + public init( + concepts: ConceptsOptions? = nil, + emotion: EmotionOptions? = nil, + entities: EntitiesOptions? = nil, + keywords: KeywordsOptions? = nil, + metadata: MetadataOptions? = nil, + relations: RelationsOptions? = nil, + semanticRoles: SemanticRolesOptions? = nil, + sentiment: SentimentOptions? = nil, + categories: CategoriesOptions? = nil + ) + { self.concepts = concepts self.emotion = emotion self.entities = entities diff --git a/Source/NaturalLanguageUnderstandingV1/Models/Feed.swift b/Source/NaturalLanguageUnderstandingV1/Models/Feed.swift index d7c16ac6a..baf0ca247 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/Feed.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/Feed.swift @@ -19,7 +19,9 @@ import Foundation /** RSS or ATOM feed found on the webpage. */ public struct Feed: Decodable { - /// URL of the RSS or ATOM feed. + /** + URL of the RSS or ATOM feed. + */ public var link: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/KeywordsOptions.swift b/Source/NaturalLanguageUnderstandingV1/Models/KeywordsOptions.swift index 96b30099f..f33678ffb 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/KeywordsOptions.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/KeywordsOptions.swift @@ -19,13 +19,19 @@ import Foundation /** An option indicating whether or not important keywords from the analyzed content should be returned. */ public struct KeywordsOptions: Encodable { - /// Maximum number of keywords to return. + /** + Maximum number of keywords to return. + */ public var limit: Int? - /// Set this to true to return sentiment information for detected keywords. + /** + Set this to true to return sentiment information for detected keywords. + */ public var sentiment: Bool? - /// Set this to true to analyze emotion for detected keywords. + /** + Set this to true to analyze emotion for detected keywords. + */ public var emotion: Bool? // Map each property name to the key that shall be used for encoding/decoding. @@ -44,7 +50,12 @@ public struct KeywordsOptions: Encodable { - returns: An initialized `KeywordsOptions`. */ - public init(limit: Int? = nil, sentiment: Bool? = nil, emotion: Bool? = nil) { + public init( + limit: Int? = nil, + sentiment: Bool? = nil, + emotion: Bool? = nil + ) + { self.limit = limit self.sentiment = sentiment self.emotion = emotion diff --git a/Source/NaturalLanguageUnderstandingV1/Models/KeywordsResult.swift b/Source/NaturalLanguageUnderstandingV1/Models/KeywordsResult.swift index 2be9ebd97..db72d1222 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/KeywordsResult.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/KeywordsResult.swift @@ -19,16 +19,24 @@ import Foundation /** The most important keywords in the content, organized by relevance. */ public struct KeywordsResult: Decodable { - /// Relevance score from 0 to 1. Higher values indicate greater relevance. + /** + Relevance score from 0 to 1. Higher values indicate greater relevance. + */ public var relevance: Double? - /// The keyword text. + /** + The keyword text. + */ public var text: String? - /// Emotion analysis results for the keyword, enabled with the "emotion" option. + /** + Emotion analysis results for the keyword, enabled with the "emotion" option. + */ public var emotion: EmotionScores? - /// Sentiment analysis results for the keyword, enabled with the "sentiment" option. + /** + Sentiment analysis results for the keyword, enabled with the "sentiment" option. + */ public var sentiment: FeatureSentimentResults? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/MetadataOptions.swift b/Source/NaturalLanguageUnderstandingV1/Models/MetadataOptions.swift index 759f8d7a1..adb70ec1f 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/MetadataOptions.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/MetadataOptions.swift @@ -27,7 +27,10 @@ public struct MetadataOptions: Encodable { - returns: An initialized `MetadataOptions`. */ - public init(additionalProperties: [String: JSON] = [:]) { + public init( + additionalProperties: [String: JSON] = [:] + ) + { self.additionalProperties = additionalProperties } diff --git a/Source/NaturalLanguageUnderstandingV1/Models/MetadataResult.swift b/Source/NaturalLanguageUnderstandingV1/Models/MetadataResult.swift index 2396bfdba..0305d32fa 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/MetadataResult.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/MetadataResult.swift @@ -19,19 +19,29 @@ import Foundation /** The Authors, Publication Date, and Title of the document. Supports URL and HTML input types. */ public struct MetadataResult: Decodable { - /// The authors of the document. + /** + The authors of the document. + */ public var authors: [Author]? - /// The publication date in the format ISO 8601. + /** + The publication date in the format ISO 8601. + */ public var publicationDate: String? - /// The title of the document. + /** + The title of the document. + */ public var title: String? - /// URL of a prominent image on the webpage. + /** + URL of a prominent image on the webpage. + */ public var image: String? - /// RSS/ATOM feeds found on the webpage. + /** + RSS/ATOM feeds found on the webpage. + */ public var feeds: [Feed]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/Model.swift b/Source/NaturalLanguageUnderstandingV1/Models/Model.swift index da00b1680..1bbc91d7a 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/Model.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/Model.swift @@ -19,16 +19,24 @@ import Foundation /** Model. */ public struct Model: Decodable { - /// Shows as available if the model is ready for use. + /** + Shows as available if the model is ready for use. + */ public var status: String? - /// Unique model ID. + /** + Unique model ID. + */ public var modelID: String? - /// ISO 639-1 code indicating the language of the model. + /** + ISO 639-1 code indicating the language of the model. + */ public var language: String? - /// Model description. + /** + Model description. + */ public var description: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/Parameters.swift b/Source/NaturalLanguageUnderstandingV1/Models/Parameters.swift index 57179947f..e29258c2b 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/Parameters.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/Parameters.swift @@ -19,34 +19,54 @@ import Foundation /** An object containing request parameters. */ public struct Parameters: Encodable { - /// The plain text to analyze. + /** + The plain text to analyze. + */ public var text: String? - /// The HTML file to analyze. + /** + The HTML file to analyze. + */ public var html: String? - /// The web page to analyze. + /** + The web page to analyze. + */ public var url: String? - /// Specific features to analyze the document for. + /** + Specific features to analyze the document for. + */ public var features: Features - /// Remove website elements, such as links, ads, etc. + /** + Remove website elements, such as links, ads, etc. + */ public var clean: Bool? - /// XPath query for targeting nodes in HTML. + /** + XPath query for targeting nodes in HTML. + */ public var xpath: String? - /// Whether to use raw HTML content if text cleaning fails. + /** + Whether to use raw HTML content if text cleaning fails. + */ public var fallbackToRaw: Bool? - /// Whether or not to return the analyzed text. + /** + Whether or not to return the analyzed text. + */ public var returnAnalyzedText: Bool? - /// ISO 639-1 code indicating the language to use in the analysis. + /** + ISO 639-1 code indicating the language to use in the analysis. + */ public var language: String? - /// Sets the maximum number of characters that are processed by the service. + /** + Sets the maximum number of characters that are processed by the service. + */ public var limitTextCharacters: Int? // Map each property name to the key that shall be used for encoding/decoding. @@ -79,7 +99,19 @@ public struct Parameters: Encodable { - returns: An initialized `Parameters`. */ - public init(features: Features, text: String? = nil, html: String? = nil, url: String? = nil, clean: Bool? = nil, xpath: String? = nil, fallbackToRaw: Bool? = nil, returnAnalyzedText: Bool? = nil, language: String? = nil, limitTextCharacters: Int? = nil) { + public init( + features: Features, + text: String? = nil, + html: String? = nil, + url: String? = nil, + clean: Bool? = nil, + xpath: String? = nil, + fallbackToRaw: Bool? = nil, + returnAnalyzedText: Bool? = nil, + language: String? = nil, + limitTextCharacters: Int? = nil + ) + { self.features = features self.text = text self.html = html diff --git a/Source/NaturalLanguageUnderstandingV1/Models/RelationArgument.swift b/Source/NaturalLanguageUnderstandingV1/Models/RelationArgument.swift index 97b6a89e3..e4ba75921 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/RelationArgument.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/RelationArgument.swift @@ -21,10 +21,14 @@ public struct RelationArgument: Decodable { public var entities: [RelationEntity]? - /// Character offsets indicating the beginning and end of the mention in the analyzed text. + /** + Character offsets indicating the beginning and end of the mention in the analyzed text. + */ public var location: [Int]? - /// Text that corresponds to the argument. + /** + Text that corresponds to the argument. + */ public var text: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/RelationEntity.swift b/Source/NaturalLanguageUnderstandingV1/Models/RelationEntity.swift index cfc0a79f6..cbf692f8b 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/RelationEntity.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/RelationEntity.swift @@ -19,10 +19,14 @@ import Foundation /** An entity that corresponds with an argument in a relation. */ public struct RelationEntity: Decodable { - /// Text that corresponds to the entity. + /** + Text that corresponds to the entity. + */ public var text: String? - /// Entity type. + /** + Entity type. + */ public var type: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/RelationsOptions.swift b/Source/NaturalLanguageUnderstandingV1/Models/RelationsOptions.swift index 58c83bf7b..02e98218e 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/RelationsOptions.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/RelationsOptions.swift @@ -19,7 +19,9 @@ import Foundation /** An option specifying if the relationships found between entities in the analyzed content should be returned. */ public struct RelationsOptions: Encodable { - /// Enter a custom model ID to override the default model. + /** + Enter a custom model ID to override the default model. + */ public var model: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -34,7 +36,10 @@ public struct RelationsOptions: Encodable { - returns: An initialized `RelationsOptions`. */ - public init(model: String? = nil) { + public init( + model: String? = nil + ) + { self.model = model } diff --git a/Source/NaturalLanguageUnderstandingV1/Models/RelationsResult.swift b/Source/NaturalLanguageUnderstandingV1/Models/RelationsResult.swift index 138cdb607..2c937f823 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/RelationsResult.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/RelationsResult.swift @@ -19,16 +19,24 @@ import Foundation /** The relations between entities found in the content. */ public struct RelationsResult: Decodable { - /// Confidence score for the relation. Higher values indicate greater confidence. + /** + Confidence score for the relation. Higher values indicate greater confidence. + */ public var score: Double? - /// The sentence that contains the relation. + /** + The sentence that contains the relation. + */ public var sentence: String? - /// The type of the relation. + /** + The type of the relation. + */ public var type: String? - /// The extracted relation objects from the text. + /** + The extracted relation objects from the text. + */ public var arguments: [RelationArgument]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesAction.swift b/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesAction.swift index 9b07ce311..42efa1cec 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesAction.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesAction.swift @@ -19,10 +19,14 @@ import Foundation /** SemanticRolesAction. */ public struct SemanticRolesAction: Decodable { - /// Analyzed text that corresponds to the action. + /** + Analyzed text that corresponds to the action. + */ public var text: String? - /// normalized version of the action. + /** + normalized version of the action. + */ public var normalized: String? public var verb: SemanticRolesVerb? diff --git a/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesEntity.swift b/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesEntity.swift index 479ade073..c4f29c388 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesEntity.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesEntity.swift @@ -19,10 +19,14 @@ import Foundation /** SemanticRolesEntity. */ public struct SemanticRolesEntity: Decodable { - /// Entity type. + /** + Entity type. + */ public var type: String? - /// The entity text. + /** + The entity text. + */ public var text: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesKeyword.swift b/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesKeyword.swift index 567967c7b..ed793c6ee 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesKeyword.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesKeyword.swift @@ -19,7 +19,9 @@ import Foundation /** SemanticRolesKeyword. */ public struct SemanticRolesKeyword: Decodable { - /// The keyword text. + /** + The keyword text. + */ public var text: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesObject.swift b/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesObject.swift index 71cd33318..c79ce06a8 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesObject.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesObject.swift @@ -19,7 +19,9 @@ import Foundation /** SemanticRolesObject. */ public struct SemanticRolesObject: Decodable { - /// Object text. + /** + Object text. + */ public var text: String? public var keywords: [SemanticRolesKeyword]? diff --git a/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesOptions.swift b/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesOptions.swift index f1e58ee79..f05c1c1fe 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesOptions.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesOptions.swift @@ -19,13 +19,19 @@ import Foundation /** An option specifying whether or not to identify the subjects, actions, and verbs in the analyzed content. */ public struct SemanticRolesOptions: Encodable { - /// Maximum number of semantic_roles results to return. + /** + Maximum number of semantic_roles results to return. + */ public var limit: Int? - /// Set this to true to return keyword information for subjects and objects. + /** + Set this to true to return keyword information for subjects and objects. + */ public var keywords: Bool? - /// Set this to true to return entity information for subjects and objects. + /** + Set this to true to return entity information for subjects and objects. + */ public var entities: Bool? // Map each property name to the key that shall be used for encoding/decoding. @@ -44,7 +50,12 @@ public struct SemanticRolesOptions: Encodable { - returns: An initialized `SemanticRolesOptions`. */ - public init(limit: Int? = nil, keywords: Bool? = nil, entities: Bool? = nil) { + public init( + limit: Int? = nil, + keywords: Bool? = nil, + entities: Bool? = nil + ) + { self.limit = limit self.keywords = keywords self.entities = entities diff --git a/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesResult.swift b/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesResult.swift index 46040f5f7..10b9ecd22 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesResult.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesResult.swift @@ -19,16 +19,24 @@ import Foundation /** The object containing the actions and the objects the actions act upon. */ public struct SemanticRolesResult: Decodable { - /// Sentence from the source that contains the subject, action, and object. + /** + Sentence from the source that contains the subject, action, and object. + */ public var sentence: String? - /// The extracted subject from the sentence. + /** + The extracted subject from the sentence. + */ public var subject: SemanticRolesSubject? - /// The extracted action from the sentence. + /** + The extracted action from the sentence. + */ public var action: SemanticRolesAction? - /// The extracted object from the sentence. + /** + The extracted object from the sentence. + */ public var object: SemanticRolesObject? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesSubject.swift b/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesSubject.swift index ccfe1597a..c4ab4fd05 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesSubject.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesSubject.swift @@ -19,7 +19,9 @@ import Foundation /** SemanticRolesSubject. */ public struct SemanticRolesSubject: Decodable { - /// Text that corresponds to the subject role. + /** + Text that corresponds to the subject role. + */ public var text: String? public var entities: [SemanticRolesEntity]? diff --git a/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesVerb.swift b/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesVerb.swift index f84b3e1a6..56e34f021 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesVerb.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesVerb.swift @@ -19,10 +19,14 @@ import Foundation /** SemanticRolesVerb. */ public struct SemanticRolesVerb: Decodable { - /// The keyword text. + /** + The keyword text. + */ public var text: String? - /// Verb tense. + /** + Verb tense. + */ public var tense: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/SentimentOptions.swift b/Source/NaturalLanguageUnderstandingV1/Models/SentimentOptions.swift index 3c6619680..b77df22ab 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/SentimentOptions.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/SentimentOptions.swift @@ -19,10 +19,14 @@ import Foundation /** An option specifying if sentiment of detected entities, keywords, or phrases should be returned. */ public struct SentimentOptions: Encodable { - /// Set this to false to hide document-level sentiment results. + /** + Set this to false to hide document-level sentiment results. + */ public var document: Bool? - /// Sentiment results will be returned for each target string that is found in the document. + /** + Sentiment results will be returned for each target string that is found in the document. + */ public var targets: [String]? // Map each property name to the key that shall be used for encoding/decoding. @@ -39,7 +43,11 @@ public struct SentimentOptions: Encodable { - returns: An initialized `SentimentOptions`. */ - public init(document: Bool? = nil, targets: [String]? = nil) { + public init( + document: Bool? = nil, + targets: [String]? = nil + ) + { self.document = document self.targets = targets } diff --git a/Source/NaturalLanguageUnderstandingV1/Models/SentimentResult.swift b/Source/NaturalLanguageUnderstandingV1/Models/SentimentResult.swift index fc8d53d6d..3d3a432d5 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/SentimentResult.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/SentimentResult.swift @@ -19,10 +19,14 @@ import Foundation /** The sentiment of the content. */ public struct SentimentResult: Decodable { - /// The document level sentiment. + /** + The document level sentiment. + */ public var document: DocumentSentimentResults? - /// The targeted sentiment to analyze. + /** + The targeted sentiment to analyze. + */ public var targets: [TargetedSentimentResults]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/TargetedEmotionResults.swift b/Source/NaturalLanguageUnderstandingV1/Models/TargetedEmotionResults.swift index f90de7518..d2bca52f4 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/TargetedEmotionResults.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/TargetedEmotionResults.swift @@ -19,10 +19,14 @@ import Foundation /** An object containing the emotion results for the target. */ public struct TargetedEmotionResults: Decodable { - /// Targeted text. + /** + Targeted text. + */ public var text: String? - /// An object containing the emotion results for the target. + /** + An object containing the emotion results for the target. + */ public var emotion: EmotionScores? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/TargetedSentimentResults.swift b/Source/NaturalLanguageUnderstandingV1/Models/TargetedSentimentResults.swift index 11b7570d9..da8946425 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/TargetedSentimentResults.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/TargetedSentimentResults.swift @@ -19,10 +19,14 @@ import Foundation /** TargetedSentimentResults. */ public struct TargetedSentimentResults: Decodable { - /// Targeted text. + /** + Targeted text. + */ public var text: String? - /// Sentiment score from -1 (negative) to 1 (positive). + /** + Sentiment score from -1 (negative) to 1 (positive). + */ public var score: Double? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/Models/Usage.swift b/Source/NaturalLanguageUnderstandingV1/Models/Usage.swift index 0b76b28a2..df962bdb0 100644 --- a/Source/NaturalLanguageUnderstandingV1/Models/Usage.swift +++ b/Source/NaturalLanguageUnderstandingV1/Models/Usage.swift @@ -19,13 +19,19 @@ import Foundation /** Usage information. */ public struct Usage: Decodable { - /// Number of features used in the API call. + /** + Number of features used in the API call. + */ public var features: Int? - /// Number of text characters processed. + /** + Number of text characters processed. + */ public var textCharacters: Int? - /// Number of 10,000-character units processed. + /** + Number of 10,000-character units processed. + */ public var textUnits: Int? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/NaturalLanguageUnderstandingV1/NaturalLanguageUnderstanding.swift b/Source/NaturalLanguageUnderstandingV1/NaturalLanguageUnderstanding.swift index b50238971..1c8f454d3 100644 --- a/Source/NaturalLanguageUnderstandingV1/NaturalLanguageUnderstanding.swift +++ b/Source/NaturalLanguageUnderstandingV1/NaturalLanguageUnderstanding.swift @@ -124,26 +124,37 @@ public class NaturalLanguageUnderstanding { /** Analyze text, HTML, or a public webpage. - Analyzes text, HTML, or a public webpage with one or more text analysis features. ### Concepts Identify general - concepts that are referenced or alluded to in your content. Concepts that are detected typically have an associated - link to a DBpedia resource. ### Emotion Detect anger, disgust, fear, joy, or sadness that is conveyed by your - content. Emotion information can be returned for detected entities, keywords, or user-specified target phrases - found in the text. ### Entities Detect important people, places, geopolitical entities and other types of entities - in your content. Entity detection recognizes consecutive coreferences of each entity. For example, analysis of the - following text would count \"Barack Obama\" and \"He\" as the same entity: \"Barack Obama was the 44th President - of the United States. He took office in January 2009.\" ### Keywords Determine the most important keywords in your - content. Keyword phrases are organized by relevance in the results. ### Metadata Get author information, - publication date, and the title of your text/HTML content. ### Relations Recognize when two entities are related, - and identify the type of relation. For example, you can identify an \"awardedTo\" relation between an award and - its recipient. ### Semantic Roles Parse sentences into subject-action-object form, and identify entities and - keywords that are subjects or objects of an action. ### Sentiment Determine whether your content conveys postive - or negative sentiment. Sentiment information can be returned for detected entities, keywords, or user-specified - target phrases found in the text. ### Categories Categorize your content into a hierarchical 5-level taxonomy. - For example, \"Leonardo DiCaprio won an Oscar\" returns \"/art and entertainment/movies and tv/movies\" as the most - confident classification. + Analyzes text, HTML, or a public webpage with one or more text analysis features. + ### Concepts + Identify general concepts that are referenced or alluded to in your content. Concepts that are detected typically + have an associated link to a DBpedia resource. + ### Emotion + Detect anger, disgust, fear, joy, or sadness that is conveyed by your content. Emotion information can be returned + for detected entities, keywords, or user-specified target phrases found in the text. + ### Entities + Detect important people, places, geopolitical entities and other types of entities in your content. Entity + detection recognizes consecutive coreferences of each entity. For example, analysis of the following text would + count \"Barack Obama\" and \"He\" as the same entity: + \"Barack Obama was the 44th President of the United States. He took office in January 2009.\" + ### Keywords + Determine the most important keywords in your content. Keyword phrases are organized by relevance in the results. + ### Metadata + Get author information, publication date, and the title of your text/HTML content. + ### Relations + Recognize when two entities are related, and identify the type of relation. For example, you can identify an + \"awardedTo\" relation between an award and its recipient. + ### Semantic Roles + Parse sentences into subject-action-object form, and identify entities and keywords that are subjects or objects of + an action. + ### Sentiment + Determine whether your content conveys postive or negative sentiment. Sentiment information can be returned for + detected entities, keywords, or user-specified target phrases found in the text. + ### Categories + Categorize your content into a hierarchical 5-level taxonomy. For example, \"Leonardo DiCaprio won an Oscar\" + returns \"/art and entertainment/movies and tv/movies\" as the most confident classification. - parameter parameters: An object containing request parameters. The `features` object and one of the `text`, `html`, or `url` attributes - are required. + are required. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. diff --git a/Source/PersonalityInsightsV3/Models/Behavior.swift b/Source/PersonalityInsightsV3/Models/Behavior.swift index adb66db5d..9e2ccc075 100644 --- a/Source/PersonalityInsightsV3/Models/Behavior.swift +++ b/Source/PersonalityInsightsV3/Models/Behavior.swift @@ -19,16 +19,26 @@ import Foundation /** Behavior. */ public struct Behavior: Decodable { - /// The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form `behavior_{value}`. + /** + The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form + `behavior_{value}`. + */ public var traitID: String - /// The user-visible, localized name of the characteristic. + /** + The user-visible, localized name of the characteristic. + */ public var name: String - /// The category of the characteristic: `behavior` for temporal data. + /** + The category of the characteristic: `behavior` for temporal data. + */ public var category: String - /// For JSON content that is timestamped, the percentage of timestamped input data that occurred during that day of the week or hour of the day. The range is 0 to 1. + /** + For JSON content that is timestamped, the percentage of timestamped input data that occurred during that day of the + week or hour of the day. The range is 0 to 1. + */ public var percentage: Double // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/PersonalityInsightsV3/Models/ConsumptionPreferences.swift b/Source/PersonalityInsightsV3/Models/ConsumptionPreferences.swift index 387beb75c..d3c85dd28 100644 --- a/Source/PersonalityInsightsV3/Models/ConsumptionPreferences.swift +++ b/Source/PersonalityInsightsV3/Models/ConsumptionPreferences.swift @@ -19,13 +19,25 @@ import Foundation /** ConsumptionPreferences. */ public struct ConsumptionPreferences: Decodable { - /// The unique, non-localized identifier of the consumption preference to which the results pertain. IDs have the form `consumption_preferences_{preference}`. + /** + The unique, non-localized identifier of the consumption preference to which the results pertain. IDs have the form + `consumption_preferences_{preference}`. + */ public var consumptionPreferenceID: String - /// The user-visible, localized name of the consumption preference. + /** + The user-visible, localized name of the consumption preference. + */ public var name: String - /// The score for the consumption preference: * `0.0`: Unlikely * `0.5`: Neutral * `1.0`: Likely The scores for some preferences are binary and do not allow a neutral value. The score is an indication of preference based on the results inferred from the input text, not a normalized percentile. + /** + The score for the consumption preference: + * `0.0`: Unlikely + * `0.5`: Neutral + * `1.0`: Likely + The scores for some preferences are binary and do not allow a neutral value. The score is an indication of + preference based on the results inferred from the input text, not a normalized percentile. + */ public var score: Double // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/PersonalityInsightsV3/Models/ConsumptionPreferencesCategory.swift b/Source/PersonalityInsightsV3/Models/ConsumptionPreferencesCategory.swift index 84d41704e..f1e825dfb 100644 --- a/Source/PersonalityInsightsV3/Models/ConsumptionPreferencesCategory.swift +++ b/Source/PersonalityInsightsV3/Models/ConsumptionPreferencesCategory.swift @@ -19,13 +19,20 @@ import Foundation /** ConsumptionPreferencesCategory. */ public struct ConsumptionPreferencesCategory: Decodable { - /// The unique, non-localized identifier of the consumption preferences category to which the results pertain. IDs have the form `consumption_preferences_{category}`. + /** + The unique, non-localized identifier of the consumption preferences category to which the results pertain. IDs have + the form `consumption_preferences_{category}`. + */ public var consumptionPreferenceCategoryID: String - /// The user-visible name of the consumption preferences category. + /** + The user-visible name of the consumption preferences category. + */ public var name: String - /// Detailed results inferred from the input text for the individual preferences of the category. + /** + Detailed results inferred from the input text for the individual preferences of the category. + */ public var consumptionPreferences: [ConsumptionPreferences] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/PersonalityInsightsV3/Models/Content.swift b/Source/PersonalityInsightsV3/Models/Content.swift index 017c1210a..eacdbdd14 100644 --- a/Source/PersonalityInsightsV3/Models/Content.swift +++ b/Source/PersonalityInsightsV3/Models/Content.swift @@ -19,7 +19,9 @@ import Foundation /** Content. */ public struct Content: Encodable { - /// An array of `ContentItem` objects that provides the text that is to be analyzed. + /** + An array of `ContentItem` objects that provides the text that is to be analyzed. + */ public var contentItems: [ContentItem] // Map each property name to the key that shall be used for encoding/decoding. @@ -34,7 +36,10 @@ public struct Content: Encodable { - returns: An initialized `Content`. */ - public init(contentItems: [ContentItem]) { + public init( + contentItems: [ContentItem] + ) + { self.contentItems = contentItems } diff --git a/Source/PersonalityInsightsV3/Models/ContentItem.swift b/Source/PersonalityInsightsV3/Models/ContentItem.swift index 6d0eff575..8edde3e15 100644 --- a/Source/PersonalityInsightsV3/Models/ContentItem.swift +++ b/Source/PersonalityInsightsV3/Models/ContentItem.swift @@ -19,13 +19,23 @@ import Foundation /** ContentItem. */ public struct ContentItem: Encodable { - /// The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is analyzed; plain text is processed as submitted. + /** + The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is + analyzed; plain text is processed as submitted. + */ public enum Contenttype: String { case plain = "text/plain" case html = "text/html" } - /// The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is `en` (English). Regional variants are treated as their parent language; for example, `en-US` is interpreted as `en`. A language specified with the **Content-Type** parameter overrides the value of this parameter; any content items that specify a different language are ignored. Omit the **Content-Type** parameter to base the language on the most prevalent specification among the content items; again, content items that specify a different language are ignored. You can specify any combination of languages for the input and response content. + /** + The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is `en` + (English). Regional variants are treated as their parent language; for example, `en-US` is interpreted as `en`. A + language specified with the **Content-Type** parameter overrides the value of this parameter; any content items + that specify a different language are ignored. Omit the **Content-Type** parameter to base the language on the most + prevalent specification among the content items; again, content items that specify a different language are + ignored. You can specify any combination of languages for the input and response content. + */ public enum Language: String { case ar = "ar" case en = "en" @@ -34,31 +44,59 @@ public struct ContentItem: Encodable { case ko = "ko" } - /// The content that is to be analyzed. The service supports up to 20 MB of content for all `ContentItem` objects combined. + /** + The content that is to be analyzed. The service supports up to 20 MB of content for all `ContentItem` objects + combined. + */ public var content: String - /// A unique identifier for this content item. + /** + A unique identifier for this content item. + */ public var id: String? - /// A timestamp that identifies when this content was created. Specify a value in milliseconds since the UNIX Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data. + /** + A timestamp that identifies when this content was created. Specify a value in milliseconds since the UNIX Epoch + (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data. + */ public var created: Int? - /// A timestamp that identifies when this content was last updated. Specify a value in milliseconds since the UNIX Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data. + /** + A timestamp that identifies when this content was last updated. Specify a value in milliseconds since the UNIX + Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data. + */ public var updated: Int? - /// The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is analyzed; plain text is processed as submitted. + /** + The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is + analyzed; plain text is processed as submitted. + */ public var contenttype: String? - /// The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is `en` (English). Regional variants are treated as their parent language; for example, `en-US` is interpreted as `en`. A language specified with the **Content-Type** parameter overrides the value of this parameter; any content items that specify a different language are ignored. Omit the **Content-Type** parameter to base the language on the most prevalent specification among the content items; again, content items that specify a different language are ignored. You can specify any combination of languages for the input and response content. + /** + The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is `en` + (English). Regional variants are treated as their parent language; for example, `en-US` is interpreted as `en`. A + language specified with the **Content-Type** parameter overrides the value of this parameter; any content items + that specify a different language are ignored. Omit the **Content-Type** parameter to base the language on the most + prevalent specification among the content items; again, content items that specify a different language are + ignored. You can specify any combination of languages for the input and response content. + */ public var language: String? - /// The unique ID of the parent content item for this item. Used to identify hierarchical relationships between posts/replies, messages/replies, and so on. + /** + The unique ID of the parent content item for this item. Used to identify hierarchical relationships between + posts/replies, messages/replies, and so on. + */ public var parentid: String? - /// Indicates whether this content item is a reply to another content item. + /** + Indicates whether this content item is a reply to another content item. + */ public var reply: Bool? - /// Indicates whether this content item is a forwarded/copied version of another content item. + /** + Indicates whether this content item is a forwarded/copied version of another content item. + */ public var forward: Bool? // Map each property name to the key that shall be used for encoding/decoding. @@ -77,19 +115,40 @@ public struct ContentItem: Encodable { /** Initialize a `ContentItem` with member variables. - - parameter content: The content that is to be analyzed. The service supports up to 20 MB of content for all `ContentItem` objects combined. + - parameter content: The content that is to be analyzed. The service supports up to 20 MB of content for all `ContentItem` objects + combined. - parameter id: A unique identifier for this content item. - - parameter created: A timestamp that identifies when this content was created. Specify a value in milliseconds since the UNIX Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data. - - parameter updated: A timestamp that identifies when this content was last updated. Specify a value in milliseconds since the UNIX Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data. - - parameter contenttype: The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is analyzed; plain text is processed as submitted. - - parameter language: The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is `en` (English). Regional variants are treated as their parent language; for example, `en-US` is interpreted as `en`. A language specified with the **Content-Type** parameter overrides the value of this parameter; any content items that specify a different language are ignored. Omit the **Content-Type** parameter to base the language on the most prevalent specification among the content items; again, content items that specify a different language are ignored. You can specify any combination of languages for the input and response content. - - parameter parentid: The unique ID of the parent content item for this item. Used to identify hierarchical relationships between posts/replies, messages/replies, and so on. + - parameter created: A timestamp that identifies when this content was created. Specify a value in milliseconds since the UNIX Epoch + (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data. + - parameter updated: A timestamp that identifies when this content was last updated. Specify a value in milliseconds since the UNIX + Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data. + - parameter contenttype: The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is + analyzed; plain text is processed as submitted. + - parameter language: The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is + `en` (English). Regional variants are treated as their parent language; for example, `en-US` is interpreted as + `en`. A language specified with the **Content-Type** parameter overrides the value of this parameter; any content + items that specify a different language are ignored. Omit the **Content-Type** parameter to base the language on + the most prevalent specification among the content items; again, content items that specify a different language + are ignored. You can specify any combination of languages for the input and response content. + - parameter parentid: The unique ID of the parent content item for this item. Used to identify hierarchical relationships between + posts/replies, messages/replies, and so on. - parameter reply: Indicates whether this content item is a reply to another content item. - parameter forward: Indicates whether this content item is a forwarded/copied version of another content item. - returns: An initialized `ContentItem`. */ - public init(content: String, id: String? = nil, created: Int? = nil, updated: Int? = nil, contenttype: String? = nil, language: String? = nil, parentid: String? = nil, reply: Bool? = nil, forward: Bool? = nil) { + public init( + content: String, + id: String? = nil, + created: Int? = nil, + updated: Int? = nil, + contenttype: String? = nil, + language: String? = nil, + parentid: String? = nil, + reply: Bool? = nil, + forward: Bool? = nil + ) + { self.content = content self.id = id self.created = created diff --git a/Source/PersonalityInsightsV3/Models/Profile.swift b/Source/PersonalityInsightsV3/Models/Profile.swift index 8fecf05b9..8411cece2 100644 --- a/Source/PersonalityInsightsV3/Models/Profile.swift +++ b/Source/PersonalityInsightsV3/Models/Profile.swift @@ -19,7 +19,9 @@ import Foundation /** Profile. */ public struct Profile: Decodable { - /// The language model that was used to process the input. + /** + The language model that was used to process the input. + */ public enum ProcessedLanguage: String { case ar = "ar" case en = "en" @@ -28,31 +30,56 @@ public struct Profile: Decodable { case ko = "ko" } - /// The language model that was used to process the input. + /** + The language model that was used to process the input. + */ public var processedLanguage: String - /// The number of words from the input that were used to produce the profile. + /** + The number of words from the input that were used to produce the profile. + */ public var wordCount: Int - /// When guidance is appropriate, a string that provides a message that indicates the number of words found and where that value falls in the range of required or suggested number of words. + /** + When guidance is appropriate, a string that provides a message that indicates the number of words found and where + that value falls in the range of required or suggested number of words. + */ public var wordCountMessage: String? - /// A recursive array of `Trait` objects that provides detailed results for the Big Five personality characteristics (dimensions and facets) inferred from the input text. + /** + A recursive array of `Trait` objects that provides detailed results for the Big Five personality characteristics + (dimensions and facets) inferred from the input text. + */ public var personality: [Trait] - /// Detailed results for the Needs characteristics inferred from the input text. + /** + Detailed results for the Needs characteristics inferred from the input text. + */ public var needs: [Trait] - /// Detailed results for the Values characteristics inferred from the input text. + /** + Detailed results for the Values characteristics inferred from the input text. + */ public var values: [Trait] - /// For JSON content that is timestamped, detailed results about the social behavior disclosed by the input in terms of temporal characteristics. The results include information about the distribution of the content over the days of the week and the hours of the day. + /** + For JSON content that is timestamped, detailed results about the social behavior disclosed by the input in terms of + temporal characteristics. The results include information about the distribution of the content over the days of + the week and the hours of the day. + */ public var behavior: [Behavior]? - /// If the **consumption_preferences** parameter is `true`, detailed results for each category of consumption preferences. Each element of the array provides information inferred from the input text for the individual preferences of that category. + /** + If the **consumption_preferences** parameter is `true`, detailed results for each category of consumption + preferences. Each element of the array provides information inferred from the input text for the individual + preferences of that category. + */ public var consumptionPreferences: [ConsumptionPreferencesCategory]? - /// Warning messages associated with the input text submitted with the request. The array is empty if the input generated no warnings. + /** + Warning messages associated with the input text submitted with the request. The array is empty if the input + generated no warnings. + */ public var warnings: [Warning] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/PersonalityInsightsV3/Models/Trait.swift b/Source/PersonalityInsightsV3/Models/Trait.swift index b88bb2196..724895402 100644 --- a/Source/PersonalityInsightsV3/Models/Trait.swift +++ b/Source/PersonalityInsightsV3/Models/Trait.swift @@ -19,32 +19,66 @@ import Foundation /** Trait. */ public struct Trait: Decodable { - /// The category of the characteristic: `personality` for Big Five personality characteristics, `needs` for Needs, and `values` for Values. + /** + The category of the characteristic: `personality` for Big Five personality characteristics, `needs` for Needs, and + `values` for Values. + */ public enum Category: String { case personality = "personality" case needs = "needs" case values = "values" } - /// The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form * `big5_{characteristic}` for Big Five personality dimensions * `facet_{characteristic}` for Big Five personality facets * `need_{characteristic}` for Needs *`value_{characteristic}` for Values. + /** + The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form + * `big5_{characteristic}` for Big Five personality dimensions + * `facet_{characteristic}` for Big Five personality facets + * `need_{characteristic}` for Needs + *`value_{characteristic}` for Values. + */ public var traitID: String - /// The user-visible, localized name of the characteristic. + /** + The user-visible, localized name of the characteristic. + */ public var name: String - /// The category of the characteristic: `personality` for Big Five personality characteristics, `needs` for Needs, and `values` for Values. + /** + The category of the characteristic: `personality` for Big Five personality characteristics, `needs` for Needs, and + `values` for Values. + */ public var category: String - /// The normalized percentile score for the characteristic. The range is 0 to 1. For example, if the percentage for Openness is 0.60, the author scored in the 60th percentile; the author is more open than 59 percent of the population and less open than 39 percent of the population. + /** + The normalized percentile score for the characteristic. The range is 0 to 1. For example, if the percentage for + Openness is 0.60, the author scored in the 60th percentile; the author is more open than 59 percent of the + population and less open than 39 percent of the population. + */ public var percentile: Double - /// The raw score for the characteristic. The range is 0 to 1. A higher score generally indicates a greater likelihood that the author has that characteristic, but raw scores must be considered in aggregate: The range of values in practice might be much smaller than 0 to 1, so an individual score must be considered in the context of the overall scores and their range. The raw score is computed based on the input and the service model; it is not normalized or compared with a sample population. The raw score enables comparison of the results against a different sampling population and with a custom normalization approach. + /** + The raw score for the characteristic. The range is 0 to 1. A higher score generally indicates a greater likelihood + that the author has that characteristic, but raw scores must be considered in aggregate: The range of values in + practice might be much smaller than 0 to 1, so an individual score must be considered in the context of the overall + scores and their range. + The raw score is computed based on the input and the service model; it is not normalized or compared with a sample + population. The raw score enables comparison of the results against a different sampling population and with a + custom normalization approach. + */ public var rawScore: Double? - /// **`2017-10-13`**: Indicates whether the characteristic is meaningful for the input language. The field is always `true` for all characteristics of English, Spanish, and Japanese input. The field is `false` for the subset of characteristics of Arabic and Korean input for which the service's models are unable to generate meaningful results. **`2016-10-19`**: Not returned. + /** + **`2017-10-13`**: Indicates whether the characteristic is meaningful for the input language. The field is always + `true` for all characteristics of English, Spanish, and Japanese input. The field is `false` for the subset of + characteristics of Arabic and Korean input for which the service's models are unable to generate meaningful + results. **`2016-10-19`**: Not returned. + */ public var significant: Bool? - /// For `personality` (Big Five) dimensions, more detailed results for the facets of each dimension as inferred from the input text. + /** + For `personality` (Big Five) dimensions, more detailed results for the facets of each dimension as inferred from + the input text. + */ public var children: [Trait]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/PersonalityInsightsV3/Models/Warning.swift b/Source/PersonalityInsightsV3/Models/Warning.swift index df4c22b30..2b3d07426 100644 --- a/Source/PersonalityInsightsV3/Models/Warning.swift +++ b/Source/PersonalityInsightsV3/Models/Warning.swift @@ -19,7 +19,9 @@ import Foundation /** Warning. */ public struct Warning: Decodable { - /// The identifier of the warning message. + /** + The identifier of the warning message. + */ public enum WarningID: String { case wordCountMessage = "WORD_COUNT_MESSAGE" case jsonAsText = "JSON_AS_TEXT" @@ -27,10 +29,24 @@ public struct Warning: Decodable { case partialTextUsed = "PARTIAL_TEXT_USED" } - /// The identifier of the warning message. + /** + The identifier of the warning message. + */ public var warningID: String - /// The message associated with the `warning_id`: * `WORD_COUNT_MESSAGE`: "There were {number} words in the input. We need a minimum of 600, preferably 1,200 or more, to compute statistically significant estimates." * `JSON_AS_TEXT`: "Request input was processed as text/plain as indicated, however detected a JSON input. Did you mean application/json?" * `CONTENT_TRUNCATED`: "For maximum accuracy while also optimizing processing time, only the first 250KB of input text (excluding markup) was analyzed. Accuracy levels off at approximately 3,000 words so this did not affect the accuracy of the profile." * `PARTIAL_TEXT_USED`, "The text provided to compute the profile was trimmed for performance reasons. This action does not affect the accuracy of the output, as not all of the input text was required." Applies only when Arabic input text exceeds a threshold at which additional words do not contribute to the accuracy of the profile. + /** + The message associated with the `warning_id`: + * `WORD_COUNT_MESSAGE`: "There were {number} words in the input. We need a minimum of 600, preferably 1,200 or + more, to compute statistically significant estimates." + * `JSON_AS_TEXT`: "Request input was processed as text/plain as indicated, however detected a JSON input. Did you + mean application/json?" + * `CONTENT_TRUNCATED`: "For maximum accuracy while also optimizing processing time, only the first 250KB of input + text (excluding markup) was analyzed. Accuracy levels off at approximately 3,000 words so this did not affect the + accuracy of the profile." + * `PARTIAL_TEXT_USED`, "The text provided to compute the profile was trimmed for performance reasons. This action + does not affect the accuracy of the output, as not all of the input text was required." Applies only when Arabic + input text exceeds a threshold at which additional words do not contribute to the accuracy of the profile. + */ public var message: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/PersonalityInsightsV3/PersonalityInsights.swift b/Source/PersonalityInsightsV3/PersonalityInsights.swift index ce7c60b9a..273a895ce 100644 --- a/Source/PersonalityInsightsV3/PersonalityInsights.swift +++ b/Source/PersonalityInsightsV3/PersonalityInsights.swift @@ -17,10 +17,10 @@ import Foundation /** - The IBM Watson Personality Insights service enables applications to derive insights from social media, enterprise data, - or other digital communications. The service uses linguistic analytics to infer individuals' intrinsic personality - characteristics, including Big Five, Needs, and Values, from digital communications such as email, text messages, - tweets, and forum posts. + The IBM Watson™ Personality Insights service enables applications to derive insights from social media, + enterprise data, or other digital communications. The service uses linguistic analytics to infer individuals' intrinsic + personality characteristics, including Big Five, Needs, and Values, from digital communications such as email, text + messages, tweets, and forum posts. The service can automatically infer, from potentially noisy social media, portraits of individuals that reflect their personality characteristics. The service can infer consumption preferences based on the results of its analysis and, for JSON content that is timestamped, can report temporal behavior. @@ -136,34 +136,35 @@ public class PersonalityInsights { service analyzes text in Arabic, English, Japanese, Korean, or Spanish and returns its results in a variety of languages. You can provide plain text, HTML, or JSON input by specifying the **Content-Type** parameter; the default is `text/plain`. Request a JSON or comma-separated values (CSV) response by specifying the **Accept** - parameter; CSV output includes a fixed number of columns and optional headers. Per the JSON specification, the - default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default - encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content - type of plain text or HTML, include the `charset` parameter to indicate the character encoding of the input text; - for example: `Content-Type: text/plain;charset=utf-8`. For detailed information about calling the service and the - responses it can generate, see [Requesting a + parameter; CSV output includes a fixed number of columns and optional headers. + Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the + HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character + set). When specifying a content type of plain text or HTML, include the `charset` parameter to indicate the + character encoding of the input text; for example: `Content-Type: text/plain;charset=utf-8`. + For detailed information about calling the service and the responses it can generate, see [Requesting a profile](https://console.bluemix.net/docs/services/personality-insights/input.html), [Understanding a JSON profile](https://console.bluemix.net/docs/services/personality-insights/output.html), and [Understanding a CSV profile](https://console.bluemix.net/docs/services/personality-insights/output-csv.html). - parameter content: A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see - [Providing sufficient input](https://console.bluemix.net/docs/services/personality-insights/input.html#sufficient). - For JSON input, provide an object of type `Content`. + [Providing sufficient + input](https://console.bluemix.net/docs/services/personality-insights/input.html#sufficient). For JSON input, + provide an object of type `Content`. - parameter contentLanguage: The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish. Regional variants - are treated as their parent language; for example, `en-US` is interpreted as `en`. The effect of the - **Content-Language** parameter depends on the **Content-Type** parameter. When **Content-Type** is `text/plain` or - `text/html`, **Content-Language** is the only way to specify the language. When **Content-Type** is - `application/json`, **Content-Language** overrides a language specified with the `language` parameter of a - `ContentItem` object, and content items that specify a different language are ignored; omit this parameter to base - the language on the specification of the content items. You can specify any combination of languages for - **Content-Language** and **Accept-Language**. + are treated as their parent language; for example, `en-US` is interpreted as `en`. + The effect of the **Content-Language** parameter depends on the **Content-Type** parameter. When **Content-Type** + is `text/plain` or `text/html`, **Content-Language** is the only way to specify the language. When + **Content-Type** is `application/json`, **Content-Language** overrides a language specified with the `language` + parameter of a `ContentItem` object, and content items that specify a different language are ignored; omit this + parameter to base the language on the specification of the content items. You can specify any combination of + languages for **Content-Language** and **Accept-Language**. - parameter acceptLanguage: The desired language of the response. For two-character arguments, regional variants are treated as their parent - language; for example, `en-US` is interpreted as `en`. You can specify any combination of languages for the input - and response content. + language; for example, `en-US` is interpreted as `en`. You can specify any combination of languages for the input + and response content. - parameter rawScores: Indicates whether a raw score in addition to a normalized percentile is returned for each characteristic; raw - scores are not compared with a sample population. By default, only normalized percentiles are returned. - - parameter consumptionPreferences: Indicates whether consumption preferences are returned with the results. By default, no consumption preferences are - returned. + scores are not compared with a sample population. By default, only normalized percentiles are returned. + - parameter consumptionPreferences: Indicates whether consumption preferences are returned with the results. By default, no consumption preferences + are returned. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -239,34 +240,35 @@ public class PersonalityInsights { service analyzes text in Arabic, English, Japanese, Korean, or Spanish and returns its results in a variety of languages. You can provide plain text, HTML, or JSON input by specifying the **Content-Type** parameter; the default is `text/plain`. Request a JSON or comma-separated values (CSV) response by specifying the **Accept** - parameter; CSV output includes a fixed number of columns and optional headers. Per the JSON specification, the - default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default - encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content - type of plain text or HTML, include the `charset` parameter to indicate the character encoding of the input text; - for example: `Content-Type: text/plain;charset=utf-8`. For detailed information about calling the service and the - responses it can generate, see [Requesting a + parameter; CSV output includes a fixed number of columns and optional headers. + Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the + HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character + set). When specifying a content type of plain text or HTML, include the `charset` parameter to indicate the + character encoding of the input text; for example: `Content-Type: text/plain;charset=utf-8`. + For detailed information about calling the service and the responses it can generate, see [Requesting a profile](https://console.bluemix.net/docs/services/personality-insights/input.html), [Understanding a JSON profile](https://console.bluemix.net/docs/services/personality-insights/output.html), and [Understanding a CSV profile](https://console.bluemix.net/docs/services/personality-insights/output-csv.html). - parameter text: A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see - [Providing sufficient input](https://console.bluemix.net/docs/services/personality-insights/input.html#sufficient). - For JSON input, provide an object of type `Content`. + [Providing sufficient + input](https://console.bluemix.net/docs/services/personality-insights/input.html#sufficient). For JSON input, + provide an object of type `Content`. - parameter contentLanguage: The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish. Regional variants - are treated as their parent language; for example, `en-US` is interpreted as `en`. The effect of the - **Content-Language** parameter depends on the **Content-Type** parameter. When **Content-Type** is `text/plain` or - `text/html`, **Content-Language** is the only way to specify the language. When **Content-Type** is - `application/json`, **Content-Language** overrides a language specified with the `language` parameter of a - `ContentItem` object, and content items that specify a different language are ignored; omit this parameter to base - the language on the specification of the content items. You can specify any combination of languages for - **Content-Language** and **Accept-Language**. + are treated as their parent language; for example, `en-US` is interpreted as `en`. + The effect of the **Content-Language** parameter depends on the **Content-Type** parameter. When **Content-Type** + is `text/plain` or `text/html`, **Content-Language** is the only way to specify the language. When + **Content-Type** is `application/json`, **Content-Language** overrides a language specified with the `language` + parameter of a `ContentItem` object, and content items that specify a different language are ignored; omit this + parameter to base the language on the specification of the content items. You can specify any combination of + languages for **Content-Language** and **Accept-Language**. - parameter acceptLanguage: The desired language of the response. For two-character arguments, regional variants are treated as their parent language; for example, `en-US` is interpreted as `en`. You can specify any combination of languages for the input and response content. - parameter rawScores: Indicates whether a raw score in addition to a normalized percentile is returned for each characteristic; raw scores are not compared with a sample population. By default, only normalized percentiles are returned. - - parameter consumptionPreferences: Indicates whether consumption preferences are returned with the results. By default, no consumption preferences are - returned. + - parameter consumptionPreferences: Indicates whether consumption preferences are returned with the results. By default, no consumption preferences + are returned. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -342,34 +344,35 @@ public class PersonalityInsights { service analyzes text in Arabic, English, Japanese, Korean, or Spanish and returns its results in a variety of languages. You can provide plain text, HTML, or JSON input by specifying the **Content-Type** parameter; the default is `text/plain`. Request a JSON or comma-separated values (CSV) response by specifying the **Accept** - parameter; CSV output includes a fixed number of columns and optional headers. Per the JSON specification, the - default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default - encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content - type of plain text or HTML, include the `charset` parameter to indicate the character encoding of the input text; - for example: `Content-Type: text/plain;charset=utf-8`. For detailed information about calling the service and the - responses it can generate, see [Requesting a + parameter; CSV output includes a fixed number of columns and optional headers. + Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the + HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character + set). When specifying a content type of plain text or HTML, include the `charset` parameter to indicate the + character encoding of the input text; for example: `Content-Type: text/plain;charset=utf-8`. + For detailed information about calling the service and the responses it can generate, see [Requesting a profile](https://console.bluemix.net/docs/services/personality-insights/input.html), [Understanding a JSON profile](https://console.bluemix.net/docs/services/personality-insights/output.html), and [Understanding a CSV profile](https://console.bluemix.net/docs/services/personality-insights/output-csv.html). - parameter html: A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see - [Providing sufficient input](https://console.bluemix.net/docs/services/personality-insights/input.html#sufficient). - For JSON input, provide an object of type `Content`. - - parameter contentLanguage: The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish. Regional variants - are treated as their parent language; for example, `en-US` is interpreted as `en`. The effect of the - **Content-Language** parameter depends on the **Content-Type** parameter. When **Content-Type** is `text/plain` or - `text/html`, **Content-Language** is the only way to specify the language. When **Content-Type** is - `application/json`, **Content-Language** overrides a language specified with the `language` parameter of a - `ContentItem` object, and content items that specify a different language are ignored; omit this parameter to base - the language on the specification of the content items. You can specify any combination of languages for - **Content-Language** and **Accept-Language**. + [Providing sufficient + input](https://console.bluemix.net/docs/services/personality-insights/input.html#sufficient). For JSON input, + provide an object of type `Content`. + - parameter contentLanguage: The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish. Regional variants + are treated as their parent language; for example, `en-US` is interpreted as `en`. + The effect of the **Content-Language** parameter depends on the **Content-Type** parameter. When **Content-Type** + is `text/plain` or `text/html`, **Content-Language** is the only way to specify the language. When + **Content-Type** is `application/json`, **Content-Language** overrides a language specified with the `language` + parameter of a `ContentItem` object, and content items that specify a different language are ignored; omit this + parameter to base the language on the specification of the content items. You can specify any combination of + languages for **Content-Language** and **Accept-Language**. - parameter acceptLanguage: The desired language of the response. For two-character arguments, regional variants are treated as their parent language; for example, `en-US` is interpreted as `en`. You can specify any combination of languages for the input and response content. - parameter rawScores: Indicates whether a raw score in addition to a normalized percentile is returned for each characteristic; raw scores are not compared with a sample population. By default, only normalized percentiles are returned. - - parameter consumptionPreferences: Indicates whether consumption preferences are returned with the results. By default, no consumption preferences are - returned. + - parameter consumptionPreferences: Indicates whether consumption preferences are returned with the results. By default, no consumption preferences + are returned. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -437,7 +440,7 @@ public class PersonalityInsights { } /** - Get profile. as csv + Get profile as csv. Generates a personality profile for the author of the input text. The service accepts a maximum of 20 MB of input content, but it requires much less text to produce an accurate profile; for more information, see [Providing @@ -445,36 +448,37 @@ public class PersonalityInsights { service analyzes text in Arabic, English, Japanese, Korean, or Spanish and returns its results in a variety of languages. You can provide plain text, HTML, or JSON input by specifying the **Content-Type** parameter; the default is `text/plain`. Request a JSON or comma-separated values (CSV) response by specifying the **Accept** - parameter; CSV output includes a fixed number of columns and optional headers. Per the JSON specification, the - default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default - encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content - type of plain text or HTML, include the `charset` parameter to indicate the character encoding of the input text; - for example: `Content-Type: text/plain;charset=utf-8`. For detailed information about calling the service and the - responses it can generate, see [Requesting a + parameter; CSV output includes a fixed number of columns and optional headers. + Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the + HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character + set). When specifying a content type of plain text or HTML, include the `charset` parameter to indicate the + character encoding of the input text; for example: `Content-Type: text/plain;charset=utf-8`. + For detailed information about calling the service and the responses it can generate, see [Requesting a profile](https://console.bluemix.net/docs/services/personality-insights/input.html), [Understanding a JSON profile](https://console.bluemix.net/docs/services/personality-insights/output.html), and [Understanding a CSV profile](https://console.bluemix.net/docs/services/personality-insights/output-csv.html). - parameter content: A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see - [Providing sufficient input](https://console.bluemix.net/docs/services/personality-insights/input.html#sufficient). - For JSON input, provide an object of type `Content`. + [Providing sufficient + input](https://console.bluemix.net/docs/services/personality-insights/input.html#sufficient). For JSON input, + provide an object of type `Content`. - parameter contentLanguage: The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish. Regional variants - are treated as their parent language; for example, `en-US` is interpreted as `en`. The effect of the - **Content-Language** parameter depends on the **Content-Type** parameter. When **Content-Type** is `text/plain` or - `text/html`, **Content-Language** is the only way to specify the language. When **Content-Type** is - `application/json`, **Content-Language** overrides a language specified with the `language` parameter of a - `ContentItem` object, and content items that specify a different language are ignored; omit this parameter to base - the language on the specification of the content items. You can specify any combination of languages for - **Content-Language** and **Accept-Language**. + are treated as their parent language; for example, `en-US` is interpreted as `en`. + The effect of the **Content-Language** parameter depends on the **Content-Type** parameter. When **Content-Type** + is `text/plain` or `text/html`, **Content-Language** is the only way to specify the language. When + **Content-Type** is `application/json`, **Content-Language** overrides a language specified with the `language` + parameter of a `ContentItem` object, and content items that specify a different language are ignored; omit this + parameter to base the language on the specification of the content items. You can specify any combination of + languages for **Content-Language** and **Accept-Language**. - parameter acceptLanguage: The desired language of the response. For two-character arguments, regional variants are treated as their parent - language; for example, `en-US` is interpreted as `en`. You can specify any combination of languages for the input - and response content. + language; for example, `en-US` is interpreted as `en`. You can specify any combination of languages for the input + and response content. - parameter rawScores: Indicates whether a raw score in addition to a normalized percentile is returned for each characteristic; raw - scores are not compared with a sample population. By default, only normalized percentiles are returned. + scores are not compared with a sample population. By default, only normalized percentiles are returned. - parameter csvHeaders: Indicates whether column labels are returned with a CSV response. By default, no column labels are returned. - Applies only when the **Accept** parameter is set to `text/csv`. - - parameter consumptionPreferences: Indicates whether consumption preferences are returned with the results. By default, no consumption preferences are - returned. + Applies only when the **Accept** parameter is set to `text/csv`. + - parameter consumptionPreferences: Indicates whether consumption preferences are returned with the results. By default, no consumption preferences + are returned. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -547,7 +551,7 @@ public class PersonalityInsights { } /** - Get profile. as csv + Get profile as csv. Generates a personality profile for the author of the input text. The service accepts a maximum of 20 MB of input content, but it requires much less text to produce an accurate profile; for more information, see [Providing @@ -555,27 +559,28 @@ public class PersonalityInsights { service analyzes text in Arabic, English, Japanese, Korean, or Spanish and returns its results in a variety of languages. You can provide plain text, HTML, or JSON input by specifying the **Content-Type** parameter; the default is `text/plain`. Request a JSON or comma-separated values (CSV) response by specifying the **Accept** - parameter; CSV output includes a fixed number of columns and optional headers. Per the JSON specification, the - default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default - encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content - type of plain text or HTML, include the `charset` parameter to indicate the character encoding of the input text; - for example: `Content-Type: text/plain;charset=utf-8`. For detailed information about calling the service and the - responses it can generate, see [Requesting a + parameter; CSV output includes a fixed number of columns and optional headers. + Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the + HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character + set). When specifying a content type of plain text or HTML, include the `charset` parameter to indicate the + character encoding of the input text; for example: `Content-Type: text/plain;charset=utf-8`. + For detailed information about calling the service and the responses it can generate, see [Requesting a profile](https://console.bluemix.net/docs/services/personality-insights/input.html), [Understanding a JSON profile](https://console.bluemix.net/docs/services/personality-insights/output.html), and [Understanding a CSV profile](https://console.bluemix.net/docs/services/personality-insights/output-csv.html). - parameter text: A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see - [Providing sufficient input](https://console.bluemix.net/docs/services/personality-insights/input.html#sufficient). - For JSON input, provide an object of type `Content`. + [Providing sufficient + input](https://console.bluemix.net/docs/services/personality-insights/input.html#sufficient). For JSON input, + provide an object of type `Content`. - parameter contentLanguage: The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish. Regional variants - are treated as their parent language; for example, `en-US` is interpreted as `en`. The effect of the - **Content-Language** parameter depends on the **Content-Type** parameter. When **Content-Type** is `text/plain` or - `text/html`, **Content-Language** is the only way to specify the language. When **Content-Type** is - `application/json`, **Content-Language** overrides a language specified with the `language` parameter of a - `ContentItem` object, and content items that specify a different language are ignored; omit this parameter to base - the language on the specification of the content items. You can specify any combination of languages for - **Content-Language** and **Accept-Language**. + are treated as their parent language; for example, `en-US` is interpreted as `en`. + The effect of the **Content-Language** parameter depends on the **Content-Type** parameter. When **Content-Type** + is `text/plain` or `text/html`, **Content-Language** is the only way to specify the language. When + **Content-Type** is `application/json`, **Content-Language** overrides a language specified with the `language` + parameter of a `ContentItem` object, and content items that specify a different language are ignored; omit this + parameter to base the language on the specification of the content items. You can specify any combination of + languages for **Content-Language** and **Accept-Language**. - parameter acceptLanguage: The desired language of the response. For two-character arguments, regional variants are treated as their parent language; for example, `en-US` is interpreted as `en`. You can specify any combination of languages for the input and response content. @@ -583,8 +588,8 @@ public class PersonalityInsights { scores are not compared with a sample population. By default, only normalized percentiles are returned. - parameter csvHeaders: Indicates whether column labels are returned with a CSV response. By default, no column labels are returned. Applies only when the **Accept** parameter is set to `text/csv`. - - parameter consumptionPreferences: Indicates whether consumption preferences are returned with the results. By default, no consumption preferences are - returned. + - parameter consumptionPreferences: Indicates whether consumption preferences are returned with the results. By default, no consumption preferences + are returned. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -656,8 +661,9 @@ public class PersonalityInsights { } } + /** - Get profile. as csv + Get profile as csv. Generates a personality profile for the author of the input text. The service accepts a maximum of 20 MB of input content, but it requires much less text to produce an accurate profile; for more information, see [Providing @@ -665,27 +671,28 @@ public class PersonalityInsights { service analyzes text in Arabic, English, Japanese, Korean, or Spanish and returns its results in a variety of languages. You can provide plain text, HTML, or JSON input by specifying the **Content-Type** parameter; the default is `text/plain`. Request a JSON or comma-separated values (CSV) response by specifying the **Accept** - parameter; CSV output includes a fixed number of columns and optional headers. Per the JSON specification, the - default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default - encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content - type of plain text or HTML, include the `charset` parameter to indicate the character encoding of the input text; - for example: `Content-Type: text/plain;charset=utf-8`. For detailed information about calling the service and the - responses it can generate, see [Requesting a + parameter; CSV output includes a fixed number of columns and optional headers. + Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the + HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character + set). When specifying a content type of plain text or HTML, include the `charset` parameter to indicate the + character encoding of the input text; for example: `Content-Type: text/plain;charset=utf-8`. + For detailed information about calling the service and the responses it can generate, see [Requesting a profile](https://console.bluemix.net/docs/services/personality-insights/input.html), [Understanding a JSON profile](https://console.bluemix.net/docs/services/personality-insights/output.html), and [Understanding a CSV profile](https://console.bluemix.net/docs/services/personality-insights/output-csv.html). - parameter html: A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see - [Providing sufficient input](https://console.bluemix.net/docs/services/personality-insights/input.html#sufficient). - For JSON input, provide an object of type `Content`. + [Providing sufficient + input](https://console.bluemix.net/docs/services/personality-insights/input.html#sufficient). For JSON input, + provide an object of type `Content`. - parameter contentLanguage: The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish. Regional variants - are treated as their parent language; for example, `en-US` is interpreted as `en`. The effect of the - **Content-Language** parameter depends on the **Content-Type** parameter. When **Content-Type** is `text/plain` or - `text/html`, **Content-Language** is the only way to specify the language. When **Content-Type** is - `application/json`, **Content-Language** overrides a language specified with the `language` parameter of a - `ContentItem` object, and content items that specify a different language are ignored; omit this parameter to base - the language on the specification of the content items. You can specify any combination of languages for - **Content-Language** and **Accept-Language**. + are treated as their parent language; for example, `en-US` is interpreted as `en`. + The effect of the **Content-Language** parameter depends on the **Content-Type** parameter. When **Content-Type** + is `text/plain` or `text/html`, **Content-Language** is the only way to specify the language. When + **Content-Type** is `application/json`, **Content-Language** overrides a language specified with the `language` + parameter of a `ContentItem` object, and content items that specify a different language are ignored; omit this + parameter to base the language on the specification of the content items. You can specify any combination of + languages for **Content-Language** and **Accept-Language**. - parameter acceptLanguage: The desired language of the response. For two-character arguments, regional variants are treated as their parent language; for example, `en-US` is interpreted as `en`. You can specify any combination of languages for the input and response content. @@ -693,8 +700,8 @@ public class PersonalityInsights { scores are not compared with a sample population. By default, only normalized percentiles are returned. - parameter csvHeaders: Indicates whether column labels are returned with a CSV response. By default, no column labels are returned. Applies only when the **Accept** parameter is set to `text/csv`. - - parameter consumptionPreferences: Indicates whether consumption preferences are returned with the results. By default, no consumption preferences are - returned. + - parameter consumptionPreferences: Indicates whether consumption preferences are returned with the results. By default, no consumption preferences + are returned. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. diff --git a/Source/RestKit/RestRequest.swift b/Source/RestKit/RestRequest.swift index 0d6e5754e..3aef0c016 100644 --- a/Source/RestKit/RestRequest.swift +++ b/Source/RestKit/RestRequest.swift @@ -22,7 +22,7 @@ internal struct RestRequest { internal static let userAgent: String = { let sdk = "watson-apis-swift-sdk" - let sdkVersion = "0.27.0" + let sdkVersion = "0.28.0" let operatingSystem: String = { #if os(iOS) diff --git a/Source/SpeechToTextV1/Models/AcousticModel.swift b/Source/SpeechToTextV1/Models/AcousticModel.swift index 8dc89ff7f..8206e0a29 100644 --- a/Source/SpeechToTextV1/Models/AcousticModel.swift +++ b/Source/SpeechToTextV1/Models/AcousticModel.swift @@ -19,7 +19,16 @@ import Foundation /** AcousticModel. */ public struct AcousticModel: Decodable { - /// The current status of the custom acoustic model: * `pending` indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * `ready` indicates that the model contains data and is ready to be trained. * `training` indicates that the model is currently being trained. * `available` indicates that the model is trained and ready to use. * `upgrading` indicates that the model is currently being upgraded. * `failed` indicates that training of the model failed. + /** + The current status of the custom acoustic model: + * `pending` indicates that the model was created but is waiting either for training data to be added or for the + service to finish analyzing added data. + * `ready` indicates that the model contains data and is ready to be trained. + * `training` indicates that the model is currently being trained. + * `available` indicates that the model is trained and ready to use. + * `upgrading` indicates that the model is currently being upgraded. + * `failed` indicates that training of the model failed. + */ public enum Status: String { case pending = "pending" case ready = "ready" @@ -29,37 +38,73 @@ public struct AcousticModel: Decodable { case failed = "failed" } - /// The customization ID (GUID) of the custom acoustic model. The **Create a custom acoustic model** method returns only this field of the object; it does not return the other fields. + /** + The customization ID (GUID) of the custom acoustic model. The **Create a custom acoustic model** method returns + only this field of the object; it does not return the other fields. + */ public var customizationID: String - /// The date and time in Coordinated Universal Time (UTC) at which the custom acoustic model was created. The value is provided in full ISO 8601 format (`YYYY-MM-DDThh:mm:ss.sTZD`). + /** + The date and time in Coordinated Universal Time (UTC) at which the custom acoustic model was created. The value is + provided in full ISO 8601 format (`YYYY-MM-DDThh:mm:ss.sTZD`). + */ public var created: String? - /// The language identifier of the custom acoustic model (for example, `en-US`). + /** + The language identifier of the custom acoustic model (for example, `en-US`). + */ public var language: String? - /// A list of the available versions of the custom acoustic model. Each element of the array indicates a version of the base model with which the custom model can be used. Multiple versions exist only if the custom model has been upgraded; otherwise, only a single version is shown. + /** + A list of the available versions of the custom acoustic model. Each element of the array indicates a version of the + base model with which the custom model can be used. Multiple versions exist only if the custom model has been + upgraded; otherwise, only a single version is shown. + */ public var versions: [String]? - /// The GUID of the service credentials for the instance of the service that owns the custom acoustic model. + /** + The GUID of the service credentials for the instance of the service that owns the custom acoustic model. + */ public var owner: String? - /// The name of the custom acoustic model. + /** + The name of the custom acoustic model. + */ public var name: String? - /// The description of the custom acoustic model. + /** + The description of the custom acoustic model. + */ public var description: String? - /// The name of the language model for which the custom acoustic model was created. + /** + The name of the language model for which the custom acoustic model was created. + */ public var baseModelName: String? - /// The current status of the custom acoustic model: * `pending` indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * `ready` indicates that the model contains data and is ready to be trained. * `training` indicates that the model is currently being trained. * `available` indicates that the model is trained and ready to use. * `upgrading` indicates that the model is currently being upgraded. * `failed` indicates that training of the model failed. + /** + The current status of the custom acoustic model: + * `pending` indicates that the model was created but is waiting either for training data to be added or for the + service to finish analyzing added data. + * `ready` indicates that the model contains data and is ready to be trained. + * `training` indicates that the model is currently being trained. + * `available` indicates that the model is trained and ready to use. + * `upgrading` indicates that the model is currently being upgraded. + * `failed` indicates that training of the model failed. + */ public var status: String? - /// A percentage that indicates the progress of the custom acoustic model's current training. A value of `100` means that the model is fully trained. **Note:** The `progress` field does not currently reflect the progress of the training. The field changes from `0` to `100` when training is complete. + /** + A percentage that indicates the progress of the custom acoustic model's current training. A value of `100` means + that the model is fully trained. **Note:** The `progress` field does not currently reflect the progress of the + training. The field changes from `0` to `100` when training is complete. + */ public var progress: Int? - /// If the request included unknown parameters, the following message: `Unexpected query parameter(s) ['parameters'] detected`, where `parameters` is a list that includes a quoted string for each unknown parameter. + /** + If the request included unknown parameters, the following message: `Unexpected query parameter(s) ['parameters'] + detected`, where `parameters` is a list that includes a quoted string for each unknown parameter. + */ public var warnings: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/AcousticModels.swift b/Source/SpeechToTextV1/Models/AcousticModels.swift index 583790b7a..1d49890d0 100644 --- a/Source/SpeechToTextV1/Models/AcousticModels.swift +++ b/Source/SpeechToTextV1/Models/AcousticModels.swift @@ -19,7 +19,11 @@ import Foundation /** AcousticModels. */ public struct AcousticModels: Decodable { - /// An array of objects that provides information about each available custom acoustic model. The array is empty if the requesting service credentials own no custom acoustic models (if no language is specified) or own no custom acoustic models for the specified language. + /** + An array of objects that provides information about each available custom acoustic model. The array is empty if the + requesting service credentials own no custom acoustic models (if no language is specified) or own no custom + acoustic models for the specified language. + */ public var customizations: [AcousticModel] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/AudioDetails.swift b/Source/SpeechToTextV1/Models/AudioDetails.swift index 0045382c9..e713e15a4 100644 --- a/Source/SpeechToTextV1/Models/AudioDetails.swift +++ b/Source/SpeechToTextV1/Models/AudioDetails.swift @@ -19,28 +19,56 @@ import Foundation /** AudioDetails. */ public struct AudioDetails: Decodable { - /// The type of the audio resource: * `audio` for an individual audio file * `archive` for an archive (**.zip** or **.tar.gz**) file that contains audio files. + /** + The type of the audio resource: + * `audio` for an individual audio file + * `archive` for an archive (**.zip** or **.tar.gz**) file that contains audio files + * `undetermined` for a resource that the service cannot validate (for example, if the user mistakenly passes a file + that does not contain audio, such as a JPEG file). + */ public enum ModelType: String { case audio = "audio" case archive = "archive" + case undetermined = "undetermined" } - /// **For an archive-type resource,** the format of the compressed archive: * `zip` for a **.zip** file * `gzip` for a **.tar.gz** file Omitted for an audio-type resource. + /** + **For an archive-type resource,** the format of the compressed archive: + * `zip` for a **.zip** file + * `gzip` for a **.tar.gz** file + Omitted for an audio-type resource. + */ public enum Compression: String { case zip = "zip" case gzip = "gzip" } - /// The type of the audio resource: * `audio` for an individual audio file * `archive` for an archive (**.zip** or **.tar.gz**) file that contains audio files. + /** + The type of the audio resource: + * `audio` for an individual audio file + * `archive` for an archive (**.zip** or **.tar.gz**) file that contains audio files + * `undetermined` for a resource that the service cannot validate (for example, if the user mistakenly passes a file + that does not contain audio, such as a JPEG file). + */ public var type: String? - /// **For an audio-type resource,** the codec in which the audio is encoded. Omitted for an archive-type resource. + /** + **For an audio-type resource,** the codec in which the audio is encoded. Omitted for an archive-type resource. + */ public var codec: String? - /// **For an audio-type resource,** the sampling rate of the audio in Hertz (samples per second). Omitted for an archive-type resource. + /** + **For an audio-type resource,** the sampling rate of the audio in Hertz (samples per second). Omitted for an + archive-type resource. + */ public var frequency: Int? - /// **For an archive-type resource,** the format of the compressed archive: * `zip` for a **.zip** file * `gzip` for a **.tar.gz** file Omitted for an audio-type resource. + /** + **For an archive-type resource,** the format of the compressed archive: + * `zip` for a **.zip** file + * `gzip` for a **.tar.gz** file + Omitted for an audio-type resource. + */ public var compression: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/AudioListing.swift b/Source/SpeechToTextV1/Models/AudioListing.swift index 26265f033..09b8123c1 100644 --- a/Source/SpeechToTextV1/Models/AudioListing.swift +++ b/Source/SpeechToTextV1/Models/AudioListing.swift @@ -19,29 +19,61 @@ import Foundation /** AudioListing. */ public struct AudioListing: Decodable { - /// **For an audio-type resource,** the status of the resource: * `ok` indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * `being_processed` indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * `invalid` indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). Omitted for an archive-type resource. + /** + **For an audio-type resource,** the status of the resource: + * `ok` indicates that the service has successfully analyzed the audio data. The data can be used to train the + custom model. + * `being_processed` indicates that the service is still analyzing the audio data. The service cannot accept + requests to add new audio resources or to train the custom model until its analysis is complete. + * `invalid` indicates that the audio data is not valid for training the custom model (possibly because it has the + wrong format or sampling rate, or because it is corrupted). + Omitted for an archive-type resource. + */ public enum Status: String { case ok = "ok" case beingProcessed = "being_processed" case invalid = "invalid" } - /// **For an audio-type resource,** the total seconds of audio in the resource. Omitted for an archive-type resource. + /** + **For an audio-type resource,** the total seconds of audio in the resource. The value is always a whole number. + Omitted for an archive-type resource. + */ public var duration: Double? - /// **For an audio-type resource,** the name of the resource. Omitted for an archive-type resource. + /** + **For an audio-type resource,** the user-specified name of the resource. Omitted for an archive-type resource. + */ public var name: String? - /// **For an audio-type resource,** an `AudioDetails` object that provides detailed information about the resource. The object is empty until the service finishes processing the audio. Omitted for an archive-type resource. + /** + **For an audio-type resource,** an `AudioDetails` object that provides detailed information about the resource. The + object is empty until the service finishes processing the audio. Omitted for an archive-type resource. + */ public var details: AudioDetails? - /// **For an audio-type resource,** the status of the resource: * `ok` indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * `being_processed` indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * `invalid` indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). Omitted for an archive-type resource. + /** + **For an audio-type resource,** the status of the resource: + * `ok` indicates that the service has successfully analyzed the audio data. The data can be used to train the + custom model. + * `being_processed` indicates that the service is still analyzing the audio data. The service cannot accept + requests to add new audio resources or to train the custom model until its analysis is complete. + * `invalid` indicates that the audio data is not valid for training the custom model (possibly because it has the + wrong format or sampling rate, or because it is corrupted). + Omitted for an archive-type resource. + */ public var status: String? - /// **For an archive-type resource,** an object of type `AudioResource` that provides information about the resource. Omitted for an audio-type resource. + /** + **For an archive-type resource,** an object of type `AudioResource` that provides information about the resource. + Omitted for an audio-type resource. + */ public var container: AudioResource? - /// **For an archive-type resource,** an array of `AudioResource` objects that provides information about the audio-type resources that are contained in the resource. Omitted for an audio-type resource. + /** + **For an archive-type resource,** an array of `AudioResource` objects that provides information about the + audio-type resources that are contained in the resource. Omitted for an audio-type resource. + */ public var audio: [AudioResource]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/AudioResource.swift b/Source/SpeechToTextV1/Models/AudioResource.swift index ff8404bc0..47da19602 100644 --- a/Source/SpeechToTextV1/Models/AudioResource.swift +++ b/Source/SpeechToTextV1/Models/AudioResource.swift @@ -19,23 +19,50 @@ import Foundation /** AudioResource. */ public struct AudioResource: Decodable { - /// The status of the audio resource: * `ok` indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * `being_processed` indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * `invalid` indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if any of its audio files are invalid. + /** + The status of the audio resource: + * `ok` indicates that the service has successfully analyzed the audio data. The data can be used to train the + custom model. + * `being_processed` indicates that the service is still analyzing the audio data. The service cannot accept + requests to add new audio resources or to train the custom model until its analysis is complete. + * `invalid` indicates that the audio data is not valid for training the custom model (possibly because it has the + wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if + any of its audio files are invalid. + */ public enum Status: String { case ok = "ok" case beingProcessed = "being_processed" case invalid = "invalid" } - /// The total seconds of audio in the audio resource. + /** + The total seconds of audio in the audio resource. The value is always a whole number. + */ public var duration: Double - /// The name of the audio resource. + /** + **For an archive-type resource,** the user-specified name of the resource. + **For an audio-type resource,** the user-specified name of the resource or the name of the audio file that the user + added for the resource. The value depends on the method that is called. + */ public var name: String - /// An `AudioDetails` object that provides detailed information about the audio resource. The object is empty until the service finishes processing the audio. + /** + An `AudioDetails` object that provides detailed information about the audio resource. The object is empty until the + service finishes processing the audio. + */ public var details: AudioDetails - /// The status of the audio resource: * `ok` indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * `being_processed` indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * `invalid` indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if any of its audio files are invalid. + /** + The status of the audio resource: + * `ok` indicates that the service has successfully analyzed the audio data. The data can be used to train the + custom model. + * `being_processed` indicates that the service is still analyzing the audio data. The service cannot accept + requests to add new audio resources or to train the custom model until its analysis is complete. + * `invalid` indicates that the audio data is not valid for training the custom model (possibly because it has the + wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if + any of its audio files are invalid. + */ public var status: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/AudioResources.swift b/Source/SpeechToTextV1/Models/AudioResources.swift index 639026817..7c466b7b7 100644 --- a/Source/SpeechToTextV1/Models/AudioResources.swift +++ b/Source/SpeechToTextV1/Models/AudioResources.swift @@ -19,10 +19,16 @@ import Foundation /** AudioResources. */ public struct AudioResources: Decodable { - /// The total minutes of accumulated audio summed over all of the valid audio resources for the custom acoustic model. You can use this value to determine whether the custom model has too little or too much audio to begin training. + /** + The total minutes of accumulated audio summed over all of the valid audio resources for the custom acoustic model. + You can use this value to determine whether the custom model has too little or too much audio to begin training. + */ public var totalMinutesOfAudio: Double - /// An array of `AudioResource` objects that provides information about the audio resources of the custom acoustic model. The array is empty if the custom model has no audio resources. + /** + An array of objects that provides information about the audio resources of the custom acoustic model. The array is + empty if the custom model has no audio resources. + */ public var audio: [AudioResource] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/Corpora.swift b/Source/SpeechToTextV1/Models/Corpora.swift index a7a896928..bffd434d4 100644 --- a/Source/SpeechToTextV1/Models/Corpora.swift +++ b/Source/SpeechToTextV1/Models/Corpora.swift @@ -19,7 +19,10 @@ import Foundation /** Corpora. */ public struct Corpora: Decodable { - /// Information about corpora of the custom model. The array is empty if the custom model has no corpora. + /** + An array of objects that provides information about the corpora for the custom model. The array is empty if the + custom model has no corpora. + */ public var corpora: [Corpus] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/Corpus.swift b/Source/SpeechToTextV1/Models/Corpus.swift index adcad7d79..8bc9eef3b 100644 --- a/Source/SpeechToTextV1/Models/Corpus.swift +++ b/Source/SpeechToTextV1/Models/Corpus.swift @@ -19,26 +19,49 @@ import Foundation /** Corpus. */ public struct Corpus: Decodable { - /// The status of the corpus: * `analyzed` indicates that the service has successfully analyzed the corpus; the custom model can be trained with data from the corpus. * `being_processed` indicates that the service is still analyzing the corpus; the service cannot accept requests to add new corpora or words, or to train the custom model. * `undetermined` indicates that the service encountered an error while processing the corpus. + /** + The status of the corpus: + * `analyzed` indicates that the service has successfully analyzed the corpus; the custom model can be trained with + data from the corpus. + * `being_processed` indicates that the service is still analyzing the corpus; the service cannot accept requests to + add new corpora or words, or to train the custom model. + * `undetermined` indicates that the service encountered an error while processing the corpus. + */ public enum Status: String { case analyzed = "analyzed" case beingProcessed = "being_processed" case undetermined = "undetermined" } - /// The name of the corpus. + /** + The name of the corpus. + */ public var name: String - /// The total number of words in the corpus. The value is `0` while the corpus is being processed. + /** + The total number of words in the corpus. The value is `0` while the corpus is being processed. + */ public var totalWords: Int - /// The number of OOV words in the corpus. The value is `0` while the corpus is being processed. + /** + The number of OOV words in the corpus. The value is `0` while the corpus is being processed. + */ public var outOfVocabularyWords: Int - /// The status of the corpus: * `analyzed` indicates that the service has successfully analyzed the corpus; the custom model can be trained with data from the corpus. * `being_processed` indicates that the service is still analyzing the corpus; the service cannot accept requests to add new corpora or words, or to train the custom model. * `undetermined` indicates that the service encountered an error while processing the corpus. + /** + The status of the corpus: + * `analyzed` indicates that the service has successfully analyzed the corpus; the custom model can be trained with + data from the corpus. + * `being_processed` indicates that the service is still analyzing the corpus; the service cannot accept requests to + add new corpora or words, or to train the custom model. + * `undetermined` indicates that the service encountered an error while processing the corpus. + */ public var status: String - /// If the status of the corpus is `undetermined`, the following message: `Analysis of corpus 'name' failed. Please try adding the corpus again by setting the 'allow_overwrite' flag to 'true'`. + /** + If the status of the corpus is `undetermined`, the following message: `Analysis of corpus 'name' failed. Please try + adding the corpus again by setting the 'allow_overwrite' flag to 'true'`. + */ public var error: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/CreateAcousticModel.swift b/Source/SpeechToTextV1/Models/CreateAcousticModel.swift index 2ca2e47a5..2cd425d95 100644 --- a/Source/SpeechToTextV1/Models/CreateAcousticModel.swift +++ b/Source/SpeechToTextV1/Models/CreateAcousticModel.swift @@ -19,7 +19,12 @@ import Foundation /** CreateAcousticModel. */ public struct CreateAcousticModel: Encodable { - /// The name of the base language model that is to be customized by the new custom acoustic model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports acoustic model customization, refer to [Language support for customization](https://console.bluemix.net/docs/services/speech-to-text/custom.html#languageSupport). + /** + The name of the base language model that is to be customized by the new custom acoustic model. The new custom model + can be used only with the base model that it customizes. To determine whether a base model supports acoustic model + customization, refer to [Language support for + customization](https://console.bluemix.net/docs/services/speech-to-text/custom.html#languageSupport). + */ public enum BaseModelName: String { case arArBroadbandmodel = "ar-AR_BroadbandModel" case enGbBroadbandmodel = "en-GB_BroadbandModel" @@ -39,13 +44,25 @@ public struct CreateAcousticModel: Encodable { case zhCnNarrowbandmodel = "zh-CN_NarrowbandModel" } - /// A user-defined name for the new custom acoustic model. Use a name that is unique among all custom acoustic models that you own. Use a localized name that matches the language of the custom model. Use a name that describes the acoustic environment of the custom model, such as `Mobile custom model` or `Noisy car custom model`. + /** + A user-defined name for the new custom acoustic model. Use a name that is unique among all custom acoustic models + that you own. Use a localized name that matches the language of the custom model. Use a name that describes the + acoustic environment of the custom model, such as `Mobile custom model` or `Noisy car custom model`. + */ public var name: String - /// The name of the base language model that is to be customized by the new custom acoustic model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports acoustic model customization, refer to [Language support for customization](https://console.bluemix.net/docs/services/speech-to-text/custom.html#languageSupport). + /** + The name of the base language model that is to be customized by the new custom acoustic model. The new custom model + can be used only with the base model that it customizes. To determine whether a base model supports acoustic model + customization, refer to [Language support for + customization](https://console.bluemix.net/docs/services/speech-to-text/custom.html#languageSupport). + */ public var baseModelName: String - /// A description of the new custom acoustic model. Use a localized description that matches the language of the custom model. + /** + A description of the new custom acoustic model. Use a localized description that matches the language of the custom + model. + */ public var description: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -58,13 +75,24 @@ public struct CreateAcousticModel: Encodable { /** Initialize a `CreateAcousticModel` with member variables. - - parameter name: A user-defined name for the new custom acoustic model. Use a name that is unique among all custom acoustic models that you own. Use a localized name that matches the language of the custom model. Use a name that describes the acoustic environment of the custom model, such as `Mobile custom model` or `Noisy car custom model`. - - parameter baseModelName: The name of the base language model that is to be customized by the new custom acoustic model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports acoustic model customization, refer to [Language support for customization](https://console.bluemix.net/docs/services/speech-to-text/custom.html#languageSupport). - - parameter description: A description of the new custom acoustic model. Use a localized description that matches the language of the custom model. + - parameter name: A user-defined name for the new custom acoustic model. Use a name that is unique among all custom acoustic models + that you own. Use a localized name that matches the language of the custom model. Use a name that describes the + acoustic environment of the custom model, such as `Mobile custom model` or `Noisy car custom model`. + - parameter baseModelName: The name of the base language model that is to be customized by the new custom acoustic model. The new custom + model can be used only with the base model that it customizes. To determine whether a base model supports + acoustic model customization, refer to [Language support for + customization](https://console.bluemix.net/docs/services/speech-to-text/custom.html#languageSupport). + - parameter description: A description of the new custom acoustic model. Use a localized description that matches the language of the + custom model. - returns: An initialized `CreateAcousticModel`. */ - public init(name: String, baseModelName: String, description: String? = nil) { + public init( + name: String, + baseModelName: String, + description: String? = nil + ) + { self.name = name self.baseModelName = baseModelName self.description = description diff --git a/Source/SpeechToTextV1/Models/CreateLanguageModel.swift b/Source/SpeechToTextV1/Models/CreateLanguageModel.swift index 5a9e5d8ae..f7f5b5e69 100644 --- a/Source/SpeechToTextV1/Models/CreateLanguageModel.swift +++ b/Source/SpeechToTextV1/Models/CreateLanguageModel.swift @@ -19,7 +19,13 @@ import Foundation /** CreateLanguageModel. */ public struct CreateLanguageModel: Encodable { - /// The name of the base language model that is to be customized by the new custom language model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports language model customization, request information about the base model and check that the attribute `custom_language_model` is set to `true`, or refer to [Language support for customization](https://console.bluemix.net/docs/services/speech-to-text/custom.html#languageSupport). + /** + The name of the base language model that is to be customized by the new custom language model. The new custom model + can be used only with the base model that it customizes. To determine whether a base model supports language model + customization, request information about the base model and check that the attribute `custom_language_model` is set + to `true`, or refer to [Language support for + customization](https://console.bluemix.net/docs/services/speech-to-text/custom.html#languageSupport). + */ public enum BaseModelName: String { case enGbBroadbandmodel = "en-GB_BroadbandModel" case enGbNarrowbandmodel = "en-GB_NarrowbandModel" @@ -34,16 +40,38 @@ public struct CreateLanguageModel: Encodable { case koKrNarrowbandmodel = "ko-KR_NarrowbandModel" } - /// A user-defined name for the new custom language model. Use a name that is unique among all custom language models that you own. Use a localized name that matches the language of the custom model. Use a name that describes the domain of the custom model, such as `Medical custom model` or `Legal custom model`. + /** + A user-defined name for the new custom language model. Use a name that is unique among all custom language models + that you own. Use a localized name that matches the language of the custom model. Use a name that describes the + domain of the custom model, such as `Medical custom model` or `Legal custom model`. + */ public var name: String - /// The name of the base language model that is to be customized by the new custom language model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports language model customization, request information about the base model and check that the attribute `custom_language_model` is set to `true`, or refer to [Language support for customization](https://console.bluemix.net/docs/services/speech-to-text/custom.html#languageSupport). + /** + The name of the base language model that is to be customized by the new custom language model. The new custom model + can be used only with the base model that it customizes. To determine whether a base model supports language model + customization, request information about the base model and check that the attribute `custom_language_model` is set + to `true`, or refer to [Language support for + customization](https://console.bluemix.net/docs/services/speech-to-text/custom.html#languageSupport). + */ public var baseModelName: String - /// The dialect of the specified language that is to be used with the custom language model. The parameter is meaningful only for Spanish models, for which the service creates a custom language model that is suited for speech in one of the following dialects: * `es-ES` for Castilian Spanish (the default) * `es-LA` for Latin American Spanish * `es-US` for North American (Mexican) Spanish A specified dialect must be valid for the base model. By default, the dialect matches the language of the base model; for example, `en-US` for either of the US English language models. + /** + The dialect of the specified language that is to be used with the custom language model. The parameter is + meaningful only for Spanish models, for which the service creates a custom language model that is suited for speech + in one of the following dialects: + * `es-ES` for Castilian Spanish (the default) + * `es-LA` for Latin American Spanish + * `es-US` for North American (Mexican) Spanish + A specified dialect must be valid for the base model. By default, the dialect matches the language of the base + model; for example, `en-US` for either of the US English language models. + */ public var dialect: String? - /// A description of the new custom language model. Use a localized description that matches the language of the custom model. + /** + A description of the new custom language model. Use a localized description that matches the language of the custom + model. + */ public var description: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -57,14 +85,34 @@ public struct CreateLanguageModel: Encodable { /** Initialize a `CreateLanguageModel` with member variables. - - parameter name: A user-defined name for the new custom language model. Use a name that is unique among all custom language models that you own. Use a localized name that matches the language of the custom model. Use a name that describes the domain of the custom model, such as `Medical custom model` or `Legal custom model`. - - parameter baseModelName: The name of the base language model that is to be customized by the new custom language model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports language model customization, request information about the base model and check that the attribute `custom_language_model` is set to `true`, or refer to [Language support for customization](https://console.bluemix.net/docs/services/speech-to-text/custom.html#languageSupport). - - parameter dialect: The dialect of the specified language that is to be used with the custom language model. The parameter is meaningful only for Spanish models, for which the service creates a custom language model that is suited for speech in one of the following dialects: * `es-ES` for Castilian Spanish (the default) * `es-LA` for Latin American Spanish * `es-US` for North American (Mexican) Spanish A specified dialect must be valid for the base model. By default, the dialect matches the language of the base model; for example, `en-US` for either of the US English language models. - - parameter description: A description of the new custom language model. Use a localized description that matches the language of the custom model. + - parameter name: A user-defined name for the new custom language model. Use a name that is unique among all custom language models + that you own. Use a localized name that matches the language of the custom model. Use a name that describes the + domain of the custom model, such as `Medical custom model` or `Legal custom model`. + - parameter baseModelName: The name of the base language model that is to be customized by the new custom language model. The new custom + model can be used only with the base model that it customizes. To determine whether a base model supports + language model customization, request information about the base model and check that the attribute + `custom_language_model` is set to `true`, or refer to [Language support for + customization](https://console.bluemix.net/docs/services/speech-to-text/custom.html#languageSupport). + - parameter dialect: The dialect of the specified language that is to be used with the custom language model. The parameter is + meaningful only for Spanish models, for which the service creates a custom language model that is suited for + speech in one of the following dialects: + * `es-ES` for Castilian Spanish (the default) + * `es-LA` for Latin American Spanish + * `es-US` for North American (Mexican) Spanish + A specified dialect must be valid for the base model. By default, the dialect matches the language of the base + model; for example, `en-US` for either of the US English language models. + - parameter description: A description of the new custom language model. Use a localized description that matches the language of the + custom model. - returns: An initialized `CreateLanguageModel`. */ - public init(name: String, baseModelName: String, dialect: String? = nil, description: String? = nil) { + public init( + name: String, + baseModelName: String, + dialect: String? = nil, + description: String? = nil + ) + { self.name = name self.baseModelName = baseModelName self.dialect = dialect diff --git a/Source/SpeechToTextV1/Models/CustomWord.swift b/Source/SpeechToTextV1/Models/CustomWord.swift index be871d91e..8b704c9ff 100644 --- a/Source/SpeechToTextV1/Models/CustomWord.swift +++ b/Source/SpeechToTextV1/Models/CustomWord.swift @@ -19,13 +19,30 @@ import Foundation /** CustomWord. */ public struct CustomWord: Encodable { - /// For the **Add custom words** method, you must specify the custom word that is to be added to or updated in the custom model. Do not include spaces in the word. Use a `-` (dash) or `_` (underscore) to connect the tokens of compound words. Omit this field for the **Add a custom word** method. + /** + For the **Add custom words** method, you must specify the custom word that is to be added to or updated in the + custom model. Do not include spaces in the word. Use a `-` (dash) or `_` (underscore) to connect the tokens of + compound words. + Omit this field for the **Add a custom word** method. + */ public var word: String? - /// An array of sounds-like pronunciations for the custom word. Specify how words that are difficult to pronounce, foreign words, acronyms, and so on can be pronounced by users. For a word that is not in the service's base vocabulary, omit the parameter to have the service automatically generate a sounds-like pronunciation for the word. For a word that is in the service's base vocabulary, use the parameter to specify additional pronunciations for the word. You cannot override the default pronunciation of a word; pronunciations you add augment the pronunciation from the base vocabulary. A word can have at most five sounds-like pronunciations, and a pronunciation can include at most 40 characters not including spaces. + /** + An array of sounds-like pronunciations for the custom word. Specify how words that are difficult to pronounce, + foreign words, acronyms, and so on can be pronounced by users. For a word that is not in the service's base + vocabulary, omit the parameter to have the service automatically generate a sounds-like pronunciation for the word. + For a word that is in the service's base vocabulary, use the parameter to specify additional pronunciations for the + word. You cannot override the default pronunciation of a word; pronunciations you add augment the pronunciation + from the base vocabulary. A word can have at most five sounds-like pronunciations, and a pronunciation can include + at most 40 characters not including spaces. + */ public var soundsLike: [String]? - /// An alternative spelling for the custom word when it appears in a transcript. Use the parameter when you want the word to have a spelling that is different from its usual representation or from its spelling in corpora training data. + /** + An alternative spelling for the custom word when it appears in a transcript. Use the parameter when you want the + word to have a spelling that is different from its usual representation or from its spelling in corpora training + data. + */ public var displayAs: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -38,13 +55,29 @@ public struct CustomWord: Encodable { /** Initialize a `CustomWord` with member variables. - - parameter word: For the **Add custom words** method, you must specify the custom word that is to be added to or updated in the custom model. Do not include spaces in the word. Use a `-` (dash) or `_` (underscore) to connect the tokens of compound words. Omit this field for the **Add a custom word** method. - - parameter soundsLike: An array of sounds-like pronunciations for the custom word. Specify how words that are difficult to pronounce, foreign words, acronyms, and so on can be pronounced by users. For a word that is not in the service's base vocabulary, omit the parameter to have the service automatically generate a sounds-like pronunciation for the word. For a word that is in the service's base vocabulary, use the parameter to specify additional pronunciations for the word. You cannot override the default pronunciation of a word; pronunciations you add augment the pronunciation from the base vocabulary. A word can have at most five sounds-like pronunciations, and a pronunciation can include at most 40 characters not including spaces. - - parameter displayAs: An alternative spelling for the custom word when it appears in a transcript. Use the parameter when you want the word to have a spelling that is different from its usual representation or from its spelling in corpora training data. + - parameter word: For the **Add custom words** method, you must specify the custom word that is to be added to or updated in the + custom model. Do not include spaces in the word. Use a `-` (dash) or `_` (underscore) to connect the tokens of + compound words. + Omit this field for the **Add a custom word** method. + - parameter soundsLike: An array of sounds-like pronunciations for the custom word. Specify how words that are difficult to pronounce, + foreign words, acronyms, and so on can be pronounced by users. For a word that is not in the service's base + vocabulary, omit the parameter to have the service automatically generate a sounds-like pronunciation for the + word. For a word that is in the service's base vocabulary, use the parameter to specify additional pronunciations + for the word. You cannot override the default pronunciation of a word; pronunciations you add augment the + pronunciation from the base vocabulary. A word can have at most five sounds-like pronunciations, and a + pronunciation can include at most 40 characters not including spaces. + - parameter displayAs: An alternative spelling for the custom word when it appears in a transcript. Use the parameter when you want the + word to have a spelling that is different from its usual representation or from its spelling in corpora training + data. - returns: An initialized `CustomWord`. */ - public init(word: String? = nil, soundsLike: [String]? = nil, displayAs: String? = nil) { + public init( + word: String? = nil, + soundsLike: [String]? = nil, + displayAs: String? = nil + ) + { self.word = word self.soundsLike = soundsLike self.displayAs = displayAs diff --git a/Source/SpeechToTextV1/Models/CustomWords.swift b/Source/SpeechToTextV1/Models/CustomWords.swift index abf7e359f..f2676f1b5 100644 --- a/Source/SpeechToTextV1/Models/CustomWords.swift +++ b/Source/SpeechToTextV1/Models/CustomWords.swift @@ -19,7 +19,10 @@ import Foundation /** CustomWords. */ public struct CustomWords: Encodable { - /// An array of objects that provides information about each custom word that is to be added to or updated in the custom language model. + /** + An array of objects that provides information about each custom word that is to be added to or updated in the + custom language model. + */ public var words: [CustomWord] // Map each property name to the key that shall be used for encoding/decoding. @@ -30,11 +33,15 @@ public struct CustomWords: Encodable { /** Initialize a `CustomWords` with member variables. - - parameter words: An array of objects that provides information about each custom word that is to be added to or updated in the custom language model. + - parameter words: An array of objects that provides information about each custom word that is to be added to or updated in the + custom language model. - returns: An initialized `CustomWords`. */ - public init(words: [CustomWord]) { + public init( + words: [CustomWord] + ) + { self.words = words } diff --git a/Source/SpeechToTextV1/Models/KeywordResult.swift b/Source/SpeechToTextV1/Models/KeywordResult.swift index 7633c2bb0..08984d72b 100644 --- a/Source/SpeechToTextV1/Models/KeywordResult.swift +++ b/Source/SpeechToTextV1/Models/KeywordResult.swift @@ -19,16 +19,24 @@ import Foundation /** KeywordResult. */ public struct KeywordResult: Decodable { - /// A specified keyword normalized to the spoken phrase that matched in the audio input. + /** + A specified keyword normalized to the spoken phrase that matched in the audio input. + */ public var normalizedText: String - /// The start time in seconds of the keyword match. + /** + The start time in seconds of the keyword match. + */ public var startTime: Double - /// The end time in seconds of the keyword match. + /** + The end time in seconds of the keyword match. + */ public var endTime: Double - /// A confidence score for the keyword match in the range of 0 to 1. + /** + A confidence score for the keyword match in the range of 0 to 1. + */ public var confidence: Double // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/LanguageModel.swift b/Source/SpeechToTextV1/Models/LanguageModel.swift index 3b1905323..dfaa26ddb 100644 --- a/Source/SpeechToTextV1/Models/LanguageModel.swift +++ b/Source/SpeechToTextV1/Models/LanguageModel.swift @@ -19,7 +19,16 @@ import Foundation /** LanguageModel. */ public struct LanguageModel: Decodable { - /// The current status of the custom language model: * `pending` indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * `ready` indicates that the model contains data and is ready to be trained. * `training` indicates that the model is currently being trained. * `available` indicates that the model is trained and ready to use. * `upgrading` indicates that the model is currently being upgraded. * `failed` indicates that training of the model failed. + /** + The current status of the custom language model: + * `pending` indicates that the model was created but is waiting either for training data to be added or for the + service to finish analyzing added data. + * `ready` indicates that the model contains data and is ready to be trained. + * `training` indicates that the model is currently being trained. + * `available` indicates that the model is trained and ready to use. + * `upgrading` indicates that the model is currently being upgraded. + * `failed` indicates that training of the model failed. + */ public enum Status: String { case pending = "pending" case ready = "ready" @@ -29,40 +38,83 @@ public struct LanguageModel: Decodable { case failed = "failed" } - /// The customization ID (GUID) of the custom language model. The **Create a custom language model** method returns only this field of the object; it does not return the other fields. + /** + The customization ID (GUID) of the custom language model. The **Create a custom language model** method returns + only this field of the object; it does not return the other fields. + */ public var customizationID: String - /// The date and time in Coordinated Universal Time (UTC) at which the custom language model was created. The value is provided in full ISO 8601 format (`YYYY-MM-DDThh:mm:ss.sTZD`). + /** + The date and time in Coordinated Universal Time (UTC) at which the custom language model was created. The value is + provided in full ISO 8601 format (`YYYY-MM-DDThh:mm:ss.sTZD`). + */ public var created: String? - /// The language identifier of the custom language model (for example, `en-US`). + /** + The language identifier of the custom language model (for example, `en-US`). + */ public var language: String? - /// The dialect of the language for the custom language model. By default, the dialect matches the language of the base model; for example, `en-US` for either of the US English language models. For Spanish models, the field indicates the dialect for which the model was created: * `es-ES` for Castilian Spanish (the default) * `es-LA` for Latin American Spanish * `es-US` for North American (Mexican) Spanish. + /** + The dialect of the language for the custom language model. By default, the dialect matches the language of the base + model; for example, `en-US` for either of the US English language models. For Spanish models, the field indicates + the dialect for which the model was created: + * `es-ES` for Castilian Spanish (the default) + * `es-LA` for Latin American Spanish + * `es-US` for North American (Mexican) Spanish. + */ public var dialect: String? - /// A list of the available versions of the custom language model. Each element of the array indicates a version of the base model with which the custom model can be used. Multiple versions exist only if the custom model has been upgraded; otherwise, only a single version is shown. + /** + A list of the available versions of the custom language model. Each element of the array indicates a version of the + base model with which the custom model can be used. Multiple versions exist only if the custom model has been + upgraded; otherwise, only a single version is shown. + */ public var versions: [String]? - /// The GUID of the service credentials for the instance of the service that owns the custom language model. + /** + The GUID of the service credentials for the instance of the service that owns the custom language model. + */ public var owner: String? - /// The name of the custom language model. + /** + The name of the custom language model. + */ public var name: String? - /// The description of the custom language model. + /** + The description of the custom language model. + */ public var description: String? - /// The name of the language model for which the custom language model was created. + /** + The name of the language model for which the custom language model was created. + */ public var baseModelName: String? - /// The current status of the custom language model: * `pending` indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * `ready` indicates that the model contains data and is ready to be trained. * `training` indicates that the model is currently being trained. * `available` indicates that the model is trained and ready to use. * `upgrading` indicates that the model is currently being upgraded. * `failed` indicates that training of the model failed. + /** + The current status of the custom language model: + * `pending` indicates that the model was created but is waiting either for training data to be added or for the + service to finish analyzing added data. + * `ready` indicates that the model contains data and is ready to be trained. + * `training` indicates that the model is currently being trained. + * `available` indicates that the model is trained and ready to use. + * `upgrading` indicates that the model is currently being upgraded. + * `failed` indicates that training of the model failed. + */ public var status: String? - /// A percentage that indicates the progress of the custom language model's current training. A value of `100` means that the model is fully trained. **Note:** The `progress` field does not currently reflect the progress of the training. The field changes from `0` to `100` when training is complete. + /** + A percentage that indicates the progress of the custom language model's current training. A value of `100` means + that the model is fully trained. **Note:** The `progress` field does not currently reflect the progress of the + training. The field changes from `0` to `100` when training is complete. + */ public var progress: Int? - /// If the request included unknown parameters, the following message: `Unexpected query parameter(s) ['parameters'] detected`, where `parameters` is a list that includes a quoted string for each unknown parameter. + /** + If the request included unknown parameters, the following message: `Unexpected query parameter(s) ['parameters'] + detected`, where `parameters` is a list that includes a quoted string for each unknown parameter. + */ public var warnings: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/LanguageModels.swift b/Source/SpeechToTextV1/Models/LanguageModels.swift index d6ac2adb5..faabbc08c 100644 --- a/Source/SpeechToTextV1/Models/LanguageModels.swift +++ b/Source/SpeechToTextV1/Models/LanguageModels.swift @@ -19,7 +19,11 @@ import Foundation /** LanguageModels. */ public struct LanguageModels: Decodable { - /// An array of objects that provides information about each available custom language model. The array is empty if the requesting service credentials own no custom language models (if no language is specified) or own no custom language models for the specified language. + /** + An array of objects that provides information about each available custom language model. The array is empty if the + requesting service credentials own no custom language models (if no language is specified) or own no custom + language models for the specified language. + */ public var customizations: [LanguageModel] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/RecognitionJob.swift b/Source/SpeechToTextV1/Models/RecognitionJob.swift index 0c80439c2..03550b4e2 100644 --- a/Source/SpeechToTextV1/Models/RecognitionJob.swift +++ b/Source/SpeechToTextV1/Models/RecognitionJob.swift @@ -19,7 +19,17 @@ import Foundation /** RecognitionJob. */ public struct RecognitionJob: Decodable { - /// The current status of the job: * `waiting`: The service is preparing the job for processing. The service returns this status when the job is initially created or when it is waiting for capacity to process the job. The job remains in this state until the service has the capacity to begin processing it. * `processing`: The service is actively processing the job. * `completed`: The service has finished processing the job. If the job specified a callback URL and the event `recognitions.completed_with_results`, the service sent the results with the callback notification; otherwise, you must retrieve the results by checking the individual job. * `failed`: The job failed. + /** + The current status of the job: + * `waiting`: The service is preparing the job for processing. The service returns this status when the job is + initially created or when it is waiting for capacity to process the job. The job remains in this state until the + service has the capacity to begin processing it. + * `processing`: The service is actively processing the job. + * `completed`: The service has finished processing the job. If the job specified a callback URL and the event + `recognitions.completed_with_results`, the service sent the results with the callback notification; otherwise, you + must retrieve the results by checking the individual job. + * `failed`: The job failed. + */ public enum Status: String { case waiting = "waiting" case processing = "processing" @@ -27,28 +37,61 @@ public struct RecognitionJob: Decodable { case failed = "failed" } - /// The ID of the asynchronous job. + /** + The ID of the asynchronous job. + */ public var id: String - /// The current status of the job: * `waiting`: The service is preparing the job for processing. The service returns this status when the job is initially created or when it is waiting for capacity to process the job. The job remains in this state until the service has the capacity to begin processing it. * `processing`: The service is actively processing the job. * `completed`: The service has finished processing the job. If the job specified a callback URL and the event `recognitions.completed_with_results`, the service sent the results with the callback notification; otherwise, you must retrieve the results by checking the individual job. * `failed`: The job failed. + /** + The current status of the job: + * `waiting`: The service is preparing the job for processing. The service returns this status when the job is + initially created or when it is waiting for capacity to process the job. The job remains in this state until the + service has the capacity to begin processing it. + * `processing`: The service is actively processing the job. + * `completed`: The service has finished processing the job. If the job specified a callback URL and the event + `recognitions.completed_with_results`, the service sent the results with the callback notification; otherwise, you + must retrieve the results by checking the individual job. + * `failed`: The job failed. + */ public var status: String - /// The date and time in Coordinated Universal Time (UTC) at which the job was created. The value is provided in full ISO 8601 format (`YYYY-MM-DDThh:mm:ss.sTZD`). + /** + The date and time in Coordinated Universal Time (UTC) at which the job was created. The value is provided in full + ISO 8601 format (`YYYY-MM-DDThh:mm:ss.sTZD`). + */ public var created: String - /// The date and time in Coordinated Universal Time (UTC) at which the job was last updated by the service. The value is provided in full ISO 8601 format (`YYYY-MM-DDThh:mm:ss.sTZD`). This field is returned only by the **Check jobs** and **Check a job** methods. + /** + The date and time in Coordinated Universal Time (UTC) at which the job was last updated by the service. The value + is provided in full ISO 8601 format (`YYYY-MM-DDThh:mm:ss.sTZD`). This field is returned only by the **Check jobs** + and **Check a job** methods. + */ public var updated: String? - /// The URL to use to request information about the job with the **Check a job** method. This field is returned only by the **Create a job** method. + /** + The URL to use to request information about the job with the **Check a job** method. This field is returned only by + the **Create a job** method. + */ public var url: String? - /// The user token associated with a job that was created with a callback URL and a user token. This field can be returned only by the **Check jobs** method. + /** + The user token associated with a job that was created with a callback URL and a user token. This field can be + returned only by the **Check jobs** method. + */ public var userToken: String? - /// If the status is `completed`, the results of the recognition request as an array that includes a single instance of a `SpeechRecognitionResults` object. This field is returned only by the **Check a job** method. + /** + If the status is `completed`, the results of the recognition request as an array that includes a single instance of + a `SpeechRecognitionResults` object. This field is returned only by the **Check a job** method. + */ public var results: [SpeechRecognitionResults]? - /// An array of warning messages about invalid parameters included with the request. Each warning includes a descriptive message and a list of invalid argument strings, for example, `"unexpected query parameter 'user_token', query parameter 'callback_url' was not specified"`. The request succeeds despite the warnings. This field can be returned only by the **Create a job** method. + /** + An array of warning messages about invalid parameters included with the request. Each warning includes a + descriptive message and a list of invalid argument strings, for example, `"unexpected query parameter 'user_token', + query parameter 'callback_url' was not specified"`. The request succeeds despite the warnings. This field can be + returned only by the **Create a job** method. + */ public var warnings: [String]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/RecognitionJobs.swift b/Source/SpeechToTextV1/Models/RecognitionJobs.swift index 2ffe6be70..27cd6a1cc 100644 --- a/Source/SpeechToTextV1/Models/RecognitionJobs.swift +++ b/Source/SpeechToTextV1/Models/RecognitionJobs.swift @@ -19,7 +19,10 @@ import Foundation /** RecognitionJobs. */ public struct RecognitionJobs: Decodable { - /// An array of objects that provides the status for each of the user's current jobs. The array is empty if the user has no current jobs. + /** + An array of objects that provides the status for each of the user's current jobs. The array is empty if the user + has no current jobs. + */ public var recognitions: [RecognitionJob] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/RegisterStatus.swift b/Source/SpeechToTextV1/Models/RegisterStatus.swift index 97612b3f3..79d67cd9e 100644 --- a/Source/SpeechToTextV1/Models/RegisterStatus.swift +++ b/Source/SpeechToTextV1/Models/RegisterStatus.swift @@ -19,16 +19,26 @@ import Foundation /** RegisterStatus. */ public struct RegisterStatus: Decodable { - /// The current status of the job: * `created` if the callback URL was successfully white-listed as a result of the call. * `already created` if the URL was already white-listed. + /** + The current status of the job: + * `created` if the callback URL was successfully white-listed as a result of the call. + * `already created` if the URL was already white-listed. + */ public enum Status: String { case created = "created" case alreadyCreated = "already created" } - /// The current status of the job: * `created` if the callback URL was successfully white-listed as a result of the call. * `already created` if the URL was already white-listed. + /** + The current status of the job: + * `created` if the callback URL was successfully white-listed as a result of the call. + * `already created` if the URL was already white-listed. + */ public var status: String - /// The callback URL that is successfully registered. + /** + The callback URL that is successfully registered. + */ public var url: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/SpeakerLabelsResult.swift b/Source/SpeechToTextV1/Models/SpeakerLabelsResult.swift index 5545c05d8..5b16713db 100644 --- a/Source/SpeechToTextV1/Models/SpeakerLabelsResult.swift +++ b/Source/SpeechToTextV1/Models/SpeakerLabelsResult.swift @@ -19,19 +19,34 @@ import Foundation /** SpeakerLabelsResult. */ public struct SpeakerLabelsResult: Decodable { - /// The start time of a word from the transcript. The value matches the start time of a word from the `timestamps` array. + /** + The start time of a word from the transcript. The value matches the start time of a word from the `timestamps` + array. + */ public var from: Double - /// The end time of a word from the transcript. The value matches the end time of a word from the `timestamps` array. + /** + The end time of a word from the transcript. The value matches the end time of a word from the `timestamps` array. + */ public var to: Double - /// The numeric identifier that the service assigns to a speaker from the audio. Speaker IDs begin at `0` initially but can evolve and change across interim results (if supported by the method) and between interim and final results as the service processes the audio. They are not guaranteed to be sequential, contiguous, or ordered. + /** + The numeric identifier that the service assigns to a speaker from the audio. Speaker IDs begin at `0` initially but + can evolve and change across interim results (if supported by the method) and between interim and final results as + the service processes the audio. They are not guaranteed to be sequential, contiguous, or ordered. + */ public var speaker: Int - /// A score that indicates the service's confidence in its identification of the speaker in the range of 0 to 1. + /** + A score that indicates the service's confidence in its identification of the speaker in the range of 0 to 1. + */ public var confidence: Double - /// An indication of whether the service might further change word and speaker-label results. A value of `true` means that the service guarantees not to send any further updates for the current or any preceding results; `false` means that the service might send further updates to the results. + /** + An indication of whether the service might further change word and speaker-label results. A value of `true` means + that the service guarantees not to send any further updates for the current or any preceding results; `false` means + that the service might send further updates to the results. + */ public var finalResults: Bool // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/SpeechModel.swift b/Source/SpeechToTextV1/Models/SpeechModel.swift index 1a040f7b0..35ff2dd3a 100644 --- a/Source/SpeechToTextV1/Models/SpeechModel.swift +++ b/Source/SpeechToTextV1/Models/SpeechModel.swift @@ -19,25 +19,40 @@ import Foundation /** SpeechModel. */ public struct SpeechModel: Decodable { - /// The name of the model for use as an identifier in calls to the service (for example, `en-US_BroadbandModel`). + /** + The name of the model for use as an identifier in calls to the service (for example, `en-US_BroadbandModel`). + */ public var name: String - /// The language identifier of the model (for example, `en-US`). + /** + The language identifier of the model (for example, `en-US`). + */ public var language: String - /// The sampling rate (minimum acceptable rate for audio) used by the model in Hertz. + /** + The sampling rate (minimum acceptable rate for audio) used by the model in Hertz. + */ public var rate: Int - /// The URI for the model. + /** + The URI for the model. + */ public var url: String - /// Describes the additional service features supported with the model. + /** + Describes the additional service features supported with the model. + */ public var supportedFeatures: SupportedFeatures - /// Brief description of the model. + /** + Brief description of the model. + */ public var description: String - /// The URI for the model for use with the **Create a session** method. This field is returned only by the **Get a model** method. + /** + The URI for the model for use with the **Create a session** method. This field is returned only by the **Get a + model** method. + */ public var sessions: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/SpeechModels.swift b/Source/SpeechToTextV1/Models/SpeechModels.swift index 3a65eb31d..4ce32629f 100644 --- a/Source/SpeechToTextV1/Models/SpeechModels.swift +++ b/Source/SpeechToTextV1/Models/SpeechModels.swift @@ -19,7 +19,9 @@ import Foundation /** SpeechModels. */ public struct SpeechModels: Decodable { - /// Information about each available model. + /** + An array of objects that provides information about each available model. + */ public var models: [SpeechModel] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/SpeechRecognitionAlternative.swift b/Source/SpeechToTextV1/Models/SpeechRecognitionAlternative.swift index 81689b62c..e0940f4df 100644 --- a/Source/SpeechToTextV1/Models/SpeechRecognitionAlternative.swift +++ b/Source/SpeechToTextV1/Models/SpeechRecognitionAlternative.swift @@ -19,16 +19,29 @@ import Foundation /** SpeechRecognitionAlternative. */ public struct SpeechRecognitionAlternative: Decodable { - /// A transcription of the audio. + /** + A transcription of the audio. + */ public var transcript: String - /// A score that indicates the service's confidence in the transcript in the range of 0 to 1. Returned only for the best alternative and only with results marked as final. + /** + A score that indicates the service's confidence in the transcript in the range of 0 to 1. Returned only for the + best alternative and only with results marked as final. + */ public var confidence: Double? - /// Time alignments for each word from the transcript as a list of lists. Each inner list consists of three elements: the word followed by its start and end time in seconds. Example: `[["hello",0.0,1.2],["world",1.2,2.5]]`. Returned only for the best alternative. + /** + Time alignments for each word from the transcript as a list of lists. Each inner list consists of three elements: + the word followed by its start and end time in seconds. Example: `[["hello",0.0,1.2],["world",1.2,2.5]]`. Returned + only for the best alternative. + */ public var timestamps: [WordTimestamp]? - /// A confidence score for each word of the transcript as a list of lists. Each inner list consists of two elements: the word and its confidence score in the range of 0 to 1. Example: `[["hello",0.95],["world",0.866]]`. Returned only for the best alternative and only with results marked as final. + /** + A confidence score for each word of the transcript as a list of lists. Each inner list consists of two elements: + the word and its confidence score in the range of 0 to 1. Example: `[["hello",0.95],["world",0.866]]`. Returned + only for the best alternative and only with results marked as final. + */ public var wordConfidence: [WordConfidence]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/SpeechRecognitionResult.swift b/Source/SpeechToTextV1/Models/SpeechRecognitionResult.swift index 1df7a7dbb..17ee65ab2 100644 --- a/Source/SpeechToTextV1/Models/SpeechRecognitionResult.swift +++ b/Source/SpeechToTextV1/Models/SpeechRecognitionResult.swift @@ -19,16 +19,29 @@ import Foundation /** SpeechRecognitionResult. */ public struct SpeechRecognitionResult: Decodable { - /// An indication of whether the transcription results are final. If `true`, the results for this utterance are not updated further; no additional results are sent for a `result_index` once its results are indicated as final. + /** + An indication of whether the transcription results are final. If `true`, the results for this utterance are not + updated further; no additional results are sent for a `result_index` once its results are indicated as final. + */ public var finalResults: Bool - /// An array of alternative transcripts. The `alternatives` array can include additional requested output such as word confidence or timestamps. + /** + An array of alternative transcripts. The `alternatives` array can include additional requested output such as word + confidence or timestamps. + */ public var alternatives: [SpeechRecognitionAlternative] - /// A dictionary (or associative array) whose keys are the strings specified for `keywords` if both that parameter and `keywords_threshold` are specified. A keyword for which no matches are found is omitted from the array. The array is omitted if no matches are found for any keywords. + /** + A dictionary (or associative array) whose keys are the strings specified for `keywords` if both that parameter and + `keywords_threshold` are specified. A keyword for which no matches are found is omitted from the array. The array + is omitted if no matches are found for any keywords. + */ public var keywordsResult: [String: [KeywordResult]]? - /// An array of alternative hypotheses found for words of the input audio if a `word_alternatives_threshold` is specified. + /** + An array of alternative hypotheses found for words of the input audio if a `word_alternatives_threshold` is + specified. + */ public var wordAlternatives: [WordAlternativeResults]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/SpeechRecognitionResults.swift b/Source/SpeechToTextV1/Models/SpeechRecognitionResults.swift index 4549c382e..2a6b84c0d 100644 --- a/Source/SpeechToTextV1/Models/SpeechRecognitionResults.swift +++ b/Source/SpeechToTextV1/Models/SpeechRecognitionResults.swift @@ -19,16 +19,39 @@ import Foundation /** SpeechRecognitionResults. */ public struct SpeechRecognitionResults: Decodable { - /// An array that can include interim and final results (interim results are returned only if supported by the method). Final results are guaranteed not to change; interim results might be replaced by further interim results and final results. The service periodically sends updates to the results list; the `result_index` is set to the lowest index in the array that has changed; it is incremented for new results. + /** + An array that can include interim and final results (interim results are returned only if supported by the method). + Final results are guaranteed not to change; interim results might be replaced by further interim results and final + results. The service periodically sends updates to the results list; the `result_index` is set to the lowest index + in the array that has changed; it is incremented for new results. + */ public var results: [SpeechRecognitionResult]? - /// An index that indicates a change point in the `results` array. The service increments the index only for additional results that it sends for new audio for the same request. + /** + An index that indicates a change point in the `results` array. The service increments the index only for additional + results that it sends for new audio for the same request. + */ public var resultIndex: Int? - /// An array that identifies which words were spoken by which speakers in a multi-person exchange. Returned in the response only if `speaker_labels` is `true`. When interim results are also requested for methods that support them, it is possible for a `SpeechRecognitionResults` object to include only the `speaker_labels` field. + /** + An array that identifies which words were spoken by which speakers in a multi-person exchange. Returned in the + response only if `speaker_labels` is `true`. When interim results are also requested for methods that support them, + it is possible for a `SpeechRecognitionResults` object to include only the `speaker_labels` field. + */ public var speakerLabels: [SpeakerLabelsResult]? - /// An array of warning messages associated with the request: * Warnings for invalid parameters or fields can include a descriptive message and a list of invalid argument strings, for example, `"Unknown arguments:"` or `"Unknown url query arguments:"` followed by a list of the form `"invalid_arg_1, invalid_arg_2."` * The following warning is returned if the request passes a custom model that is based on an older version of a base model for which an updated version is available: `"Using previous version of base model, because your custom model has been built with it. Please note that this version will be supported only for a limited time. Consider updating your custom model to the new base model. If you do not do that you will be automatically switched to base model when you used the non-updated custom model."` In both cases, the request succeeds despite the warnings. + /** + An array of warning messages associated with the request: + * Warnings for invalid parameters or fields can include a descriptive message and a list of invalid argument + strings, for example, `"Unknown arguments:"` or `"Unknown url query arguments:"` followed by a list of the form + `"invalid_arg_1, invalid_arg_2."` + * The following warning is returned if the request passes a custom model that is based on an older version of a + base model for which an updated version is available: `"Using previous version of base model, because your custom + model has been built with it. Please note that this version will be supported only for a limited time. Consider + updating your custom model to the new base model. If you do not do that you will be automatically switched to base + model when you used the non-updated custom model."` + In both cases, the request succeeds despite the warnings. + */ public var warnings: [String]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/SupportedFeatures.swift b/Source/SpeechToTextV1/Models/SupportedFeatures.swift index 67b5897d5..64c71cee5 100644 --- a/Source/SpeechToTextV1/Models/SupportedFeatures.swift +++ b/Source/SpeechToTextV1/Models/SupportedFeatures.swift @@ -19,10 +19,15 @@ import Foundation /** SupportedFeatures. */ public struct SupportedFeatures: Decodable { - /// Indicates whether the customization interface can be used to create a custom language model based on the language model. + /** + Indicates whether the customization interface can be used to create a custom language model based on the language + model. + */ public var customLanguageModel: Bool - /// Indicates whether the `speaker_labels` parameter can be used with the language model. + /** + Indicates whether the `speaker_labels` parameter can be used with the language model. + */ public var speakerLabels: Bool // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/Word.swift b/Source/SpeechToTextV1/Models/Word.swift index b84d7fe3d..44695b311 100644 --- a/Source/SpeechToTextV1/Models/Word.swift +++ b/Source/SpeechToTextV1/Models/Word.swift @@ -19,22 +19,43 @@ import Foundation /** Word. */ public struct Word: Decodable { - /// A word from the custom model's words resource. The spelling of the word is used to train the model. + /** + A word from the custom model's words resource. The spelling of the word is used to train the model. + */ public var word: String - /// An array of pronunciations for the word. The array can include the sounds-like pronunciation automatically generated by the service if none is provided for the word; the service adds this pronunciation when it finishes processing the word. + /** + An array of pronunciations for the word. The array can include the sounds-like pronunciation automatically + generated by the service if none is provided for the word; the service adds this pronunciation when it finishes + processing the word. + */ public var soundsLike: [String] - /// The spelling of the word that the service uses to display the word in a transcript. The field contains an empty string if no display-as value is provided for the word, in which case the word is displayed as it is spelled. + /** + The spelling of the word that the service uses to display the word in a transcript. The field contains an empty + string if no display-as value is provided for the word, in which case the word is displayed as it is spelled. + */ public var displayAs: String - /// A sum of the number of times the word is found across all corpora. For example, if the word occurs five times in one corpus and seven times in another, its count is `12`. If you add a custom word to a model before it is added by any corpora, the count begins at `1`; if the word is added from a corpus first and later modified, the count reflects only the number of times it is found in corpora. + /** + A sum of the number of times the word is found across all corpora. For example, if the word occurs five times in + one corpus and seven times in another, its count is `12`. If you add a custom word to a model before it is added by + any corpora, the count begins at `1`; if the word is added from a corpus first and later modified, the count + reflects only the number of times it is found in corpora. + */ public var count: Int - /// An array of sources that describes how the word was added to the custom model's words resource. For OOV words added from a corpus, includes the name of the corpus; if the word was added by multiple corpora, the names of all corpora are listed. If the word was modified or added by the user directly, the field includes the string `user`. + /** + An array of sources that describes how the word was added to the custom model's words resource. For OOV words added + from a corpus, includes the name of the corpus; if the word was added by multiple corpora, the names of all corpora + are listed. If the word was modified or added by the user directly, the field includes the string `user`. + */ public var source: [String] - /// If the service discovered one or more problems that you need to correct for the word's definition, an array that describes each of the errors. + /** + If the service discovered one or more problems that you need to correct for the word's definition, an array that + describes each of the errors. + */ public var error: [WordError]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/WordAlternativeResult.swift b/Source/SpeechToTextV1/Models/WordAlternativeResult.swift index 4daa4f609..517499dd5 100644 --- a/Source/SpeechToTextV1/Models/WordAlternativeResult.swift +++ b/Source/SpeechToTextV1/Models/WordAlternativeResult.swift @@ -19,10 +19,14 @@ import Foundation /** WordAlternativeResult. */ public struct WordAlternativeResult: Decodable { - /// A confidence score for the word alternative hypothesis in the range of 0 to 1. + /** + A confidence score for the word alternative hypothesis in the range of 0 to 1. + */ public var confidence: Double - /// An alternative hypothesis for a word from the input audio. + /** + An alternative hypothesis for a word from the input audio. + */ public var word: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/WordAlternativeResults.swift b/Source/SpeechToTextV1/Models/WordAlternativeResults.swift index 1d95c6087..37f468534 100644 --- a/Source/SpeechToTextV1/Models/WordAlternativeResults.swift +++ b/Source/SpeechToTextV1/Models/WordAlternativeResults.swift @@ -19,13 +19,19 @@ import Foundation /** WordAlternativeResults. */ public struct WordAlternativeResults: Decodable { - /// The start time in seconds of the word from the input audio that corresponds to the word alternatives. + /** + The start time in seconds of the word from the input audio that corresponds to the word alternatives. + */ public var startTime: Double - /// The end time in seconds of the word from the input audio that corresponds to the word alternatives. + /** + The end time in seconds of the word from the input audio that corresponds to the word alternatives. + */ public var endTime: Double - /// An array of alternative hypotheses for a word from the input audio. + /** + An array of alternative hypotheses for a word from the input audio. + */ public var alternatives: [WordAlternativeResult] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/WordError.swift b/Source/SpeechToTextV1/Models/WordError.swift index 705065827..45e3b9652 100644 --- a/Source/SpeechToTextV1/Models/WordError.swift +++ b/Source/SpeechToTextV1/Models/WordError.swift @@ -19,7 +19,13 @@ import Foundation /** WordError. */ public struct WordError: Decodable { - /// A key-value pair that describes an error associated with the definition of a word in the words resource. Each pair has the format `"element": "message"`, where `element` is the aspect of the definition that caused the problem and `message` describes the problem. The following example describes a problem with one of the word's sounds-like definitions: `"{sounds_like_string}": "Numbers are not allowed in sounds-like. You can try for example '{suggested_string}'."` You must correct the error before you can train the model. + /** + A key-value pair that describes an error associated with the definition of a word in the words resource. Each pair + has the format `"element": "message"`, where `element` is the aspect of the definition that caused the problem and + `message` describes the problem. The following example describes a problem with one of the word's sounds-like + definitions: `"{sounds_like_string}": "Numbers are not allowed in sounds-like. You can try for example + '{suggested_string}'."` You must correct the error before you can train the model. + */ public var element: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/Models/Words.swift b/Source/SpeechToTextV1/Models/Words.swift index d917f12ac..3c173dd35 100644 --- a/Source/SpeechToTextV1/Models/Words.swift +++ b/Source/SpeechToTextV1/Models/Words.swift @@ -19,7 +19,10 @@ import Foundation /** Words. */ public struct Words: Decodable { - /// Information about each word in the custom model's words resource. The array is empty if the custom model has no words. + /** + An array of objects that provides information about each word in the custom model's words resource. The array is + empty if the custom model has no words. + */ public var words: [Word] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/SpeechToTextV1/SpeechToText.swift b/Source/SpeechToTextV1/SpeechToText.swift index b1258a078..7ff89d313 100644 --- a/Source/SpeechToTextV1/SpeechToText.swift +++ b/Source/SpeechToTextV1/SpeechToText.swift @@ -149,10 +149,10 @@ public class SpeechToText { } /** - Get models. + List models. - Retrieves a list of all language models that are available for use with the service. The information includes the - name of the model and its minimum sampling rate in Hertz, among other things. + Lists all language models that are available for use with the service. The information includes the name of the + model and its minimum sampling rate in Hertz, among other things. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. @@ -191,8 +191,8 @@ public class SpeechToText { /** Get a model. - Retrieves information about a single specified language model that is available for use with the service. The - information includes the name of the model and its minimum sampling rate in Hertz, among other things. + Gets information for a single specified language model that is available for use with the service. The information + includes the name of the model and its minimum sampling rate in Hertz, among other things. - parameter modelID: The identifier of the model in the form of its name from the output of the **Get models** method. - parameter headers: A dictionary of request headers to be sent with this request. @@ -236,95 +236,110 @@ public class SpeechToText { } /** - Sends audio for speech recognition in sessionless mode. + Recognize audio. Sends audio and returns transcription results for a sessionless recognition request. Returns only the final results; to enable interim results, use session-based requests or the WebSocket API. The service imposes a data size limit of 100 MB. It automatically detects the endianness of the incoming audio and, for audio that includes multiple channels, downmixes the audio to one-channel mono during transcoding. (For the `audio/l16` format, you can - specify the endianness.) ### Streaming mode For requests to transcribe live audio as it becomes available, you - must set the `Transfer-Encoding` header to `chunked` to use streaming mode. In streaming mode, the server closes - the connection (status code 408) if the service receives no data chunk for 30 seconds and the service has no audio - to transcribe for 30 seconds. The server also closes the connection (status code 400) if no speech is detected for - `inactivity_timeout` seconds of audio (not processing time); use the `inactivity_timeout` parameter to change the - default of 30 seconds. ### Audio formats (content types) Use the `Content-Type` header to specify the audio - format (MIME type) of the audio. The service accepts the following formats: * `audio/basic` (Use only with - narrowband models.) * `audio/flac` * `audio/l16` (Specify the sampling rate (`rate`) and optionally the number of - channels (`channels`) and endianness (`endianness`) of the audio.) * `audio/mp3` * `audio/mpeg` * `audio/mulaw` - (Specify the sampling rate (`rate`) of the audio.) * `audio/ogg` (The service automatically detects the codec of - the input audio.) * `audio/ogg;codecs=opus` * `audio/ogg;codecs=vorbis` * `audio/wav` (Provide audio with a maximum - of nine channels.) * `audio/webm` (The service automatically detects the codec of the input audio.) * - `audio/webm;codecs=opus` * `audio/webm;codecs=vorbis` For information about the supported audio formats, - including specifying the sampling rate, channels, and endianness for the indicated formats, see [Audio - formats](https://console.bluemix.net/docs/services/speech-to-text/audio-formats.html). ### Multipart speech - recognition The method also supports multipart recognition requests. With multipart requests, you pass all audio - data as multipart form data. You specify some parameters as request headers and query parameters, but you pass JSON - metadata as form data to control most aspects of the transcription. The multipart approach is intended for use - with browsers for which JavaScript is disabled or when the parameters used with the request are greater than the 8 - KB limit imposed by most HTTP servers and proxies. You can encounter this limit, for example, if you want to spot a - very large number of keywords. For information about submitting a multipart request, see [Submitting multipart - requests as form data](https://console.bluemix.net/docs/services/speech-to-text/http.html#HTTP-multi). + specify the endianness.) + ### Streaming mode + For requests to transcribe live audio as it becomes available, you must set the `Transfer-Encoding` header to + `chunked` to use streaming mode. In streaming mode, the server closes the connection (status code 408) if the + service receives no data chunk for 30 seconds and the service has no audio to transcribe for 30 seconds. The server + also closes the connection (status code 400) if no speech is detected for `inactivity_timeout` seconds of audio + (not processing time); use the `inactivity_timeout` parameter to change the default of 30 seconds. + ### Audio formats (content types) + Use the `Content-Type` header to specify the audio format (MIME type) of the audio. The service accepts the + following formats: + * `audio/basic` (Use only with narrowband models.) + * `audio/flac` + * `audio/l16` (Specify the sampling rate (`rate`) and optionally the number of channels (`channels`) and endianness + (`endianness`) of the audio.) + * `audio/mp3` + * `audio/mpeg` + * `audio/mulaw` (Specify the sampling rate (`rate`) of the audio.) + * `audio/ogg` (The service automatically detects the codec of the input audio.) + * `audio/ogg;codecs=opus` + * `audio/ogg;codecs=vorbis` + * `audio/wav` (Provide audio with a maximum of nine channels.) + * `audio/webm` (The service automatically detects the codec of the input audio.) + * `audio/webm;codecs=opus` + * `audio/webm;codecs=vorbis` + For information about the supported audio formats, including specifying the sampling rate, channels, and endianness + for the indicated formats, see [Audio + formats](https://console.bluemix.net/docs/services/speech-to-text/audio-formats.html). + ### Multipart speech recognition + The method also supports multipart recognition requests. With multipart requests, you pass all audio data as + multipart form data. You specify some parameters as request headers and query parameters, but you pass JSON + metadata as form data to control most aspects of the transcription. + The multipart approach is intended for use with browsers for which JavaScript is disabled or when the parameters + used with the request are greater than the 8 KB limit imposed by most HTTP servers and proxies. You can encounter + this limit, for example, if you want to spot a very large number of keywords. + For information about submitting a multipart request, see [Submitting multipart requests as form + data](https://console.bluemix.net/docs/services/speech-to-text/http.html#HTTP-multi). - parameter audio: The audio to transcribe in the format specified by the `Content-Type` header. - parameter contentType: The type of the input: audio/basic, audio/flac, audio/l16, audio/mp3, audio/mpeg, audio/mulaw, audio/ogg, - audio/ogg;codecs=opus, audio/ogg;codecs=vorbis, audio/wav, audio/webm, audio/webm;codecs=opus, or - audio/webm;codecs=vorbis. - - parameter model: The identifier of the model that is to be used for the recognition request or, for the **Create a session** method, - with the new session. - - parameter customizationID: The customization ID (GUID) of a custom language model that is to be used with the recognition request or, for the - **Create a session** method, with the new session. The base model of the specified custom language model must match - the model specified with the `model` parameter. You must make the request with service credentials created for the - instance of the service that owns the custom model. By default, no custom language model is used. - - parameter acousticCustomizationID: The customization ID (GUID) of a custom acoustic model that is to be used with the recognition request or, for the - **Create a session** method, with the new session. The base model of the specified custom acoustic model must match - the model specified with the `model` parameter. You must make the request with service credentials created for the - instance of the service that owns the custom model. By default, no custom acoustic model is used. + audio/ogg;codecs=opus, audio/ogg;codecs=vorbis, audio/wav, audio/webm, audio/webm;codecs=opus, or + audio/webm;codecs=vorbis. + - parameter model: The identifier of the model that is to be used for the recognition request or, for the **Create a session** + method, with the new session. + - parameter customizationID: The customization ID (GUID) of a custom language model that is to be used with the recognition request or, for + the **Create a session** method, with the new session. The base model of the specified custom language model must + match the model specified with the `model` parameter. You must make the request with service credentials created + for the instance of the service that owns the custom model. By default, no custom language model is used. + - parameter acousticCustomizationID: The customization ID (GUID) of a custom acoustic model that is to be used with the recognition request or, for + the **Create a session** method, with the new session. The base model of the specified custom acoustic model must + match the model specified with the `model` parameter. You must make the request with service credentials created + for the instance of the service that owns the custom model. By default, no custom acoustic model is used. - parameter baseModelVersion: The version of the specified base model that is to be used with recognition request or, for the **Create a - session** method, with the new session. Multiple versions of a base model can exist when a model is updated for - internal improvements. The parameter is intended primarily for use with custom models that have been upgraded for a - new base model. The default value depends on whether the parameter is used with or without a custom model. For more - information, see [Base model version](https://console.bluemix.net/docs/services/speech-to-text/input.html#version). + session** method, with the new session. Multiple versions of a base model can exist when a model is updated for + internal improvements. The parameter is intended primarily for use with custom models that have been upgraded for + a new base model. The default value depends on whether the parameter is used with or without a custom model. For + more information, see [Base model + version](https://console.bluemix.net/docs/services/speech-to-text/input.html#version). - parameter customizationWeight: If you specify the customization ID (GUID) of a custom language model with the recognition request or, for - sessions, with the **Create a session** method, the customization weight tells the service how much weight to give - to words from the custom language model compared to those from the base model for the current request. Specify a - value between 0.0 and 1.0. Unless a different customization weight was specified for the custom model when it was - trained, the default value is 0.3. A customization weight that you specify overrides a weight that was specified - when the custom model was trained. The default value yields the best performance in general. Assign a higher - value if your audio makes frequent use of OOV words from the custom model. Use caution when setting the weight: a - higher value can improve the accuracy of phrases from the custom model's domain, but it can negatively affect - performance on non-domain phrases. + sessions, with the **Create a session** method, the customization weight tells the service how much weight to + give to words from the custom language model compared to those from the base model for the current request. + Specify a value between 0.0 and 1.0. Unless a different customization weight was specified for the custom model + when it was trained, the default value is 0.3. A customization weight that you specify overrides a weight that + was specified when the custom model was trained. + The default value yields the best performance in general. Assign a higher value if your audio makes frequent use + of OOV words from the custom model. Use caution when setting the weight: a higher value can improve the accuracy + of phrases from the custom model's domain, but it can negatively affect performance on non-domain phrases. - parameter inactivityTimeout: The time in seconds after which, if only silence (no speech) is detected in submitted audio, the connection is - closed with a 400 error. Useful for stopping audio submission from a live microphone when a user simply walks away. - Use `-1` for infinity. - - parameter keywords: An array of keyword strings to spot in the audio. Each keyword string can include one or more tokens. Keywords are - spotted only in the final hypothesis, not in interim results. If you specify any keywords, you must also specify a - keywords threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify an empty array if you do - not need to spot keywords. + closed with a 400 error. The parameter is useful for stopping audio submission from a live microphone when a user + simply walks away. Use `-1` for infinity. + - parameter keywords: An array of keyword strings to spot in the audio. Each keyword string can include one or more tokens. Keywords + are spotted only in the final results, not in interim hypotheses. If you specify any keywords, you must also + specify a keywords threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify an empty + array if you do not need to spot keywords. - parameter keywordsThreshold: A confidence value that is the lower bound for spotting a keyword. A word is considered to match a keyword if its - confidence is greater than or equal to the threshold. Specify a probability between 0 and 1 inclusive. No keyword - spotting is performed if you omit the parameter. If you specify a threshold, you must also specify one or more - keywords. + confidence is greater than or equal to the threshold. Specify a probability between 0 and 1 inclusive. No keyword + spotting is performed if you omit the parameter. If you specify a threshold, you must also specify one or more + keywords. - parameter maxAlternatives: The maximum number of alternative transcripts to be returned. By default, a single transcription is returned. - - parameter wordAlternativesThreshold: A confidence value that is the lower bound for identifying a hypothesis as a possible word alternative (also known - as \"Confusion Networks\"). An alternative word is considered if its confidence is greater than or equal to the - threshold. Specify a probability between 0 and 1 inclusive. No alternative words are computed if you omit the - parameter. + - parameter wordAlternativesThreshold: A confidence value that is the lower bound for identifying a hypothesis as a possible word alternative (also + known as \"Confusion Networks\"). An alternative word is considered if its confidence is greater than or equal to + the threshold. Specify a probability between 0 and 1 inclusive. No alternative words are computed if you omit the + parameter. - parameter wordConfidence: If `true`, a confidence measure in the range of 0 to 1 is returned for each word. By default, no word confidence - measures are returned. + measures are returned. - parameter timestamps: If `true`, time alignment is returned for each word. By default, no timestamps are returned. - parameter profanityFilter: If `true` (the default), filters profanity from all output except for keyword results by replacing inappropriate - words with a series of asterisks. Set the parameter to `false` to return results with no censoring. Applies to US - English transcription only. + words with a series of asterisks. Set the parameter to `false` to return results with no censoring. Applies to US + English transcription only. - parameter smartFormatting: If `true`, converts dates, times, series of digits and numbers, phone numbers, currency values, and internet - addresses into more readable, conventional representations in the final transcript of a recognition request. For US - English, also converts certain keyword strings to punctuation symbols. By default, no smart formatting is - performed. Applies to US English and Spanish transcription only. + addresses into more readable, conventional representations in the final transcript of a recognition request. For + US English, also converts certain keyword strings to punctuation symbols. By default, no smart formatting is + performed. Applies to US English and Spanish transcription only. - parameter speakerLabels: If `true`, the response includes labels that identify which words were spoken by which participants in a - multi-person exchange. By default, no speaker labels are returned. Setting `speaker_labels` to `true` forces the - `timestamps` parameter to be `true`, regardless of whether you specify `false` for the parameter. To determine - whether a language model supports speaker labels, use the **Get models** method and check that the attribute - `speaker_labels` is set to `true`. You can also refer to [Speaker - labels](https://console.bluemix.net/docs/services/speech-to-text/output.html#speaker_labels). + multi-person exchange. By default, no speaker labels are returned. Setting `speaker_labels` to `true` forces the + `timestamps` parameter to be `true`, regardless of whether you specify `false` for the parameter. + To determine whether a language model supports speaker labels, use the **Get models** method and check that the + attribute `speaker_labels` is set to `true`. You can also refer to [Speaker + labels](https://console.bluemix.net/docs/services/speech-to-text/output.html#speaker_labels). - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -455,26 +470,28 @@ public class SpeechToText { To be registered successfully, the callback URL must respond to the `GET` request from the service. The response must send status code 200 and must include the challenge string in its body. Set the `Content-Type` response header to `text/plain`. Upon receiving this response, the service responds to the original registration request with - response code 201. The service sends only a single `GET` request to the callback URL. If the service does not - receive a reply with a response code of 200 and a body that echoes the challenge string sent by the service within - five seconds, it does not white-list the URL; it instead sends status code 400 in response to the **Register a - callback** request. If the requested callback URL is already white-listed, the service responds to the initial - registration request with response code 200. If you specify a user secret with the request, the service uses it - as a key to calculate an HMAC-SHA1 signature of the challenge string in its response to the `POST` request. It - sends this signature in the `X-Callback-Signature` header of its `GET` request to the URL during registration. It - also uses the secret to calculate a signature over the payload of every callback notification that uses the URL. - The signature provides authentication and data integrity for HTTP communications. After you successfully register - a callback URL, you can use it with an indefinite number of recognition requests. You can register a maximum of 20 - callback URLS in a one-hour span of time. For more information, see [Registering a callback - URL](https://console.bluemix.net/docs/services/speech-to-text/async.html#register). - - - parameter callbackUrl: An HTTP or HTTPS URL to which callback notifications are to be sent. To be white-listed, the URL must successfully - echo the challenge string during URL verification. During verification, the client can also check the signature - that the service sends in the `X-Callback-Signature` header to verify the origin of the request. + response code 201. + The service sends only a single `GET` request to the callback URL. If the service does not receive a reply with a + response code of 200 and a body that echoes the challenge string sent by the service within five seconds, it does + not white-list the URL; it instead sends status code 400 in response to the **Register a callback** request. If the + requested callback URL is already white-listed, the service responds to the initial registration request with + response code 200. + If you specify a user secret with the request, the service uses it as a key to calculate an HMAC-SHA1 signature of + the challenge string in its response to the `POST` request. It sends this signature in the `X-Callback-Signature` + header of its `GET` request to the URL during registration. It also uses the secret to calculate a signature over + the payload of every callback notification that uses the URL. The signature provides authentication and data + integrity for HTTP communications. + After you successfully register a callback URL, you can use it with an indefinite number of recognition requests. + You can register a maximum of 20 callback URLS in a one-hour span of time. For more information, see [Registering a + callback URL](https://console.bluemix.net/docs/services/speech-to-text/async.html#register). + + - parameter callbackUrl: An HTTP or HTTPS URL to which callback notifications are to be sent. To be white-listed, the URL must + successfully echo the challenge string during URL verification. During verification, the client can also check + the signature that the service sends in the `X-Callback-Signature` header to verify the origin of the request. - parameter userSecret: A user-specified string that the service uses to generate the HMAC-SHA1 signature that it sends via the - `X-Callback-Signature` header. The service includes the header during URL verification and with every notification - sent to the callback URL. It calculates the signature over the payload of the notification. If you omit the - parameter, the service does not send the header. + `X-Callback-Signature` header. The service includes the header during URL verification and with every + notification sent to the callback URL. It calculates the signature over the payload of the notification. If you + omit the parameter, the service does not send the header. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -572,113 +589,135 @@ public class SpeechToText { Creates a job for a new asynchronous recognition request. The job is owned by the user whose service credentials are used to create it. How you learn the status and results of a job depends on the parameters you include with the - job creation request: * By callback notification: Include the `callback_url` parameter to specify a URL to which - the service is to send callback notifications when the status of the job changes. Optionally, you can also include - the `events` and `user_token` parameters to subscribe to specific events and to specify a string that is to be - included with each notification for the job. * By polling the service: Omit the `callback_url`, `events`, and - `user_token` parameters. You must then use the **Check jobs** or **Check a job** methods to check the status of the - job, using the latter to retrieve the results when the job is complete. The two approaches are not mutually - exclusive. You can poll the service for job status or obtain results from the service manually even if you include - a callback URL. In both cases, you can include the `results_ttl` parameter to specify how long the results are to - remain available after the job is complete. For detailed usage information about the two approaches, including - callback notifications, see [Creating a + job creation request: + * By callback notification: Include the `callback_url` parameter to specify a URL to which the service is to send + callback notifications when the status of the job changes. Optionally, you can also include the `events` and + `user_token` parameters to subscribe to specific events and to specify a string that is to be included with each + notification for the job. + * By polling the service: Omit the `callback_url`, `events`, and `user_token` parameters. You must then use the + **Check jobs** or **Check a job** methods to check the status of the job, using the latter to retrieve the results + when the job is complete. + The two approaches are not mutually exclusive. You can poll the service for job status or obtain results from the + service manually even if you include a callback URL. In both cases, you can include the `results_ttl` parameter to + specify how long the results are to remain available after the job is complete. For detailed usage information + about the two approaches, including callback notifications, see [Creating a job](https://console.bluemix.net/docs/services/speech-to-text/async.html#create). Using the HTTPS **Check a job** method to retrieve results is more secure than receiving them via callback notification over HTTP because it - provides confidentiality in addition to authentication and data integrity. The method supports the same basic - parameters as other HTTP and WebSocket recognition requests. The service imposes a data size limit of 100 MB. It - automatically detects the endianness of the incoming audio and, for audio that includes multiple channels, - downmixes the audio to one-channel mono during transcoding. (For the `audio/l16` format, you can specify the - endianness.) ### Audio formats (content types) Use the `Content-Type` parameter to specify the audio format - (MIME type) of the audio: * `audio/basic` (Use only with narrowband models.) * `audio/flac` * `audio/l16` (Specify - the sampling rate (`rate`) and optionally the number of channels (`channels`) and endianness (`endianness`) of the - audio.) * `audio/mp3` * `audio/mpeg` * `audio/mulaw` (Specify the sampling rate (`rate`) of the audio.) * - `audio/ogg` (The service automatically detects the codec of the input audio.) * `audio/ogg;codecs=opus` * - `audio/ogg;codecs=vorbis` * `audio/wav` (Provide audio with a maximum of nine channels.) * `audio/webm` (The - service automatically detects the codec of the input audio.) * `audio/webm;codecs=opus` * - `audio/webm;codecs=vorbis` For information about the supported audio formats, including specifying the sampling - rate, channels, and endianness for the indicated formats, see [Audio + provides confidentiality in addition to authentication and data integrity. + The method supports the same basic parameters as other HTTP and WebSocket recognition requests. It also supports + the following parameters specific to the asynchronous interface: + * `callback_url` + * `events` + * `user_token` + * `results_ttl` + The service imposes a data size limit of 100 MB. It automatically detects the endianness of the incoming audio and, + for audio that includes multiple channels, downmixes the audio to one-channel mono during transcoding. (For the + `audio/l16` format, you can specify the endianness.) + ### Audio formats (content types) + Use the `Content-Type` parameter to specify the audio format (MIME type) of the audio: + * `audio/basic` (Use only with narrowband models.) + * `audio/flac` + * `audio/l16` (Specify the sampling rate (`rate`) and optionally the number of channels (`channels`) and endianness + (`endianness`) of the audio.) + * `audio/mp3` + * `audio/mpeg` + * `audio/mulaw` (Specify the sampling rate (`rate`) of the audio.) + * `audio/ogg` (The service automatically detects the codec of the input audio.) + * `audio/ogg;codecs=opus` + * `audio/ogg;codecs=vorbis` + * `audio/wav` (Provide audio with a maximum of nine channels.) + * `audio/webm` (The service automatically detects the codec of the input audio.) + * `audio/webm;codecs=opus` + * `audio/webm;codecs=vorbis` + For information about the supported audio formats, including specifying the sampling rate, channels, and endianness + for the indicated formats, see [Audio formats](https://console.bluemix.net/docs/services/speech-to-text/audio-formats.html). - parameter audio: The audio to transcribe in the format specified by the `Content-Type` header. - parameter contentType: The type of the input: audio/basic, audio/flac, audio/l16, audio/mp3, audio/mpeg, audio/mulaw, audio/ogg, - audio/ogg;codecs=opus, audio/ogg;codecs=vorbis, audio/wav, audio/webm, audio/webm;codecs=opus, or - audio/webm;codecs=vorbis. - - parameter model: The identifier of the model that is to be used for the recognition request or, for the **Create a session** method, - with the new session. + audio/ogg;codecs=opus, audio/ogg;codecs=vorbis, audio/wav, audio/webm, audio/webm;codecs=opus, or + audio/webm;codecs=vorbis. + - parameter model: The identifier of the model that is to be used for the recognition request or, for the **Create a session** + method, with the new session. - parameter callbackUrl: A URL to which callback notifications are to be sent. The URL must already be successfully white-listed by using - the **Register a callback** method. Omit the parameter to poll the service for job completion and results. You can - include the same callback URL with any number of job creation requests. Use the `user_token` parameter to specify a - unique user-specified string with each job to differentiate the callback notifications for the jobs. + the **Register a callback** method. You can include the same callback URL with any number of job creation + requests. Omit the parameter to poll the service for job completion and results. + Use the `user_token` parameter to specify a unique user-specified string with each job to differentiate the + callback notifications for the jobs. - parameter events: If the job includes a callback URL, a comma-separated list of notification events to which to subscribe. Valid - events are: `recognitions.started` generates a callback notification when the service begins to process the job. - `recognitions.completed` generates a callback notification when the job is complete; you must use the **Check a - job** method to retrieve the results before they time out or are deleted. `recognitions.completed_with_results` - generates a callback notification when the job is complete; the notification includes the results of the request. - `recognitions.failed` generates a callback notification if the service experiences an error while processing the - job. Omit the parameter to subscribe to the default events: `recognitions.started`, `recognitions.completed`, and - `recognitions.failed`. The `recognitions.completed` and `recognitions.completed_with_results` events are - incompatible; you can specify only of the two events. If the job does not include a callback URL, omit the - parameter. + events are + * `recognitions.started` generates a callback notification when the service begins to process the job. + * `recognitions.completed` generates a callback notification when the job is complete. You must use the **Check a + job** method to retrieve the results before they time out or are deleted. + * `recognitions.completed_with_results` generates a callback notification when the job is complete. The + notification includes the results of the request. + * `recognitions.failed` generates a callback notification if the service experiences an error while processing + the job. + Omit the parameter to subscribe to the default events: `recognitions.started`, `recognitions.completed`, and + `recognitions.failed`. The `recognitions.completed` and `recognitions.completed_with_results` events are + incompatible; you can specify only of the two events. If the job does not include a callback URL, omit the + parameter. - parameter userToken: If the job includes a callback URL, a user-specified string that the service is to include with each callback - notification for the job; the token allows the user to maintain an internal mapping between jobs and notification - events. If the job does not include a callback URL, omit the parameter. - - parameter resultsTtl: The number of minutes for which the results are to be available after the job has finished. If not delivered via a - callback, the results must be retrieved within this time. Omit the parameter to use a time to live of one week. The - parameter is valid with or without a callback URL. - - parameter customizationID: The customization ID (GUID) of a custom language model that is to be used with the recognition request or, for the - **Create a session** method, with the new session. The base model of the specified custom language model must match - the model specified with the `model` parameter. You must make the request with service credentials created for the - instance of the service that owns the custom model. By default, no custom language model is used. - - parameter acousticCustomizationID: The customization ID (GUID) of a custom acoustic model that is to be used with the recognition request or, for the - **Create a session** method, with the new session. The base model of the specified custom acoustic model must match - the model specified with the `model` parameter. You must make the request with service credentials created for the - instance of the service that owns the custom model. By default, no custom acoustic model is used. + notification for the job; the token allows the user to maintain an internal mapping between jobs and notification + events. If the job does not include a callback URL, omit the parameter. + - parameter resultsTtl: The number of minutes for which the results are to be available after the job has finished. If not delivered via + a callback, the results must be retrieved within this time. Omit the parameter to use a time to live of one week. + The parameter is valid with or without a callback URL. + - parameter customizationID: The customization ID (GUID) of a custom language model that is to be used with the recognition request or, for + the **Create a session** method, with the new session. The base model of the specified custom language model must + match the model specified with the `model` parameter. You must make the request with service credentials created + for the instance of the service that owns the custom model. By default, no custom language model is used. + - parameter acousticCustomizationID: The customization ID (GUID) of a custom acoustic model that is to be used with the recognition request or, for + the **Create a session** method, with the new session. The base model of the specified custom acoustic model must + match the model specified with the `model` parameter. You must make the request with service credentials created + for the instance of the service that owns the custom model. By default, no custom acoustic model is used. - parameter baseModelVersion: The version of the specified base model that is to be used with recognition request or, for the **Create a - session** method, with the new session. Multiple versions of a base model can exist when a model is updated for - internal improvements. The parameter is intended primarily for use with custom models that have been upgraded for a - new base model. The default value depends on whether the parameter is used with or without a custom model. For more - information, see [Base model version](https://console.bluemix.net/docs/services/speech-to-text/input.html#version). + session** method, with the new session. Multiple versions of a base model can exist when a model is updated for + internal improvements. The parameter is intended primarily for use with custom models that have been upgraded for + a new base model. The default value depends on whether the parameter is used with or without a custom model. For + more information, see [Base model + version](https://console.bluemix.net/docs/services/speech-to-text/input.html#version). - parameter customizationWeight: If you specify the customization ID (GUID) of a custom language model with the recognition request or, for - sessions, with the **Create a session** method, the customization weight tells the service how much weight to give - to words from the custom language model compared to those from the base model for the current request. Specify a - value between 0.0 and 1.0. Unless a different customization weight was specified for the custom model when it was - trained, the default value is 0.3. A customization weight that you specify overrides a weight that was specified - when the custom model was trained. The default value yields the best performance in general. Assign a higher - value if your audio makes frequent use of OOV words from the custom model. Use caution when setting the weight: a - higher value can improve the accuracy of phrases from the custom model's domain, but it can negatively affect - performance on non-domain phrases. + sessions, with the **Create a session** method, the customization weight tells the service how much weight to + give to words from the custom language model compared to those from the base model for the current request. + Specify a value between 0.0 and 1.0. Unless a different customization weight was specified for the custom model + when it was trained, the default value is 0.3. A customization weight that you specify overrides a weight that + was specified when the custom model was trained. + The default value yields the best performance in general. Assign a higher value if your audio makes frequent use + of OOV words from the custom model. Use caution when setting the weight: a higher value can improve the accuracy + of phrases from the custom model's domain, but it can negatively affect performance on non-domain phrases. - parameter inactivityTimeout: The time in seconds after which, if only silence (no speech) is detected in submitted audio, the connection is - closed with a 400 error. Useful for stopping audio submission from a live microphone when a user simply walks away. - Use `-1` for infinity. - - parameter keywords: An array of keyword strings to spot in the audio. Each keyword string can include one or more tokens. Keywords are - spotted only in the final hypothesis, not in interim results. If you specify any keywords, you must also specify a - keywords threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify an empty array if you do - not need to spot keywords. + closed with a 400 error. The parameter is useful for stopping audio submission from a live microphone when a user + simply walks away. Use `-1` for infinity. + - parameter keywords: An array of keyword strings to spot in the audio. Each keyword string can include one or more tokens. Keywords + are spotted only in the final results, not in interim hypotheses. If you specify any keywords, you must also + specify a keywords threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify an empty + array if you do not need to spot keywords. - parameter keywordsThreshold: A confidence value that is the lower bound for spotting a keyword. A word is considered to match a keyword if its - confidence is greater than or equal to the threshold. Specify a probability between 0 and 1 inclusive. No keyword - spotting is performed if you omit the parameter. If you specify a threshold, you must also specify one or more - keywords. + confidence is greater than or equal to the threshold. Specify a probability between 0 and 1 inclusive. No keyword + spotting is performed if you omit the parameter. If you specify a threshold, you must also specify one or more + keywords. - parameter maxAlternatives: The maximum number of alternative transcripts to be returned. By default, a single transcription is returned. - - parameter wordAlternativesThreshold: A confidence value that is the lower bound for identifying a hypothesis as a possible word alternative (also known - as \"Confusion Networks\"). An alternative word is considered if its confidence is greater than or equal to the - threshold. Specify a probability between 0 and 1 inclusive. No alternative words are computed if you omit the - parameter. + - parameter wordAlternativesThreshold: A confidence value that is the lower bound for identifying a hypothesis as a possible word alternative (also + known as \"Confusion Networks\"). An alternative word is considered if its confidence is greater than or equal to + the threshold. Specify a probability between 0 and 1 inclusive. No alternative words are computed if you omit the + parameter. - parameter wordConfidence: If `true`, a confidence measure in the range of 0 to 1 is returned for each word. By default, no word confidence - measures are returned. + measures are returned. - parameter timestamps: If `true`, time alignment is returned for each word. By default, no timestamps are returned. - parameter profanityFilter: If `true` (the default), filters profanity from all output except for keyword results by replacing inappropriate - words with a series of asterisks. Set the parameter to `false` to return results with no censoring. Applies to US - English transcription only. + words with a series of asterisks. Set the parameter to `false` to return results with no censoring. Applies to US + English transcription only. - parameter smartFormatting: If `true`, converts dates, times, series of digits and numbers, phone numbers, currency values, and internet - addresses into more readable, conventional representations in the final transcript of a recognition request. For US - English, also converts certain keyword strings to punctuation symbols. By default, no smart formatting is - performed. Applies to US English and Spanish transcription only. + addresses into more readable, conventional representations in the final transcript of a recognition request. For + US English, also converts certain keyword strings to punctuation symbols. By default, no smart formatting is + performed. Applies to US English and Spanish transcription only. - parameter speakerLabels: If `true`, the response includes labels that identify which words were spoken by which participants in a - multi-person exchange. By default, no speaker labels are returned. Setting `speaker_labels` to `true` forces the - `timestamps` parameter to be `true`, regardless of whether you specify `false` for the parameter. To determine - whether a language model supports speaker labels, use the **Get models** method and check that the attribute - `speaker_labels` is set to `true`. You can also refer to [Speaker - labels](https://console.bluemix.net/docs/services/speech-to-text/output.html#speaker_labels). + multi-person exchange. By default, no speaker labels are returned. Setting `speaker_labels` to `true` forces the + `timestamps` parameter to be `true`, regardless of whether you specify `false` for the parameter. + To determine whether a language model supports speaker labels, use the **Get models** method and check that the + attribute `speaker_labels` is set to `true`. You can also refer to [Speaker + labels](https://console.bluemix.net/docs/services/speech-to-text/output.html#speaker_labels). - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -868,11 +907,11 @@ public class SpeechToText { Returns information about the specified job. The response always includes the status of the job and its creation and update times. If the status is `completed`, the response includes the results of the recognition request. You - must submit the request with the service credentials of the user who created the job. You can use the method to - retrieve the results of any job, regardless of whether it was submitted with a callback URL and the - `recognitions.completed_with_results` event, and you can retrieve the results multiple times for as long as they - remain available. Use the **Check jobs** method to request information about the most recent jobs associated with - the calling user. + must submit the request with the service credentials of the user who created the job. + You can use the method to retrieve the results of any job, regardless of whether it was submitted with a callback + URL and the `recognitions.completed_with_results` event, and you can retrieve the results multiple times for as + long as they remain available. Use the **Check jobs** method to request information about the most recent jobs + associated with the calling user. - parameter id: The ID of the asynchronous job. - parameter headers: A dictionary of request headers to be sent with this request. @@ -968,7 +1007,7 @@ public class SpeechToText { Creates a new custom language model for a specified base model. The custom language model can be used only with the base model for which it is created. The model is owned by the instance of the service whose credentials are used to - create it. You must pass a value of `application/json` with the `Content-Type` header. + create it. - parameter createLanguageModel: A `CreateLanguageModel` object that provides basic information about the new custom language model. - parameter headers: A dictionary of request headers to be sent with this request. @@ -1018,13 +1057,13 @@ public class SpeechToText { List custom language models. Lists information about all custom language models that are owned by an instance of the service. Use the `language` - parameter to see all custom language models for the specified language; omit the parameter to see all custom + parameter to see all custom language models for the specified language. Omit the parameter to see all custom language models for all languages. You must use credentials for the instance of the service that owns a model to list information about it. - - parameter language: The identifier of the language for which custom language or custom acoustic models are to be returned (for example, - `en-US`). Omit the parameter to see all custom language or custom acoustic models owned by the requesting service - credentials. + - parameter language: The identifier of the language for which custom language or custom acoustic models are to be returned (for + example, `en-US`). Omit the parameter to see all custom language or custom acoustic models owned by the + requesting service credentials. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1069,13 +1108,13 @@ public class SpeechToText { } /** - List a custom language model. + Get a custom language model. - Lists information about a specified custom language model. You must use credentials for the instance of the service + Gets information about a specified custom language model. You must use credentials for the instance of the service that owns a model to list information about it. - parameter customizationID: The customization ID (GUID) of the custom language model. You must make the request with service credentials - created for the instance of the service that owns the custom model. + created for the instance of the service that owns the custom model. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1124,7 +1163,7 @@ public class SpeechToText { owns a model to delete it. - parameter customizationID: The customization ID (GUID) of the custom language model. You must make the request with service credentials - created for the instance of the service that owns the custom model. + created for the instance of the service that owns the custom model. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1172,32 +1211,36 @@ public class SpeechToText { or deleting corpora or words for a custom language model, use this method to begin the actual training of the model on the latest data. You can specify whether the custom language model is to be trained with all words from its words resource or only with words that were added or modified by the user. You must use credentials for the - instance of the service that owns a model to train it. The training method is asynchronous. It can take on the - order of minutes to complete depending on the amount of data on which the service is being trained and the current - load on the service. The method returns an HTTP 200 response code to indicate that the training process has begun. - You can monitor the status of the training by using the **List a custom language model** method to poll the - model's status. Use a loop to check the status every 10 seconds. The method returns a `Customization` object that - includes `status` and `progress` fields. A status of `available` means that the custom model is trained and ready - to use. The service cannot accept subsequent training requests, or requests to add new corpora or words, until the - existing request completes. Training can fail to start for the following reasons: * The service is currently - handling another request for the custom model, such as another training request or a request to add a corpus or - words to the model. * No training data (corpora or words) have been added to the custom model. * One or more words - that were added to the custom model have invalid sounds-like pronunciations that you must fix. + instance of the service that owns a model to train it. + The training method is asynchronous. It can take on the order of minutes to complete depending on the amount of + data on which the service is being trained and the current load on the service. The method returns an HTTP 200 + response code to indicate that the training process has begun. + You can monitor the status of the training by using the **Get a custom language model** method to poll the model's + status. Use a loop to check the status every 10 seconds. The method returns a `LanguageModel` object that includes + `status` and `progress` fields. A status of `available` means that the custom model is trained and ready to use. + The service cannot accept subsequent training requests, or requests to add new corpora or words, until the existing + request completes. + Training can fail to start for the following reasons: + * The service is currently handling another request for the custom model, such as another training request or a + request to add a corpus or words to the model. + * No training data (corpora or words) have been added to the custom model. + * One or more words that were added to the custom model have invalid sounds-like pronunciations that you must fix. - parameter customizationID: The customization ID (GUID) of the custom language model. You must make the request with service credentials - created for the instance of the service that owns the custom model. - - parameter wordTypeToAdd: The type of words from the custom language model's words resource on which to train the model: * `all` (the - default) trains the model on all new words, regardless of whether they were extracted from corpora or were added or - modified by the user. * `user` trains the model only on new words that were added or modified by the user; the - model is not trained on new words extracted from corpora. - - parameter customizationWeight: Specifies a customization weight for the custom language model. The customization weight tells the service how much - weight to give to words from the custom language model compared to those from the base model for speech - recognition. Specify a value between 0.0 and 1.0; the default is 0.3. The default value yields the best - performance in general. Assign a higher value if your audio makes frequent use of OOV words from the custom model. - Use caution when setting the weight: a higher value can improve the accuracy of phrases from the custom model's - domain, but it can negatively affect performance on non-domain phrases. The value that you assign is used for all - recognition requests that use the model. You can override it for any recognition request by specifying a - customization weight for that request. + created for the instance of the service that owns the custom model. + - parameter wordTypeToAdd: The type of words from the custom language model's words resource on which to train the model: + * `all` (the default) trains the model on all new words, regardless of whether they were extracted from corpora + or were added or modified by the user. + * `user` trains the model only on new words that were added or modified by the user; the model is not trained on + new words extracted from corpora. + - parameter customizationWeight: Specifies a customization weight for the custom language model. The customization weight tells the service how + much weight to give to words from the custom language model compared to those from the base model for speech + recognition. Specify a value between 0.0 and 1.0; the default is 0.3. + The default value yields the best performance in general. Assign a higher value if your audio makes frequent use + of OOV words from the custom model. Use caution when setting the weight: a higher value can improve the accuracy + of phrases from the custom model's domain, but it can negatively affect performance on non-domain phrases. + The value that you assign is used for all recognition requests that use the model. You can override it for any + recognition request by specifying a customization weight for that request. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1261,7 +1304,7 @@ public class SpeechToText { instance of the service that owns a model to reset it. - parameter customizationID: The customization ID (GUID) of the custom language model. You must make the request with service credentials - created for the instance of the service that owns the custom model. + created for the instance of the service that owns the custom model. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1308,16 +1351,18 @@ public class SpeechToText { Initiates the upgrade of a custom language model to the latest version of its base language model. The upgrade method is asynchronous. It can take on the order of minutes to complete depending on the amount of data in the custom model and the current load on the service. A custom model must be in the `ready` or `available` state to be - upgraded. You must use credentials for the instance of the service that owns a model to upgrade it. The method - returns an HTTP 200 response code to indicate that the upgrade process has begun successfully. You can monitor the - status of the upgrade by using the **List a custom language model** method to poll the model's status. Use a loop - to check the status every 10 seconds. While it is being upgraded, the custom model has the status `upgrading`. When - the upgrade is complete, the model resumes the status that it had prior to upgrade. The service cannot accept - subsequent requests for the model until the upgrade completes. For more information, see [Upgrading custom + upgraded. You must use credentials for the instance of the service that owns a model to upgrade it. + The method returns an HTTP 200 response code to indicate that the upgrade process has begun successfully. You can + monitor the status of the upgrade by using the **Get a custom language model** method to poll the model's status. + The method returns a `LanguageModel` object that includes `status` and `progress` fields. Use a loop to check the + status every 10 seconds. While it is being upgraded, the custom model has the status `upgrading`. When the upgrade + is complete, the model resumes the status that it had prior to upgrade. The service cannot accept subsequent + requests for the model until the upgrade completes. + For more information, see [Upgrading custom models](https://console.bluemix.net/docs/services/speech-to-text/custom-upgrade.html). - parameter customizationID: The customization ID (GUID) of the custom language model. You must make the request with service credentials - created for the instance of the service that owns the custom model. + created for the instance of the service that owns the custom model. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1366,7 +1411,7 @@ public class SpeechToText { of the service that owns a model to list its corpora. - parameter customizationID: The customization ID (GUID) of the custom language model. You must make the request with service credentials - created for the instance of the service that owns the custom model. + created for the instance of the service that owns the custom model. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1413,40 +1458,41 @@ public class SpeechToText { Adds a single corpus text file of new training data to a custom language model. Use multiple requests to submit multiple corpus text files. You must use credentials for the instance of the service that owns a model to add a corpus to it. Adding a corpus does not affect the custom language model until you train the model for the new data - by using the **Train a custom language model** method. Submit a plain text file that contains sample sentences - from the domain of interest to enable the service to extract words in context. The more sentences you add that - represent the context in which speakers use words from the domain, the better the service's recognition accuracy. - For guidelines about adding a corpus text file and for information about how the service parses a corpus file, see - [Preparing a corpus text - file](https://console.bluemix.net/docs/services/speech-to-text/language-resource.html#prepareCorpus). The call - returns an HTTP 201 response code if the corpus is valid. The service then asynchronously processes the contents of - the corpus and automatically extracts new words that it finds. This can take on the order of a minute or two to - complete depending on the total number of words and the number of new words in the corpus, as well as the current - load on the service. You cannot submit requests to add additional corpora or words to the custom model, or to train - the model, until the service's analysis of the corpus for the current request completes. Use the **List a corpus** - method to check the status of the analysis. The service auto-populates the model's words resource with any word - that is not found in its base vocabulary; these are referred to as out-of-vocabulary (OOV) words. You can use the - **List custom words** method to examine the words resource, using other words method to eliminate typos and modify - how words are pronounced as needed. To add a corpus file that has the same name as an existing corpus, set the - `allow_overwrite` parameter to `true`; otherwise, the request fails. Overwriting an existing corpus causes the - service to process the corpus text file and extract OOV words anew. Before doing so, it removes any OOV words - associated with the existing corpus from the model's words resource unless they were also added by another corpus - or they have been modified in some way with the **Add custom words** or **Add a custom word** method. The service - limits the overall amount of data that you can add to a custom model to a maximum of 10 million total words from - all corpora combined. Also, you can add no more than 30 thousand custom (OOV) words to a model; this includes words - that the service extracts from corpora and words that you add directly. + by using the **Train a custom language model** method. + Submit a plain text file that contains sample sentences from the domain of interest to enable the service to + extract words in context. The more sentences you add that represent the context in which speakers use words from + the domain, the better the service's recognition accuracy. For guidelines about adding a corpus text file and for + information about how the service parses a corpus file, see [Preparing a corpus text + file](https://console.bluemix.net/docs/services/speech-to-text/language-resource.html#prepareCorpus). + The call returns an HTTP 201 response code if the corpus is valid. The service then asynchronously processes the + contents of the corpus and automatically extracts new words that it finds. This can take on the order of a minute + or two to complete depending on the total number of words and the number of new words in the corpus, as well as the + current load on the service. You cannot submit requests to add additional corpora or words to the custom model, or + to train the model, until the service's analysis of the corpus for the current request completes. Use the **List a + corpus** method to check the status of the analysis. + The service auto-populates the model's words resource with any word that is not found in its base vocabulary; these + are referred to as out-of-vocabulary (OOV) words. You can use the **List custom words** method to examine the words + resource, using other words method to eliminate typos and modify how words are pronounced as needed. + To add a corpus file that has the same name as an existing corpus, set the `allow_overwrite` parameter to `true`; + otherwise, the request fails. Overwriting an existing corpus causes the service to process the corpus text file and + extract OOV words anew. Before doing so, it removes any OOV words associated with the existing corpus from the + model's words resource unless they were also added by another corpus or they have been modified in some way with + the **Add custom words** or **Add a custom word** method. + The service limits the overall amount of data that you can add to a custom model to a maximum of 10 million total + words from all corpora combined. Also, you can add no more than 30 thousand custom (OOV) words to a model; this + includes words that the service extracts from corpora and words that you add directly. - parameter customizationID: The customization ID (GUID) of the custom language model. You must make the request with service credentials - created for the instance of the service that owns the custom model. - - parameter corpusName: The name of the corpus for the custom language model. When adding a corpus, do not include spaces in the name; use - a localized name that matches the language of the custom model; and do not use the name `user`, which is reserved - by the service to denote custom words added or modified by the user. - - parameter corpusFile: A plain text file that contains the training data for the corpus. Encode the file in UTF-8 if it contains non-ASCII - characters; the service assumes UTF-8 encoding if it encounters non-ASCII characters. With cURL, use the - `--data-binary` option to upload the file for the request. + created for the instance of the service that owns the custom model. + - parameter corpusName: The name of the corpus for the custom language model. When adding a corpus, do not include spaces in the name; + use a localized name that matches the language of the custom model; and do not use the name `user`, which is + reserved by the service to denote custom words added or modified by the user. + - parameter corpusFile: A plain text file that contains the training data for the corpus. Encode the file in UTF-8 if it contains + non-ASCII characters; the service assumes UTF-8 encoding if it encounters non-ASCII characters. With cURL, use + the `--data-binary` option to upload the file for the request. - parameter allowOverwrite: If `true`, the specified corpus or audio resource overwrites an existing corpus or audio resource with the same - name. If `false` (the default), the request fails if a corpus or audio resource with the same name already exists. - The parameter has no effect if a corpus or audio resource with the same name does not already exist. + name. If `false` (the default), the request fails if a corpus or audio resource with the same name already + exists. The parameter has no effect if a corpus or audio resource with the same name does not already exist. - parameter corpusFileContentType: The content type of corpusFile. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. @@ -1511,17 +1557,17 @@ public class SpeechToText { } /** - List a corpus. + Get a corpus. - Lists information about a corpus from a custom language model. The information includes the total number of words + Gets information about a corpus from a custom language model. The information includes the total number of words and out-of-vocabulary (OOV) words, name, and status of the corpus. You must use credentials for the instance of the service that owns a model to list its corpora. - parameter customizationID: The customization ID (GUID) of the custom language model. You must make the request with service credentials - created for the instance of the service that owns the custom model. - - parameter corpusName: The name of the corpus for the custom language model. When adding a corpus, do not include spaces in the name; use - a localized name that matches the language of the custom model; and do not use the name `user`, which is reserved - by the service to denote custom words added or modified by the user. + created for the instance of the service that owns the custom model. + - parameter corpusName: The name of the corpus for the custom language model. When adding a corpus, do not include spaces in the name; + use a localized name that matches the language of the custom model; and do not use the name `user`, which is + reserved by the service to denote custom words added or modified by the user. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1573,10 +1619,10 @@ public class SpeechToText { method. You must use credentials for the instance of the service that owns a model to delete its corpora. - parameter customizationID: The customization ID (GUID) of the custom language model. You must make the request with service credentials - created for the instance of the service that owns the custom model. - - parameter corpusName: The name of the corpus for the custom language model. When adding a corpus, do not include spaces in the name; use - a localized name that matches the language of the custom model; and do not use the name `user`, which is reserved - by the service to denote custom words added or modified by the user. + created for the instance of the service that owns the custom model. + - parameter corpusName: The name of the corpus for the custom language model. When adding a corpus, do not include spaces in the name; + use a localized name that matches the language of the custom model; and do not use the name `user`, which is + reserved by the service to denote custom words added or modified by the user. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1628,15 +1674,16 @@ public class SpeechToText { that owns a model to query information about its words. - parameter customizationID: The customization ID (GUID) of the custom language model. You must make the request with service credentials - created for the instance of the service that owns the custom model. - - parameter wordType: The type of words to be listed from the custom language model's words resource: * `all` (the default) shows all - words. * `user` shows only custom words that were added or modified by the user. * `corpora` shows only OOV that - were extracted from corpora. - - parameter sort: Indicates the order in which the words are to be listed, `alphabetical` or by `count`. You can prepend an optional - `+` or `-` to an argument to indicate whether the results are to be sorted in ascending or descending order. By - default, words are sorted in ascending alphabetical order. For alphabetical ordering, the lexicographical - precedence is numeric values, uppercase letters, and lowercase letters. For count ordering, values with the same - count are ordered alphabetically. With cURL, URL encode the `+` symbol as `%2B`. + created for the instance of the service that owns the custom model. + - parameter wordType: The type of words to be listed from the custom language model's words resource: + * `all` (the default) shows all words. + * `user` shows only custom words that were added or modified by the user. + * `corpora` shows only OOV that were extracted from corpora. + - parameter sort: Indicates the order in which the words are to be listed, `alphabetical` or by `count`. You can prepend an + optional `+` or `-` to an argument to indicate whether the results are to be sorted in ascending or descending + order. By default, words are sorted in ascending alphabetical order. For alphabetical ordering, the + lexicographical precedence is numeric values, uppercase letters, and lowercase letters. For count ordering, + values with the same count are ordered alphabetically. With cURL, URL encode the `+` symbol as `%2B`. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1698,41 +1745,42 @@ public class SpeechToText { model with out-of-vocabulary (OOV) words found in each corpus added to the model. You can use this method to add additional words or to modify existing words in the words resource. The words resource for a model can contain a maximum of 30 thousand custom (OOV) words, including words that the service extracts from corpora and words that - you add directly. You must use credentials for the instance of the service that owns a model to add or modify - custom words for the model. You must pass a value of `application/json` with the `Content-Type` header. Adding or - modifying custom words does not affect the custom model until you train the model for the new data by using the - **Train a custom language model** method. You add custom words by providing a `Words` object, which is an array - of `Word` objects, one per word. You must use the object's word parameter to identify the word that is to be added. - You can also provide one or both of the optional `sounds_like` and `display_as` fields for each word. * The - `sounds_like` field provides an array of one or more pronunciations for the word. Use the parameter to specify how - the word can be pronounced by users. Use the parameter for words that are difficult to pronounce, foreign words, - acronyms, and so on. For example, you might specify that the word `IEEE` can sound like `i triple e`. You can - specify a maximum of five sounds-like pronunciations for a word. For information about pronunciation rules, see - [Using the sounds_like - field](https://console.bluemix.net/docs/services/speech-to-text/language-resource.html#soundsLike). * The - `display_as` field provides a different way of spelling the word in a transcript. Use the parameter when you want - the word to appear different from its usual representation or from its spelling in corpora training data. For - example, you might indicate that the word `IBM(trademark)` is to be displayed as `IBM`. For more information, see - [Using the display_as - field](https://console.bluemix.net/docs/services/speech-to-text/language-resource.html#displayAs). If you add a - custom word that already exists in the words resource for the custom model, the new definition overwrites the - existing data for the word. If the service encounters an error with the input data, it returns a failure code and - does not add any of the words to the words resource. The call returns an HTTP 201 response code if the input data - is valid. It then asynchronously processes the words to add them to the model's words resource. The time that it - takes for the analysis to complete depends on the number of new words that you add but is generally faster than - adding a corpus or training a model. You can monitor the status of the request by using the **List a custom - language model** method to poll the model's status. Use a loop to check the status every 10 seconds. The method - returns a `Customization` object that includes a `status` field. A status of `ready` means that the words have been - added to the custom model. The service cannot accept requests to add new corpora or words or to train the model - until the existing request completes. You can use the **List custom words** or **List a custom word** method to - review the words that you add. Words with an invalid `sounds_like` field include an `error` field that describes - the problem. You can use other words-related methods to correct errors, eliminate typos, and modify how words are - pronounced as needed. + you add directly. + You must use credentials for the instance of the service that owns a model to add or modify custom words for the + model. Adding or modifying custom words does not affect the custom model until you train the model for the new data + by using the **Train a custom language model** method. + You add custom words by providing a `CustomWords` object, which is an array of `CustomWord` objects, one per word. + You must use the object's `word` parameter to identify the word that is to be added. You can also provide one or + both of the optional `sounds_like` and `display_as` fields for each word. + * The `sounds_like` field provides an array of one or more pronunciations for the word. Use the parameter to + specify how the word can be pronounced by users. Use the parameter for words that are difficult to pronounce, + foreign words, acronyms, and so on. For example, you might specify that the word `IEEE` can sound like `i triple + e`. You can specify a maximum of five sounds-like pronunciations for a word. For information about pronunciation + rules, see [Using the sounds_like + field](https://console.bluemix.net/docs/services/speech-to-text/language-resource.html#soundsLike). + * The `display_as` field provides a different way of spelling the word in a transcript. Use the parameter when you + want the word to appear different from its usual representation or from its spelling in corpora training data. For + example, you might indicate that the word `IBM(trademark)` is to be displayed as `IBM™`. For more + information, see [Using the display_as + field](https://console.bluemix.net/docs/services/speech-to-text/language-resource.html#displayAs). + If you add a custom word that already exists in the words resource for the custom model, the new definition + overwrites the existing data for the word. If the service encounters an error with the input data, it returns a + failure code and does not add any of the words to the words resource. + The call returns an HTTP 201 response code if the input data is valid. It then asynchronously processes the words + to add them to the model's words resource. The time that it takes for the analysis to complete depends on the + number of new words that you add but is generally faster than adding a corpus or training a model. + You can monitor the status of the request by using the **List a custom language model** method to poll the model's + status. Use a loop to check the status every 10 seconds. The method returns a `Customization` object that includes + a `status` field. A status of `ready` means that the words have been added to the custom model. The service cannot + accept requests to add new corpora or words or to train the model until the existing request completes. + You can use the **List custom words** or **List a custom word** method to review the words that you add. Words with + an invalid `sounds_like` field include an `error` field that describes the problem. You can use other words-related + methods to correct errors, eliminate typos, and modify how words are pronounced as needed. - parameter customizationID: The customization ID (GUID) of the custom language model. You must make the request with service credentials - created for the instance of the service that owns the custom model. + created for the instance of the service that owns the custom model. - parameter words: An array of objects that provides information about each custom word that is to be added to or updated in the - custom language model. + custom language model. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1789,45 +1837,46 @@ public class SpeechToText { Adds a custom word to a custom language model. The service populates the words resource for a custom model with out-of-vocabulary (OOV) words found in each corpus added to the model. You can use this method to add a word or to modify an existing word in the words resource. The words resource for a model can contain a maximum of 30 thousand - custom (OOV) words, including words that the service extracts from corpora and words that you add directly. You - must use credentials for the instance of the service that owns a model to add or modify a custom word for the - model. You must pass a value of `application/json` with the `Content-Type` header. Adding or modifying a custom - word does not affect the custom model until you train the model for the new data by using the **Train a custom - language model** method. Use the `word_name` parameter to specify the custom word that is to be added or - modified. Use the `CustomWord` object to provide one or both of the optional `sounds_like` and `display_as` fields - for the word. * The `sounds_like` field provides an array of one or more pronunciations for the word. Use the - parameter to specify how the word can be pronounced by users. Use the parameter for words that are difficult to - pronounce, foreign words, acronyms, and so on. For example, you might specify that the word `IEEE` can sound like - `i triple e`. You can specify a maximum of five sounds-like pronunciations for a word. For information about - pronunciation rules, see [Using the sounds_like - field](https://console.bluemix.net/docs/services/speech-to-text/language-resource.html#soundsLike). * The - `display_as` field provides a different way of spelling the word in a transcript. Use the parameter when you want - the word to appear different from its usual representation or from its spelling in corpora training data. For - example, you might indicate that the word `IBM(trademark)` is to be displayed as `IBM`. For more information, see - [Using the display_as - field](https://console.bluemix.net/docs/services/speech-to-text/language-resource.html#displayAs). If you add a - custom word that already exists in the words resource for the custom model, the new definition overwrites the - existing data for the word. If the service encounters an error, it does not add the word to the words resource. Use - the **List a custom word** method to review the word that you add. + custom (OOV) words, including words that the service extracts from corpora and words that you add directly. + You must use credentials for the instance of the service that owns a model to add or modify a custom word for the + model. Adding or modifying a custom word does not affect the custom model until you train the model for the new + data by using the **Train a custom language model** method. + Use the `word_name` parameter to specify the custom word that is to be added or modified. Use the `CustomWord` + object to provide one or both of the optional `sounds_like` and `display_as` fields for the word. + * The `sounds_like` field provides an array of one or more pronunciations for the word. Use the parameter to + specify how the word can be pronounced by users. Use the parameter for words that are difficult to pronounce, + foreign words, acronyms, and so on. For example, you might specify that the word `IEEE` can sound like `i triple + e`. You can specify a maximum of five sounds-like pronunciations for a word. For information about pronunciation + rules, see [Using the sounds_like + field](https://console.bluemix.net/docs/services/speech-to-text/language-resource.html#soundsLike). + * The `display_as` field provides a different way of spelling the word in a transcript. Use the parameter when you + want the word to appear different from its usual representation or from its spelling in corpora training data. For + example, you might indicate that the word `IBM(trademark)` is to be displayed as `IBM™`. For more + information, see [Using the display_as + field](https://console.bluemix.net/docs/services/speech-to-text/language-resource.html#displayAs). + If you add a custom word that already exists in the words resource for the custom model, the new definition + overwrites the existing data for the word. If the service encounters an error, it does not add the word to the + words resource. Use the **List a custom word** method to review the word that you add. - parameter customizationID: The customization ID (GUID) of the custom language model. You must make the request with service credentials - created for the instance of the service that owns the custom model. - - parameter wordName: The custom word for the custom language model. When you add or update a custom word with the **Add a custom word** - method, do not include spaces in the word. Use a `-` (dash) or `_` (underscore) to connect the tokens of compound - words. + created for the instance of the service that owns the custom model. + - parameter wordName: The custom word for the custom language model. When you add or update a custom word with the **Add a custom + word** method, do not include spaces in the word. Use a `-` (dash) or `_` (underscore) to connect the tokens of + compound words. - parameter word: For the **Add custom words** method, you must specify the custom word that is to be added to or updated in the - custom model. Do not include spaces in the word. Use a `-` (dash) or `_` (underscore) to connect the tokens of - compound words. Omit this field for the **Add a custom word** method. + custom model. Do not include spaces in the word. Use a `-` (dash) or `_` (underscore) to connect the tokens of + compound words. + Omit this field for the **Add a custom word** method. - parameter soundsLike: An array of sounds-like pronunciations for the custom word. Specify how words that are difficult to pronounce, - foreign words, acronyms, and so on can be pronounced by users. For a word that is not in the service's base - vocabulary, omit the parameter to have the service automatically generate a sounds-like pronunciation for the word. - For a word that is in the service's base vocabulary, use the parameter to specify additional pronunciations for the - word. You cannot override the default pronunciation of a word; pronunciations you add augment the pronunciation - from the base vocabulary. A word can have at most five sounds-like pronunciations, and a pronunciation can include - at most 40 characters not including spaces. + foreign words, acronyms, and so on can be pronounced by users. For a word that is not in the service's base + vocabulary, omit the parameter to have the service automatically generate a sounds-like pronunciation for the + word. For a word that is in the service's base vocabulary, use the parameter to specify additional pronunciations + for the word. You cannot override the default pronunciation of a word; pronunciations you add augment the + pronunciation from the base vocabulary. A word can have at most five sounds-like pronunciations, and a + pronunciation can include at most 40 characters not including spaces. - parameter displayAs: An alternative spelling for the custom word when it appears in a transcript. Use the parameter when you want the - word to have a spelling that is different from its usual representation or from its spelling in corpora training - data. + word to have a spelling that is different from its usual representation or from its spelling in corpora training + data. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1882,16 +1931,16 @@ public class SpeechToText { } /** - List a custom word. + Get a custom word. - Lists information about a custom word from a custom language model. You must use credentials for the instance of - the service that owns a model to query information about its words. + Gets information about a custom word from a custom language model. You must use credentials for the instance of the + service that owns a model to query information about its words. - parameter customizationID: The customization ID (GUID) of the custom language model. You must make the request with service credentials - created for the instance of the service that owns the custom model. - - parameter wordName: The custom word for the custom language model. When you add or update a custom word with the **Add a custom word** - method, do not include spaces in the word. Use a `-` (dash) or `_` (underscore) to connect the tokens of compound - words. + created for the instance of the service that owns the custom model. + - parameter wordName: The custom word for the custom language model. When you add or update a custom word with the **Add a custom + word** method, do not include spaces in the word. Use a `-` (dash) or `_` (underscore) to connect the tokens of + compound words. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1943,10 +1992,10 @@ public class SpeechToText { must use credentials for the instance of the service that owns a model to delete its words. - parameter customizationID: The customization ID (GUID) of the custom language model. You must make the request with service credentials - created for the instance of the service that owns the custom model. - - parameter wordName: The custom word for the custom language model. When you add or update a custom word with the **Add a custom word** - method, do not include spaces in the word. Use a `-` (dash) or `_` (underscore) to connect the tokens of compound - words. + created for the instance of the service that owns the custom model. + - parameter wordName: The custom word for the custom language model. When you add or update a custom word with the **Add a custom + word** method, do not include spaces in the word. Use a `-` (dash) or `_` (underscore) to connect the tokens of + compound words. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -1993,17 +2042,17 @@ public class SpeechToText { Creates a new custom acoustic model for a specified base model. The custom acoustic model can be used only with the base model for which it is created. The model is owned by the instance of the service whose credentials are used to - create it. You must pass a value of `application/json` with the `Content-Type` header. + create it. - parameter name: A user-defined name for the new custom acoustic model. Use a name that is unique among all custom acoustic models - that you own. Use a localized name that matches the language of the custom model. Use a name that describes the - acoustic environment of the custom model, such as `Mobile custom model` or `Noisy car custom model`. - - parameter baseModelName: The name of the base language model that is to be customized by the new custom acoustic model. The new custom model - can be used only with the base model that it customizes. To determine whether a base model supports acoustic model - customization, refer to [Language support for - customization](https://console.bluemix.net/docs/services/speech-to-text/custom.html#languageSupport). - - parameter description: A description of the new custom acoustic model. Use a localized description that matches the language of the custom - model. + that you own. Use a localized name that matches the language of the custom model. Use a name that describes the + acoustic environment of the custom model, such as `Mobile custom model` or `Noisy car custom model`. + - parameter baseModelName: The name of the base language model that is to be customized by the new custom acoustic model. The new custom + model can be used only with the base model that it customizes. To determine whether a base model supports + acoustic model customization, refer to [Language support for + customization](https://console.bluemix.net/docs/services/speech-to-text/custom.html#languageSupport). + - parameter description: A description of the new custom acoustic model. Use a localized description that matches the language of the + custom model. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2054,13 +2103,13 @@ public class SpeechToText { List custom acoustic models. Lists information about all custom acoustic models that are owned by an instance of the service. Use the `language` - parameter to see all custom acoustic models for the specified language; omit the parameter to see all custom + parameter to see all custom acoustic models for the specified language. Omit the parameter to see all custom acoustic models for all languages. You must use credentials for the instance of the service that owns a model to list information about it. - - parameter language: The identifier of the language for which custom language or custom acoustic models are to be returned (for example, - `en-US`). Omit the parameter to see all custom language or custom acoustic models owned by the requesting service - credentials. + - parameter language: The identifier of the language for which custom language or custom acoustic models are to be returned (for + example, `en-US`). Omit the parameter to see all custom language or custom acoustic models owned by the + requesting service credentials. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2105,13 +2154,13 @@ public class SpeechToText { } /** - List a custom acoustic model. + Get a custom acoustic model. - Lists information about a specified custom acoustic model. You must use credentials for the instance of the service + Gets information about a specified custom acoustic model. You must use credentials for the instance of the service that owns a model to list information about it. - parameter customizationID: The customization ID (GUID) of the custom acoustic model. You must make the request with service credentials - created for the instance of the service that owns the custom model. + created for the instance of the service that owns the custom model. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2160,7 +2209,7 @@ public class SpeechToText { that owns a model to delete it. - parameter customizationID: The customization ID (GUID) of the custom acoustic model. You must make the request with service credentials - created for the instance of the service that owns the custom model. + created for the instance of the service that owns the custom model. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2207,31 +2256,34 @@ public class SpeechToText { Initiates the training of a custom acoustic model with new or changed audio resources. After adding or deleting audio resources for a custom acoustic model, use this method to begin the actual training of the model on the latest audio data. The custom acoustic model does not reflect its changed data until you train it. You must use - credentials for the instance of the service that owns a model to train it. The training method is asynchronous. - It can take on the order of minutes or hours to complete depending on the total amount of audio data on which the - custom acoustic model is being trained and the current load on the service. Typically, training a custom acoustic - model takes approximately two to four times the length of its audio data. The range of time depends on the model - being trained and the nature of the audio, such as whether the audio is clean or noisy. The method returns an HTTP - 200 response code to indicate that the training process has begun. You can monitor the status of the training by - using the **List a custom acoustic model** method to poll the model's status. Use a loop to check the status once a - minute. The method returns an `Customization` object that includes `status` and `progress` fields. A status of - `available` indicates that the custom model is trained and ready to use. The service cannot accept subsequent - training requests, or requests to add new audio resources, until the existing request completes. You can use the - optional `custom_language_model_id` parameter to specify the GUID of a separately created custom language model - that is to be used during training. Specify a custom language model if you have verbatim transcriptions of the - audio files that you have added to the custom model or you have either corpora (text files) or a list of words that - are relevant to the contents of the audio files. For information about creating a separate custom language model, - see [Creating a custom language - model](https://console.bluemix.net/docs/services/speech-to-text/language-create.html). Training can fail to start - for the following reasons: * The service is currently handling another request for the custom model, such as - another training request or a request to add audio resources to the model. * The custom model contains less than 10 - minutes or more than 50 hours of audio data. * One or more of the custom model's audio resources is invalid. + credentials for the instance of the service that owns a model to train it. + The training method is asynchronous. It can take on the order of minutes or hours to complete depending on the + total amount of audio data on which the custom acoustic model is being trained and the current load on the service. + Typically, training a custom acoustic model takes approximately two to four times the length of its audio data. The + range of time depends on the model being trained and the nature of the audio, such as whether the audio is clean or + noisy. The method returns an HTTP 200 response code to indicate that the training process has begun. + You can monitor the status of the training by using the **Get a custom acoustic model** method to poll the model's + status. Use a loop to check the status once a minute. The method returns an `AcousticModel` object that includes + `status` and `progress` fields. A status of `available` indicates that the custom model is trained and ready to + use. The service cannot accept subsequent training requests, or requests to add new audio resources, until the + existing request completes. + You can use the optional `custom_language_model_id` parameter to specify the GUID of a separately created custom + language model that is to be used during training. Specify a custom language model if you have verbatim + transcriptions of the audio files that you have added to the custom model or you have either corpora (text files) + or a list of words that are relevant to the contents of the audio files. For information about creating a separate + custom language model, see [Creating a custom language + model](https://console.bluemix.net/docs/services/speech-to-text/language-create.html). + Training can fail to start for the following reasons: + * The service is currently handling another request for the custom model, such as another training request or a + request to add audio resources to the model. + * The custom model contains less than 10 minutes or more than 50 hours of audio data. + * One or more of the custom model's audio resources is invalid. - parameter customizationID: The customization ID (GUID) of the custom acoustic model. You must make the request with service credentials - created for the instance of the service that owns the custom model. + created for the instance of the service that owns the custom model. - parameter customLanguageModelID: The customization ID (GUID) of a custom language model that is to be used during training of the custom acoustic - model. Specify a custom language model that has been trained with verbatim transcriptions of the audio resources or - that contains words that are relevant to the contents of the audio resources. + model. Specify a custom language model that has been trained with verbatim transcriptions of the audio resources + or that contains words that are relevant to the contents of the audio resources. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2290,7 +2342,7 @@ public class SpeechToText { instance of the service that owns a model to reset it. - parameter customizationID: The customization ID (GUID) of the custom acoustic model. You must make the request with service credentials - created for the instance of the service that owns the custom model. + created for the instance of the service that owns the custom model. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2338,22 +2390,24 @@ public class SpeechToText { method is asynchronous. It can take on the order of minutes or hours to complete depending on the amount of data in the custom model and the current load on the service; typically, upgrade takes approximately twice the length of the total audio contained in the custom model. A custom model must be in the `ready` or `available` state to be - upgraded. You must use credentials for the instance of the service that owns a model to upgrade it. The method - returns an HTTP 200 response code to indicate that the upgrade process has begun successfully. You can monitor the - status of the upgrade by using the **List a custom acoustic model** method to poll the model's status. Use a loop - to check the status once a minute. While it is being upgraded, the custom model has the status `upgrading`. When - the upgrade is complete, the model resumes the status that it had prior to upgrade. The service cannot accept - subsequent requests for the model until the upgrade completes. If the custom acoustic model was trained with a - separately created custom language model, you must use the `custom_language_model_id` parameter to specify the GUID - of that custom language model. The custom language model must be upgraded before the custom acoustic model can be - upgraded. Omit the parameter if the custom acoustic model was not trained with a custom language model. For more - information, see [Upgrading custom + upgraded. You must use credentials for the instance of the service that owns a model to upgrade it. + The method returns an HTTP 200 response code to indicate that the upgrade process has begun successfully. You can + monitor the status of the upgrade by using the **Get a custom acoustic model** method to poll the model's status. + The method returns an `AcousticModel` object that includes `status` and `progress` fields. Use a loop to check the + status once a minute. While it is being upgraded, the custom model has the status `upgrading`. When the upgrade is + complete, the model resumes the status that it had prior to upgrade. The service cannot accept subsequent requests + for the model until the upgrade completes. + If the custom acoustic model was trained with a separately created custom language model, you must use the + `custom_language_model_id` parameter to specify the GUID of that custom language model. The custom language model + must be upgraded before the custom acoustic model can be upgraded. Omit the parameter if the custom acoustic model + was not trained with a custom language model. + For more information, see [Upgrading custom models](https://console.bluemix.net/docs/services/speech-to-text/custom-upgrade.html). - parameter customizationID: The customization ID (GUID) of the custom acoustic model. You must make the request with service credentials - created for the instance of the service that owns the custom model. + created for the instance of the service that owns the custom model. - parameter customLanguageModelID: If the custom acoustic model was trained with a custom language model, the customization ID (GUID) of that custom - language model. The custom language model must be upgraded before the custom acoustic model can be upgraded. + language model. The custom language model must be upgraded before the custom acoustic model can be upgraded. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2413,7 +2467,7 @@ public class SpeechToText { its audio resources. - parameter customizationID: The customization ID (GUID) of the custom acoustic model. You must make the request with service credentials - created for the instance of the service that owns the custom model. + created for the instance of the service that owns the custom model. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2460,62 +2514,76 @@ public class SpeechToText { Adds an audio resource to a custom acoustic model. Add audio content that reflects the acoustic characteristics of the audio that you plan to transcribe. You must use credentials for the instance of the service that owns a model to add an audio resource to it. Adding audio data does not affect the custom acoustic model until you train the - model for the new data by using the **Train a custom acoustic model** method. You can add individual audio files - or an archive file that contains multiple audio files. Adding multiple audio files via a single archive file is - significantly more efficient than adding each file individually. You can add audio resources in any format that the - service supports for speech recognition. You can use this method to add any number of audio resources to a custom - model by calling the method once for each audio or archive file. But the addition of one audio resource must be - fully complete before you can add another. You must add a minimum of 10 minutes and a maximum of 50 hours of audio - that includes speech, not just silence, to a custom acoustic model before you can train it. No audio resource, - audio- or archive-type, can be larger than 100 MB. To add an audio resource that has the same name as an existing - audio resource, set the `allow_overwrite` parameter to `true`; otherwise, the request fails. The method is - asynchronous. It can take several seconds to complete depending on the duration of the audio and, in the case of an - archive file, the total number of audio files being processed. The service returns a 201 response code if the audio - is valid. It then asynchronously analyzes the contents of the audio file or files and automatically extracts - information about the audio such as its length, sampling rate, and encoding. You cannot submit requests to add - additional audio resources to a custom acoustic model, or to train the model, until the service's analysis of all - audio files for the current request completes. To determine the status of the service's analysis of the audio, - use the **List an audio resource** method to poll the status of the audio. The method accepts the GUID of the - custom model and the name of the audio resource, and it returns the status of the resource. Use a loop to check the - status of the audio every few seconds until it becomes `ok`. ### Content types for audio-type resources You can - add an individual audio file in any format that the service supports for speech recognition. For an audio-type - resource, use the `Content-Type` parameter to specify the audio format (MIME type) of the audio file: * - `audio/basic` (Use only with narrowband models.) * `audio/flac` * `audio/l16` (Specify the sampling rate (`rate`) - and optionally the number of channels (`channels`) and endianness (`endianness`) of the audio.) * `audio/mp3` * - `audio/mpeg` * `audio/mulaw` (Specify the sampling rate (`rate`) of the audio.) * `audio/ogg` (The service - automatically detects the codec of the input audio.) * `audio/ogg;codecs=opus` * `audio/ogg;codecs=vorbis` * - `audio/wav` (Provide audio with a maximum of nine channels.) * `audio/webm` (The service automatically detects the - codec of the input audio.) * `audio/webm;codecs=opus` * `audio/webm;codecs=vorbis` For information about the - supported audio formats, including specifying the sampling rate, channels, and endianness for the indicated - formats, see [Audio formats](https://console.bluemix.net/docs/services/speech-to-text/audio-formats.html). + model for the new data by using the **Train a custom acoustic model** method. + You can add individual audio files or an archive file that contains multiple audio files. Adding multiple audio + files via a single archive file is significantly more efficient than adding each file individually. You can add + audio resources in any format that the service supports for speech recognition. + You can use this method to add any number of audio resources to a custom model by calling the method once for each + audio or archive file. But the addition of one audio resource must be fully complete before you can add another. + You must add a minimum of 10 minutes and a maximum of 50 hours of audio that includes speech, not just silence, to + a custom acoustic model before you can train it. No audio resource, audio- or archive-type, can be larger than 100 + MB. To add an audio resource that has the same name as an existing audio resource, set the `allow_overwrite` + parameter to `true`; otherwise, the request fails. + The method is asynchronous. It can take several seconds to complete depending on the duration of the audio and, in + the case of an archive file, the total number of audio files being processed. The service returns a 201 response + code if the audio is valid. It then asynchronously analyzes the contents of the audio file or files and + automatically extracts information about the audio such as its length, sampling rate, and encoding. You cannot + submit requests to add additional audio resources to a custom acoustic model, or to train the model, until the + service's analysis of all audio files for the current request completes. + To determine the status of the service's analysis of the audio, use the **Get an audio resource** method to poll + the status of the audio. The method accepts the customization ID of the custom model and the name of the audio + resource, and it returns the status of the resource. Use a loop to check the status of the audio every few seconds + until it becomes `ok`. + ### Content types for audio-type resources + You can add an individual audio file in any format that the service supports for speech recognition. For an + audio-type resource, use the `Content-Type` parameter to specify the audio format (MIME type) of the audio file: + * `audio/basic` (Use only with narrowband models.) + * `audio/flac` + * `audio/l16` (Specify the sampling rate (`rate`) and optionally the number of channels (`channels`) and endianness + (`endianness`) of the audio.) + * `audio/mp3` + * `audio/mpeg` + * `audio/mulaw` (Specify the sampling rate (`rate`) of the audio.) + * `audio/ogg` (The service automatically detects the codec of the input audio.) + * `audio/ogg;codecs=opus` + * `audio/ogg;codecs=vorbis` + * `audio/wav` (Provide audio with a maximum of nine channels.) + * `audio/webm` (The service automatically detects the codec of the input audio.) + * `audio/webm;codecs=opus` + * `audio/webm;codecs=vorbis` + For information about the supported audio formats, including specifying the sampling rate, channels, and endianness + for the indicated formats, see [Audio + formats](https://console.bluemix.net/docs/services/speech-to-text/audio-formats.html). **Note:** The sampling rate of an audio file must match the sampling rate of the base model for the custom model: for broadband models, at least 16 kHz; for narrowband models, at least 8 kHz. If the sampling rate of the audio is higher than the minimum required rate, the service down-samples the audio to the appropriate rate. If the sampling - rate of the audio is lower than the minimum required rate, the service labels the audio file as `invalid`. ### - Content types for archive-type resources You can add an archive file (**.zip** or **.tar.gz** file) that contains - audio files in any format that the service supports for speech recognition. For an archive-type resource, use the - `Content-Type` parameter to specify the media type of the archive file: * `application/zip` for a **.zip** file * - `application/gzip` for a **.tar.gz** file. All audio files contained in the archive must have the same audio - format. Use the `Contained-Content-Type` parameter to specify the format of the contained audio files. The - parameter accepts all of the audio formats supported for use with speech recognition and with the `Content-Type` - header, including the `rate`, `channels`, and `endianness` parameters that are used with some formats. The default - contained audio format is `audio/wav`. + rate of the audio is lower than the minimum required rate, the service labels the audio file as `invalid`. + ### Content types for archive-type resources + You can add an archive file (**.zip** or **.tar.gz** file) that contains audio files in any format that the + service supports for speech recognition. For an archive-type resource, use the `Content-Type` parameter to specify + the media type of the archive file: + * `application/zip` for a **.zip** file + * `application/gzip` for a **.tar.gz** file. + All audio files contained in the archive must have the same audio format. Use the `Contained-Content-Type` + parameter to specify the format of the contained audio files. The parameter accepts all of the audio formats + supported for use with speech recognition and with the `Content-Type` header, including the `rate`, `channels`, and + `endianness` parameters that are used with some formats. The default contained audio format is `audio/wav`. - parameter customizationID: The customization ID (GUID) of the custom acoustic model. You must make the request with service credentials - created for the instance of the service that owns the custom model. - - parameter audioName: The name of the audio resource for the custom acoustic model. When adding an audio resource, do not include spaces - in the name; use a localized name that matches the language of the custom model. + created for the instance of the service that owns the custom model. + - parameter audioName: The name of the audio resource for the custom acoustic model. When adding an audio resource, do not include + spaces in the name; use a localized name that matches the language of the custom model. - parameter audioResource: The audio resource that is to be added to the custom acoustic model, an individual audio file or an archive file. - parameter contentType: The type of the input: application/zip, application/gzip, audio/basic, audio/flac, audio/l16, audio/mp3, - audio/mpeg, audio/mulaw, audio/ogg, audio/ogg;codecs=opus, audio/ogg;codecs=vorbis, audio/wav, audio/webm, - audio/webm;codecs=opus, or audio/webm;codecs=vorbis. - - parameter containedContentType: For an archive-type resource, specifies the format of the audio files contained in the archive file. The parameter - accepts all of the audio formats supported for use with speech recognition, including the `rate`, `channels`, and - `endianness` parameters that are used with some formats. For a complete list of supported audio formats, see [Audio - formats](/docs/services/speech-to-text/input.html#formats). + audio/mpeg, audio/mulaw, audio/ogg, audio/ogg;codecs=opus, audio/ogg;codecs=vorbis, audio/wav, audio/webm, + audio/webm;codecs=opus, or audio/webm;codecs=vorbis. + - parameter containedContentType: For an archive-type resource, specifies the format of the audio files contained in the archive file. The + parameter accepts all of the audio formats supported for use with speech recognition, including the `rate`, + `channels`, and `endianness` parameters that are used with some formats. For a complete list of supported audio + formats, see [Audio formats](/docs/services/speech-to-text/input.html#formats). - parameter allowOverwrite: If `true`, the specified corpus or audio resource overwrites an existing corpus or audio resource with the same - name. If `false` (the default), the request fails if a corpus or audio resource with the same name already exists. - The parameter has no effect if a corpus or audio resource with the same name does not already exist. + name. If `false` (the default), the request fails if a corpus or audio resource with the same name already + exists. The parameter has no effect if a corpus or audio resource with the same name does not already exist. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2578,22 +2646,26 @@ public class SpeechToText { } /** - List an audio resource. - - Lists information about an audio resource from a custom acoustic model. The method returns an `AudioListing` object - whose fields depend on the type of audio resource you specify with the method's `audio_name` parameter: * **For an - audio-type resource,** the object's fields match those of an `AudioResource` object: `duration`, `name`, `details`, - and `status`. * **For an archive-type resource,** the object includes a `container` field whose fields match those - of an `AudioResource` object. It also includes an `audio` field, which contains an array of `AudioResource` objects - that provides information about the audio files that are contained in the archive. The information includes the - status of the specified audio resource, which is important for checking the service's analysis of the resource in - response to a request to add it to the custom model. You must use credentials for the instance of the service that - owns a model to list its audio resources. + Get an audio resource. + + Gets information about an audio resource from a custom acoustic model. The method returns an `AudioListing` object + whose fields depend on the type of audio resource that you specify with the method's `audio_name` parameter: + * **For an audio-type resource,** the object's fields match those of an `AudioResource` object: `duration`, `name`, + `details`, and `status`. + * **For an archive-type resource,** the object includes a `container` field whose fields match those of an + `AudioResource` object. It also includes an `audio` field, which contains an array of `AudioResource` objects that + provides information about the audio files that are contained in the archive. + The information includes the status of the specified audio resource. The status is important for checking the + service's analysis of a resource that you add to the custom model. + * For an audio-type resource, the `status` field is located in the `AudioListing` object. + * For an archive-type resource, the `status` field is located in the `AudioResource` object that is returned in the + `container` field. + You must use credentials for the instance of the service that owns a model to list its audio resources. - parameter customizationID: The customization ID (GUID) of the custom acoustic model. You must make the request with service credentials - created for the instance of the service that owns the custom model. - - parameter audioName: The name of the audio resource for the custom acoustic model. When adding an audio resource, do not include spaces - in the name; use a localized name that matches the language of the custom model. + created for the instance of the service that owns the custom model. + - parameter audioName: The name of the audio resource for the custom acoustic model. When adding an audio resource, do not include + spaces in the name; use a localized name that matches the language of the custom model. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2645,9 +2717,9 @@ public class SpeechToText { that owns a model to delete its audio resources. - parameter customizationID: The customization ID (GUID) of the custom acoustic model. You must make the request with service credentials - created for the instance of the service that owns the custom model. - - parameter audioName: The name of the audio resource for the custom acoustic model. When adding an audio resource, do not include spaces - in the name; use a localized name that matches the language of the custom model. + created for the instance of the service that owns the custom model. + - parameter audioName: The name of the audio resource for the custom acoustic model. When adding an audio resource, do not include + spaces in the name; use a localized name that matches the language of the custom model. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -2695,9 +2767,10 @@ public class SpeechToText { Deletes all data that is associated with a specified customer ID. The method deletes all data for the customer ID, regardless of the method by which the information was added. The method has no effect if no data is associated with the customer ID. You must issue the request with credentials for the same instance of the service that was used to - associate the customer ID with the data. You associate a customer ID with data by passing the `X-Watson-Metadata` - header with a request that passes the data. For more information about customer IDs and about using this method, - see [Information security](https://console.bluemix.net/docs/services/speech-to-text/information-security.html). + associate the customer ID with the data. + You associate a customer ID with data by passing the `X-Watson-Metadata` header with a request that passes the + data. For more information about customer IDs and about using this method, see [Information + security](https://console.bluemix.net/docs/services/speech-to-text/information-security.html). - parameter customerID: The customer ID for which all data is to be deleted. - parameter headers: A dictionary of request headers to be sent with this request. diff --git a/Source/SupportingFiles/Credentials.swift.enc b/Source/SupportingFiles/Credentials.swift.enc index 5d3b6430f..e5db47b85 100644 Binary files a/Source/SupportingFiles/Credentials.swift.enc and b/Source/SupportingFiles/Credentials.swift.enc differ diff --git a/Source/SupportingFiles/CredentialsExample.swift b/Source/SupportingFiles/CredentialsExample.swift index 27217db44..ded220ea9 100644 --- a/Source/SupportingFiles/CredentialsExample.swift +++ b/Source/SupportingFiles/CredentialsExample.swift @@ -25,6 +25,8 @@ struct Credentials { static let DiscoveryPassword = "your-password-here" static let LanguageTranslatorUsername = "your-username-here" static let LanguageTranslatorPassword = "your-password-here" + static let LanguageTranslatorV3Username = "your-username-here" + static let LanguageTranslatorV3Password = "your-password-here" static let NaturalLanguageClassifierUsername = "your-username-here" static let NaturalLanguageClassifierPassword = "your-password-here" static let NaturalLanguageUnderstandingUsername = "your-username-here" diff --git a/Source/SupportingFiles/LanguageTranslatorV3.h b/Source/SupportingFiles/LanguageTranslatorV3.h new file mode 100644 index 000000000..7d903d632 --- /dev/null +++ b/Source/SupportingFiles/LanguageTranslatorV3.h @@ -0,0 +1,27 @@ +/** + * Copyright IBM Corporation 2018 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + +#import + +//! Project version number for LanguageTranslatorV3. +FOUNDATION_EXPORT double LanguageTranslatorV3VersionNumber; + +//! Project version string for LanguageTranslatorV3. +FOUNDATION_EXPORT const unsigned char LanguageTranslatorV3VersionString[]; + +// In this header, you should import all the public headers of your framework using statements like #import + + diff --git a/Source/TextToSpeechV1/Models/CreateVoiceModel.swift b/Source/TextToSpeechV1/Models/CreateVoiceModel.swift index dfbffe86c..bb28c2dfa 100644 --- a/Source/TextToSpeechV1/Models/CreateVoiceModel.swift +++ b/Source/TextToSpeechV1/Models/CreateVoiceModel.swift @@ -19,7 +19,9 @@ import Foundation /** CreateVoiceModel. */ public struct CreateVoiceModel: Encodable { - /// The language of the new custom voice model. Omit the parameter to use the the default language, `en-US`. + /** + The language of the new custom voice model. Omit the parameter to use the the default language, `en-US`. + */ public enum Language: String { case deDe = "de-DE" case enUs = "en-US" @@ -33,13 +35,19 @@ public struct CreateVoiceModel: Encodable { case ptBr = "pt-BR" } - /// The name of the new custom voice model. + /** + The name of the new custom voice model. + */ public var name: String - /// The language of the new custom voice model. Omit the parameter to use the the default language, `en-US`. + /** + The language of the new custom voice model. Omit the parameter to use the the default language, `en-US`. + */ public var language: String? - /// A description of the new custom voice model. Specifying a description is recommended. + /** + A description of the new custom voice model. Specifying a description is recommended. + */ public var description: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -58,7 +66,12 @@ public struct CreateVoiceModel: Encodable { - returns: An initialized `CreateVoiceModel`. */ - public init(name: String, language: String? = nil, description: String? = nil) { + public init( + name: String, + language: String? = nil, + description: String? = nil + ) + { self.name = name self.language = language self.description = description diff --git a/Source/TextToSpeechV1/Models/Pronunciation.swift b/Source/TextToSpeechV1/Models/Pronunciation.swift index 5fa5b1c7d..b3c65c3d2 100644 --- a/Source/TextToSpeechV1/Models/Pronunciation.swift +++ b/Source/TextToSpeechV1/Models/Pronunciation.swift @@ -19,7 +19,10 @@ import Foundation /** Pronunciation. */ public struct Pronunciation: Decodable { - /// The pronunciation of the specified text in the requested voice and format. If a custom voice model is specified, the pronunciation also reflects that custom voice. + /** + The pronunciation of the specified text in the requested voice and format. If a custom voice model is specified, + the pronunciation also reflects that custom voice. + */ public var pronunciation: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/TextToSpeechV1/Models/SupportedFeatures.swift b/Source/TextToSpeechV1/Models/SupportedFeatures.swift index 5796a7448..ad074f0d1 100644 --- a/Source/TextToSpeechV1/Models/SupportedFeatures.swift +++ b/Source/TextToSpeechV1/Models/SupportedFeatures.swift @@ -19,10 +19,15 @@ import Foundation /** SupportedFeatures. */ public struct SupportedFeatures: Decodable { - /// If `true`, the voice can be customized; if `false`, the voice cannot be customized. (Same as `customizable`.). + /** + If `true`, the voice can be customized; if `false`, the voice cannot be customized. (Same as `customizable`.). + */ public var customPronunciation: Bool - /// If `true`, the voice can be transformed by using the SSML <voice-transformation> element; if `false`, the voice cannot be transformed. + /** + If `true`, the voice can be transformed by using the SSML <voice-transformation> element; if `false`, the + voice cannot be transformed. + */ public var voiceTransformation: Bool // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/TextToSpeechV1/Models/Text.swift b/Source/TextToSpeechV1/Models/Text.swift index 8cdb63d97..22e5f5139 100644 --- a/Source/TextToSpeechV1/Models/Text.swift +++ b/Source/TextToSpeechV1/Models/Text.swift @@ -19,7 +19,9 @@ import Foundation /** Text. */ public struct Text: Encodable { - /// The text to synthesize. + /** + The text to synthesize. + */ public var text: String // Map each property name to the key that shall be used for encoding/decoding. @@ -34,7 +36,10 @@ public struct Text: Encodable { - returns: An initialized `Text`. */ - public init(text: String) { + public init( + text: String + ) + { self.text = text } diff --git a/Source/TextToSpeechV1/Models/Translation.swift b/Source/TextToSpeechV1/Models/Translation.swift index 42b796bf4..dc91c92f1 100644 --- a/Source/TextToSpeechV1/Models/Translation.swift +++ b/Source/TextToSpeechV1/Models/Translation.swift @@ -19,7 +19,12 @@ import Foundation /** Translation. */ public struct Translation: Codable { - /// **Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see [Working with Japanese entries](https://console.bluemix.net/docs/services/text-to-speech/custom-rules.html#jaNotes). + /** + **Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation + for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot + create multiple entries with different parts of speech for the same word. For more information, see [Working with + Japanese entries](https://console.bluemix.net/docs/services/text-to-speech/custom-rules.html#jaNotes). + */ public enum PartOfSpeech: String { case josi = "Josi" case mesi = "Mesi" @@ -40,10 +45,19 @@ public struct Translation: Codable { case hoka = "Hoka" } - /// The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A sounds-like is one or more words that, when combined, sound like the word. + /** + The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for + representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A sounds-like + is one or more words that, when combined, sound like the word. + */ public var translation: String - /// **Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see [Working with Japanese entries](https://console.bluemix.net/docs/services/text-to-speech/custom-rules.html#jaNotes). + /** + **Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation + for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot + create multiple entries with different parts of speech for the same word. For more information, see [Working with + Japanese entries](https://console.bluemix.net/docs/services/text-to-speech/custom-rules.html#jaNotes). + */ public var partOfSpeech: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -55,12 +69,22 @@ public struct Translation: Codable { /** Initialize a `Translation` with member variables. - - parameter translation: The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A sounds-like is one or more words that, when combined, sound like the word. - - parameter partOfSpeech: **Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see [Working with Japanese entries](https://console.bluemix.net/docs/services/text-to-speech/custom-rules.html#jaNotes). + - parameter translation: The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for + representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A + sounds-like is one or more words that, when combined, sound like the word. + - parameter partOfSpeech: **Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation + for the word. You can create only a single entry, with or without a single part of speech, for any word; you + cannot create multiple entries with different parts of speech for the same word. For more information, see + [Working with Japanese + entries](https://console.bluemix.net/docs/services/text-to-speech/custom-rules.html#jaNotes). - returns: An initialized `Translation`. */ - public init(translation: String, partOfSpeech: String? = nil) { + public init( + translation: String, + partOfSpeech: String? = nil + ) + { self.translation = translation self.partOfSpeech = partOfSpeech } diff --git a/Source/TextToSpeechV1/Models/UpdateVoiceModel.swift b/Source/TextToSpeechV1/Models/UpdateVoiceModel.swift index 3762dfbbf..b5702b103 100644 --- a/Source/TextToSpeechV1/Models/UpdateVoiceModel.swift +++ b/Source/TextToSpeechV1/Models/UpdateVoiceModel.swift @@ -19,13 +19,20 @@ import Foundation /** UpdateVoiceModel. */ public struct UpdateVoiceModel: Encodable { - /// A new name for the custom voice model. + /** + A new name for the custom voice model. + */ public var name: String? - /// A new description for the custom voice model. + /** + A new description for the custom voice model. + */ public var description: String? - /// An array of `Word` objects that provides the words and their translations that are to be added or updated for the custom voice model. Pass an empty array to make no additions or updates. + /** + An array of `Word` objects that provides the words and their translations that are to be added or updated for the + custom voice model. Pass an empty array to make no additions or updates. + */ public var words: [Word]? // Map each property name to the key that shall be used for encoding/decoding. @@ -40,11 +47,17 @@ public struct UpdateVoiceModel: Encodable { - parameter name: A new name for the custom voice model. - parameter description: A new description for the custom voice model. - - parameter words: An array of `Word` objects that provides the words and their translations that are to be added or updated for the custom voice model. Pass an empty array to make no additions or updates. + - parameter words: An array of `Word` objects that provides the words and their translations that are to be added or updated for the + custom voice model. Pass an empty array to make no additions or updates. - returns: An initialized `UpdateVoiceModel`. */ - public init(name: String? = nil, description: String? = nil, words: [Word]? = nil) { + public init( + name: String? = nil, + description: String? = nil, + words: [Word]? = nil + ) + { self.name = name self.description = description self.words = words diff --git a/Source/TextToSpeechV1/Models/Voice.swift b/Source/TextToSpeechV1/Models/Voice.swift index 6a99fc1d9..e799a4682 100644 --- a/Source/TextToSpeechV1/Models/Voice.swift +++ b/Source/TextToSpeechV1/Models/Voice.swift @@ -19,28 +19,46 @@ import Foundation /** Voice. */ public struct Voice: Decodable { - /// The URI of the voice. + /** + The URI of the voice. + */ public var url: String - /// The gender of the voice: `male` or `female`. + /** + The gender of the voice: `male` or `female`. + */ public var gender: String - /// The name of the voice. Use this as the voice identifier in all requests. + /** + The name of the voice. Use this as the voice identifier in all requests. + */ public var name: String - /// The language and region of the voice (for example, `en-US`). + /** + The language and region of the voice (for example, `en-US`). + */ public var language: String - /// A textual description of the voice. + /** + A textual description of the voice. + */ public var description: String - /// If `true`, the voice can be customized; if `false`, the voice cannot be customized. (Same as `custom_pronunciation`; maintained for backward compatibility.). + /** + If `true`, the voice can be customized; if `false`, the voice cannot be customized. (Same as + `custom_pronunciation`; maintained for backward compatibility.). + */ public var customizable: Bool - /// Describes the additional service features supported with the voice. + /** + Describes the additional service features supported with the voice. + */ public var supportedFeatures: SupportedFeatures - /// Returns information about a specified custom voice model. This field is returned only by the **Get a voice** method and only when you specify the customization ID of a custom voice model. + /** + Returns information about a specified custom voice model. This field is returned only by the **Get a voice** method + and only when you specify the customization ID of a custom voice model. + */ public var customization: VoiceModel? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/TextToSpeechV1/Models/VoiceModel.swift b/Source/TextToSpeechV1/Models/VoiceModel.swift index ce782cf12..8089e5a47 100644 --- a/Source/TextToSpeechV1/Models/VoiceModel.swift +++ b/Source/TextToSpeechV1/Models/VoiceModel.swift @@ -19,28 +19,51 @@ import Foundation /** VoiceModel. */ public struct VoiceModel: Decodable { - /// The customization ID (GUID) of the custom voice model. The **Create a custom model** method returns only this field. It does not not return the other fields of this object. + /** + The customization ID (GUID) of the custom voice model. The **Create a custom model** method returns only this + field. It does not not return the other fields of this object. + */ public var customizationID: String - /// The name of the custom voice model. + /** + The name of the custom voice model. + */ public var name: String? - /// The language identifier of the custom voice model (for example, `en-US`). + /** + The language identifier of the custom voice model (for example, `en-US`). + */ public var language: String? - /// The GUID of the service credentials for the instance of the service that owns the custom voice model. + /** + The GUID of the service credentials for the instance of the service that owns the custom voice model. + */ public var owner: String? - /// The date and time in Coordinated Universal Time (UTC) at which the custom voice model was created. The value is provided in full ISO 8601 format (`YYYY-MM-DDThh:mm:ss.sTZD`). + /** + The date and time in Coordinated Universal Time (UTC) at which the custom voice model was created. The value is + provided in full ISO 8601 format (`YYYY-MM-DDThh:mm:ss.sTZD`). + */ public var created: String? - /// The date and time in Coordinated Universal Time (UTC) at which the custom voice model was last modified. Equals `created` when a new voice model is first added but has yet to be updated. The value is provided in full ISO 8601 format (`YYYY-MM-DDThh:mm:ss.sTZD`). + /** + The date and time in Coordinated Universal Time (UTC) at which the custom voice model was last modified. Equals + `created` when a new voice model is first added but has yet to be updated. The value is provided in full ISO 8601 + format (`YYYY-MM-DDThh:mm:ss.sTZD`). + */ public var lastModified: String? - /// The description of the custom voice model. + /** + The description of the custom voice model. + */ public var description: String? - /// An array of `Word` objects that lists the words and their translations from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if the custom model contains no words. This field is returned only by the **Get a voice** method and only when you specify the customization ID of a custom voice model. + /** + An array of `Word` objects that lists the words and their translations from the custom voice model. The words are + listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if the + custom model contains no words. This field is returned only by the **Get a voice** method and only when you specify + the customization ID of a custom voice model. + */ public var words: [Word]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/TextToSpeechV1/Models/VoiceModels.swift b/Source/TextToSpeechV1/Models/VoiceModels.swift index 7376d7d71..b60ce1039 100644 --- a/Source/TextToSpeechV1/Models/VoiceModels.swift +++ b/Source/TextToSpeechV1/Models/VoiceModels.swift @@ -19,7 +19,11 @@ import Foundation /** VoiceModels. */ public struct VoiceModels: Decodable { - /// An array of `VoiceModel` objects that provides information about each available custom voice model. The array is empty if the requesting service credentials own no custom voice models (if no language is specified) or own no custom voice models for the specified language. + /** + An array of `VoiceModel` objects that provides information about each available custom voice model. The array is + empty if the requesting service credentials own no custom voice models (if no language is specified) or own no + custom voice models for the specified language. + */ public var customizations: [VoiceModel] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/TextToSpeechV1/Models/Voices.swift b/Source/TextToSpeechV1/Models/Voices.swift index e1b6e6018..90b3f1004 100644 --- a/Source/TextToSpeechV1/Models/Voices.swift +++ b/Source/TextToSpeechV1/Models/Voices.swift @@ -19,7 +19,9 @@ import Foundation /** Voices. */ public struct Voices: Decodable { - /// A list of available voices. + /** + A list of available voices. + */ public var voices: [Voice] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/TextToSpeechV1/Models/Word.swift b/Source/TextToSpeechV1/Models/Word.swift index 386ee52fe..38e07ca53 100644 --- a/Source/TextToSpeechV1/Models/Word.swift +++ b/Source/TextToSpeechV1/Models/Word.swift @@ -19,7 +19,12 @@ import Foundation /** Word. */ public struct Word: Codable { - /// **Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see [Working with Japanese entries](https://console.bluemix.net/docs/services/text-to-speech/custom-rules.html#jaNotes). + /** + **Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation + for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot + create multiple entries with different parts of speech for the same word. For more information, see [Working with + Japanese entries](https://console.bluemix.net/docs/services/text-to-speech/custom-rules.html#jaNotes). + */ public enum PartOfSpeech: String { case josi = "Josi" case mesi = "Mesi" @@ -40,13 +45,24 @@ public struct Word: Codable { case hoka = "Hoka" } - /// A word from the custom voice model. + /** + A word from the custom voice model. + */ public var word: String - /// The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for representing the phonetic string of a word either as an IPA or IBM SPR translation. A sounds-like translation consists of one or more words that, when combined, sound like the word. + /** + The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for + representing the phonetic string of a word either as an IPA or IBM SPR translation. A sounds-like translation + consists of one or more words that, when combined, sound like the word. + */ public var translation: String - /// **Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see [Working with Japanese entries](https://console.bluemix.net/docs/services/text-to-speech/custom-rules.html#jaNotes). + /** + **Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation + for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot + create multiple entries with different parts of speech for the same word. For more information, see [Working with + Japanese entries](https://console.bluemix.net/docs/services/text-to-speech/custom-rules.html#jaNotes). + */ public var partOfSpeech: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -60,12 +76,23 @@ public struct Word: Codable { Initialize a `Word` with member variables. - parameter word: A word from the custom voice model. - - parameter translation: The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for representing the phonetic string of a word either as an IPA or IBM SPR translation. A sounds-like translation consists of one or more words that, when combined, sound like the word. - - parameter partOfSpeech: **Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see [Working with Japanese entries](https://console.bluemix.net/docs/services/text-to-speech/custom-rules.html#jaNotes). + - parameter translation: The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for + representing the phonetic string of a word either as an IPA or IBM SPR translation. A sounds-like translation + consists of one or more words that, when combined, sound like the word. + - parameter partOfSpeech: **Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation + for the word. You can create only a single entry, with or without a single part of speech, for any word; you + cannot create multiple entries with different parts of speech for the same word. For more information, see + [Working with Japanese + entries](https://console.bluemix.net/docs/services/text-to-speech/custom-rules.html#jaNotes). - returns: An initialized `Word`. */ - public init(word: String, translation: String, partOfSpeech: String? = nil) { + public init( + word: String, + translation: String, + partOfSpeech: String? = nil + ) + { self.word = word self.translation = translation self.partOfSpeech = partOfSpeech diff --git a/Source/TextToSpeechV1/Models/Words.swift b/Source/TextToSpeechV1/Models/Words.swift index f8c93ca2f..a22e5420b 100644 --- a/Source/TextToSpeechV1/Models/Words.swift +++ b/Source/TextToSpeechV1/Models/Words.swift @@ -19,7 +19,13 @@ import Foundation /** Words. */ public struct Words: Codable { - /// The **Add custom words** method accepts an array of `Word` objects. Each object provides a word that is to be added or updated for the custom voice model and the word's translation. The **List custom words** method returns an array of `Word` objects. Each object shows a word and its translation from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if the custom model contains no words. + /** + The **Add custom words** method accepts an array of `Word` objects. Each object provides a word that is to be added + or updated for the custom voice model and the word's translation. + The **List custom words** method returns an array of `Word` objects. Each object shows a word and its translation + from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before + lowercase letters. The array is empty if the custom model contains no words. + */ public var words: [Word] // Map each property name to the key that shall be used for encoding/decoding. @@ -30,11 +36,18 @@ public struct Words: Codable { /** Initialize a `Words` with member variables. - - parameter words: The **Add custom words** method accepts an array of `Word` objects. Each object provides a word that is to be added or updated for the custom voice model and the word's translation. The **List custom words** method returns an array of `Word` objects. Each object shows a word and its translation from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if the custom model contains no words. + - parameter words: The **Add custom words** method accepts an array of `Word` objects. Each object provides a word that is to be + added or updated for the custom voice model and the word's translation. + The **List custom words** method returns an array of `Word` objects. Each object shows a word and its translation + from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before + lowercase letters. The array is empty if the custom model contains no words. - returns: An initialized `Words`. */ - public init(words: [Word]) { + public init( + words: [Word] + ) + { self.words = words } diff --git a/Source/TextToSpeechV1/TextToSpeech.swift b/Source/TextToSpeechV1/TextToSpeech.swift index 06d393a10..c16ec394e 100644 --- a/Source/TextToSpeechV1/TextToSpeech.swift +++ b/Source/TextToSpeechV1/TextToSpeech.swift @@ -189,8 +189,8 @@ public class TextToSpeech { - parameter voice: The voice for which information is to be returned. - parameter customizationID: The customization ID (GUID) of a custom voice model for which information is to be returned. You must make the - request with service credentials created for the instance of the service that owns the custom model. Omit the - parameter to see information about the specified voice with no customization. + request with service credentials created for the instance of the service that owns the custom model. Omit the + parameter to see information about the specified voice with no customization. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -247,22 +247,23 @@ public class TextToSpeech { maximum of 5 KB of text. Use the `Accept` header or the `accept` query parameter to specify the requested format (MIME type) of the response audio. By default, the service uses `audio/ogg;codecs=opus`. For detailed information about the supported audio formats and sampling rates, see [Specifying an audio - format](https://console.bluemix.net/docs/services/text-to-speech/http.html#format). Specify a value of - `application/json` for the `Content-Type` header. If a request includes invalid query parameters, the service - returns a `Warnings` response header that provides messages about the invalid parameters. The warning includes a - descriptive message and a list of invalid argument strings. For example, a message such as `\"Unknown arguments:\"` - or `\"Unknown url query arguments:\"` followed by a list of the form `\"invalid_arg_1, invalid_arg_2.\"` The - request succeeds despite the warnings. + format](https://console.bluemix.net/docs/services/text-to-speech/http.html#format). + If a request includes invalid query parameters, the service returns a `Warnings` response header that provides + messages about the invalid parameters. The warning includes a descriptive message and a list of invalid argument + strings. For example, a message such as `\"Unknown arguments:\"` or `\"Unknown url query arguments:\"` followed by + a list of the form `\"invalid_arg_1, invalid_arg_2.\"` The request succeeds despite the warnings. - parameter text: The text to synthesize. - - parameter accept: The type of the response: audio/basic, audio/flac, audio/l16;rate=nnnn, audio/ogg, audio/ogg;codecs=opus, - audio/ogg;codecs=vorbis, audio/mp3, audio/mpeg, audio/mulaw;rate=nnnn, audio/wav, audio/webm, - audio/webm;codecs=opus, or audio/webm;codecs=vorbis. + - parameter accept: The requested audio format (MIME type) of the audio. You can use the `Accept` header or the `accept` query + parameter to specify the audio format. (For the `audio/l16` format, you can optionally specify + `endianness=big-endian` or `endianness=little-endian`; the default is little endian.) For detailed information + about the supported audio formats and sampling rates, see [Specifying an audio + format](https://console.bluemix.net/docs/services/text-to-speech/http.html#format). - parameter voice: The voice to use for synthesis. - - parameter customizationID: The customization ID (GUID) of a custom voice model to use for the synthesis. If a custom voice model is specified, - it is guaranteed to work only if it matches the language of the indicated voice. You must make the request with - service credentials created for the instance of the service that owns the custom model. Omit the parameter to use - the specified voice with no customization. + - parameter customizationID: The customization ID (GUID) of a custom voice model to use for the synthesis. If a custom voice model is + specified, it is guaranteed to work only if it matches the language of the indicated voice. You must make the + request with service credentials created for the instance of the service that owns the custom model. Omit the + parameter to use the specified voice with no customization. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -359,19 +360,19 @@ public class TextToSpeech { Gets the phonetic pronunciation for the specified word. You can request the pronunciation for a specific format. You can also request the pronunciation for a specific voice to see the default translation for the language of that - voice or for a specific custom voice model to see the translation for that voice model. **Note:** This method is - currently a beta release. + voice or for a specific custom voice model to see the translation for that voice model. + **Note:** This method is currently a beta release. - parameter text: The word for which the pronunciation is requested. - - parameter voice: A voice that specifies the language in which the pronunciation is to be returned. All voices for the same language - (for example, `en-US`) return the same translation. + - parameter voice: A voice that specifies the language in which the pronunciation is to be returned. All voices for the same + language (for example, `en-US`) return the same translation. - parameter format: The phoneme format in which to return the pronunciation. Omit the parameter to obtain the pronunciation in the - default format. - - parameter customizationID: The customization ID (GUID) of a custom voice model for which the pronunciation is to be returned. The language of - a specified custom model must match the language of the specified voice. If the word is not defined in the - specified custom model, the service returns the default translation for the custom model's language. You must make - the request with service credentials created for the instance of the service that owns the custom model. Omit the - parameter to see the translation for the specified voice with no customization. + default format. + - parameter customizationID: The customization ID (GUID) of a custom voice model for which the pronunciation is to be returned. The language + of a specified custom model must match the language of the specified voice. If the word is not defined in the + specified custom model, the service returns the default translation for the custom model's language. You must + make the request with service credentials created for the instance of the service that owns the custom model. + Omit the parameter to see the translation for the specified voice with no customization. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -431,8 +432,8 @@ public class TextToSpeech { Create a custom model. Creates a new empty custom voice model. You must specify a name for the new custom model. You can optionally - specify the language and a description for the new model. Specify a value of `application/json` for the - `Content-Type` header. The model is owned by the instance of the service whose credentials are used to create it. + specify the language and a description for the new model. The model is owned by the instance of the service whose + credentials are used to create it. **Note:** This method is currently a beta release. - parameter name: The name of the new custom voice model. @@ -490,11 +491,11 @@ public class TextToSpeech { Lists metadata such as the name and description for all custom voice models that are owned by an instance of the service. Specify a language to list the voice models for that language only. To see the words in addition to the metadata for a specific voice model, use the **List a custom model** method. You must use credentials for the - instance of the service that owns a model to list information about it. **Note:** This method is currently a beta - release. + instance of the service that owns a model to list information about it. + **Note:** This method is currently a beta release. - - parameter language: The language for which custom voice models that are owned by the requesting service credentials are to be returned. - Omit the parameter to see all custom voice models that are owned by the requester. + - parameter language: The language for which custom voice models that are owned by the requesting service credentials are to be + returned. Omit the parameter to see all custom voice models that are owned by the requester. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -544,16 +545,16 @@ public class TextToSpeech { Updates information for the specified custom voice model. You can update metadata such as the name and description of the voice model. You can also update the words in the model and their translations. Adding a new translation for a word that already exists in a custom model overwrites the word's existing translation. A custom model can contain - no more than 20,000 entries. Specify a value of `application/json` for the `Content-Type` header. You must use - credentials for the instance of the service that owns a model to update it. **Note:** This method is currently a - beta release. + no more than 20,000 entries. You must use credentials for the instance of the service that owns a model to update + it. + **Note:** This method is currently a beta release. - parameter customizationID: The customization ID (GUID) of the custom voice model. You must make the request with service credentials created - for the instance of the service that owns the custom model. + for the instance of the service that owns the custom model. - parameter name: A new name for the custom voice model. - parameter description: A new description for the custom voice model. - parameter words: An array of `Word` objects that provides the words and their translations that are to be added or updated for the - custom voice model. Pass an empty array to make no additions or updates. + custom voice model. Pass an empty array to make no additions or updates. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -611,11 +612,11 @@ public class TextToSpeech { Gets all information about a specified custom voice model. In addition to metadata such as the name and description of the voice model, the output includes the words and their translations as defined in the model. To see just the - metadata for a voice model, use the **List custom models** method. **Note:** This method is currently a beta - release. + metadata for a voice model, use the **List custom models** method. + **Note:** This method is currently a beta release. - parameter customizationID: The customization ID (GUID) of the custom voice model. You must make the request with service credentials created - for the instance of the service that owns the custom model. + for the instance of the service that owns the custom model. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -660,10 +661,11 @@ public class TextToSpeech { Delete a custom model. Deletes the specified custom voice model. You must use credentials for the instance of the service that owns a - model to delete it. **Note:** This method is currently a beta release. + model to delete it. + **Note:** This method is currently a beta release. - parameter customizationID: The customization ID (GUID) of the custom voice model. You must make the request with service credentials created - for the instance of the service that owns the custom model. + for the instance of the service that owns the custom model. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -708,17 +710,17 @@ public class TextToSpeech { Adds one or more words and their translations to the specified custom voice model. Adding a new translation for a word that already exists in a custom model overwrites the word's existing translation. A custom model can contain - no more than 20,000 entries. Specify a value of `application/json` for the `Content-Type` header. You must use - credentials for the instance of the service that owns a model to add words to it. **Note:** This method is - currently a beta release. + no more than 20,000 entries. You must use credentials for the instance of the service that owns a model to add + words to it. + **Note:** This method is currently a beta release. - parameter customizationID: The customization ID (GUID) of the custom voice model. You must make the request with service credentials created - for the instance of the service that owns the custom model. - - parameter words: The **Add custom words** method accepts an array of `Word` objects. Each object provides a word that is to be added - or updated for the custom voice model and the word's translation. The **List custom words** method returns an - array of `Word` objects. Each object shows a word and its translation from the custom voice model. The words are - listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if the - custom model contains no words. + for the instance of the service that owns the custom model. + - parameter words: The **Add custom words** method accepts an array of `Word` objects. Each object provides a word that is to be + added or updated for the custom voice model and the word's translation. + The **List custom words** method returns an array of `Word` objects. Each object shows a word and its translation + from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before + lowercase letters. The array is empty if the custom model contains no words. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -774,10 +776,11 @@ public class TextToSpeech { Lists all of the words and their translations for the specified custom voice model. The output shows the translations as they are defined in the model. You must use credentials for the instance of the service that owns a - model to list its words. **Note:** This method is currently a beta release. + model to list its words. + **Note:** This method is currently a beta release. - parameter customizationID: The customization ID (GUID) of the custom voice model. You must make the request with service credentials created - for the instance of the service that owns the custom model. + for the instance of the service that owns the custom model. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -823,20 +826,21 @@ public class TextToSpeech { Adds a single word and its translation to the specified custom voice model. Adding a new translation for a word that already exists in a custom model overwrites the word's existing translation. A custom model can contain no - more than 20,000 entries. Specify a value of `application/json` for the `Content-Type` header. You must use - credentials for the instance of the service that owns a model to add a word to it. **Note:** This method is - currently a beta release. + more than 20,000 entries. You must use credentials for the instance of the service that owns a model to add a word + to it. + **Note:** This method is currently a beta release. - parameter customizationID: The customization ID (GUID) of the custom voice model. You must make the request with service credentials created - for the instance of the service that owns the custom model. + for the instance of the service that owns the custom model. - parameter word: The word that is to be added or updated for the custom voice model. - parameter translation: The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for - representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A sounds-like - is one or more words that, when combined, sound like the word. + representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A + sounds-like is one or more words that, when combined, sound like the word. - parameter partOfSpeech: **Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation - for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot - create multiple entries with different parts of speech for the same word. For more information, see [Working with - Japanese entries](https://console.bluemix.net/docs/services/text-to-speech/custom-rules.html#jaNotes). + for the word. You can create only a single entry, with or without a single part of speech, for any word; you + cannot create multiple entries with different parts of speech for the same word. For more information, see + [Working with Japanese + entries](https://console.bluemix.net/docs/services/text-to-speech/custom-rules.html#jaNotes). - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -893,10 +897,10 @@ public class TextToSpeech { Gets the translation for a single word from the specified custom model. The output shows the translation as it is defined in the model. You must use credentials for the instance of the service that owns a model to list its words. - **Note:** This method is currently a beta release. + **Note:** This method is currently a beta release. - parameter customizationID: The customization ID (GUID) of the custom voice model. You must make the request with service credentials created - for the instance of the service that owns the custom model. + for the instance of the service that owns the custom model. - parameter word: The word that is to be queried from the custom voice model. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. @@ -943,10 +947,11 @@ public class TextToSpeech { Delete a custom word. Deletes a single word from the specified custom voice model. You must use credentials for the instance of the - service that owns a model to delete its words. **Note:** This method is currently a beta release. + service that owns a model to delete its words. + **Note:** This method is currently a beta release. - parameter customizationID: The customization ID (GUID) of the custom voice model. You must make the request with service credentials created - for the instance of the service that owns the custom model. + for the instance of the service that owns the custom model. - parameter word: The word that is to be deleted from the custom voice model. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. @@ -994,9 +999,10 @@ public class TextToSpeech { Deletes all data that is associated with a specified customer ID. The method deletes all data for the customer ID, regardless of the method by which the information was added. The method has no effect if no data is associated with the customer ID. You must issue the request with credentials for the same instance of the service that was used to - associate the customer ID with the data. You associate a customer ID with data by passing the `X-Watson-Metadata` - header with a request that passes the data. For more information about customer IDs and about using this method, - see [Information security](https://console.bluemix.net/docs/services/text-to-speech/information-security.html). + associate the customer ID with the data. + You associate a customer ID with data by passing the `X-Watson-Metadata` header with a request that passes the + data. For more information about customer IDs and about using this method, see [Information + security](https://console.bluemix.net/docs/services/text-to-speech/information-security.html). - parameter customerID: The customer ID for which all data is to be deleted. - parameter headers: A dictionary of request headers to be sent with this request. diff --git a/Source/ToneAnalyzerV3/Models/DocumentAnalysis.swift b/Source/ToneAnalyzerV3/Models/DocumentAnalysis.swift index bdfd95139..9d2a46309 100644 --- a/Source/ToneAnalyzerV3/Models/DocumentAnalysis.swift +++ b/Source/ToneAnalyzerV3/Models/DocumentAnalysis.swift @@ -19,13 +19,25 @@ import Foundation /** DocumentAnalysis. */ public struct DocumentAnalysis: Decodable { - /// **`2017-09-21`:** An array of `ToneScore` objects that provides the results of the analysis for each qualifying tone of the document. The array includes results for any tone whose score is at least 0.5. The array is empty if no tone has a score that meets this threshold. **`2016-05-19`:** Not returned. + /** + **`2017-09-21`:** An array of `ToneScore` objects that provides the results of the analysis for each qualifying + tone of the document. The array includes results for any tone whose score is at least 0.5. The array is empty if no + tone has a score that meets this threshold. **`2016-05-19`:** Not returned. + */ public var tones: [ToneScore]? - /// **`2017-09-21`:** Not returned. **`2016-05-19`:** An array of `ToneCategory` objects that provides the results of the tone analysis for the full document of the input content. The service returns results only for the tones specified with the `tones` parameter of the request. + /** + **`2017-09-21`:** Not returned. **`2016-05-19`:** An array of `ToneCategory` objects that provides the results of + the tone analysis for the full document of the input content. The service returns results only for the tones + specified with the `tones` parameter of the request. + */ public var toneCategories: [ToneCategory]? - /// **`2017-09-21`:** A warning message if the overall content exceeds 128 KB or contains more than 1000 sentences. The service analyzes only the first 1000 sentences for document-level analysis and the first 100 sentences for sentence-level analysis. **`2016-05-19`:** Not returned. + /** + **`2017-09-21`:** A warning message if the overall content exceeds 128 KB or contains more than 1000 sentences. The + service analyzes only the first 1000 sentences for document-level analysis and the first 100 sentences for + sentence-level analysis. **`2016-05-19`:** Not returned. + */ public var warning: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ToneAnalyzerV3/Models/SentenceAnalysis.swift b/Source/ToneAnalyzerV3/Models/SentenceAnalysis.swift index 888be5699..c08496b42 100644 --- a/Source/ToneAnalyzerV3/Models/SentenceAnalysis.swift +++ b/Source/ToneAnalyzerV3/Models/SentenceAnalysis.swift @@ -19,22 +19,41 @@ import Foundation /** SentenceAnalysis. */ public struct SentenceAnalysis: Decodable { - /// The unique identifier of a sentence of the input content. The first sentence has ID 0, and the ID of each subsequent sentence is incremented by one. + /** + The unique identifier of a sentence of the input content. The first sentence has ID 0, and the ID of each + subsequent sentence is incremented by one. + */ public var sentenceID: Int - /// The text of the input sentence. + /** + The text of the input sentence. + */ public var text: String - /// **`2017-09-21`:** An array of `ToneScore` objects that provides the results of the analysis for each qualifying tone of the sentence. The array includes results for any tone whose score is at least 0.5. The array is empty if no tone has a score that meets this threshold. **`2016-05-19`:** Not returned. + /** + **`2017-09-21`:** An array of `ToneScore` objects that provides the results of the analysis for each qualifying + tone of the sentence. The array includes results for any tone whose score is at least 0.5. The array is empty if no + tone has a score that meets this threshold. **`2016-05-19`:** Not returned. + */ public var tones: [ToneScore]? - /// **`2017-09-21`:** Not returned. **`2016-05-19`:** An array of `ToneCategory` objects that provides the results of the tone analysis for the sentence. The service returns results only for the tones specified with the `tones` parameter of the request. + /** + **`2017-09-21`:** Not returned. **`2016-05-19`:** An array of `ToneCategory` objects that provides the results of + the tone analysis for the sentence. The service returns results only for the tones specified with the `tones` + parameter of the request. + */ public var toneCategories: [ToneCategory]? - /// **`2017-09-21`:** Not returned. **`2016-05-19`:** The offset of the first character of the sentence in the overall input content. + /** + **`2017-09-21`:** Not returned. **`2016-05-19`:** The offset of the first character of the sentence in the overall + input content. + */ public var inputFrom: Int? - /// **`2017-09-21`:** Not returned. **`2016-05-19`:** The offset of the last character of the sentence in the overall input content. + /** + **`2017-09-21`:** Not returned. **`2016-05-19`:** The offset of the last character of the sentence in the overall + input content. + */ public var inputTo: Int? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ToneAnalyzerV3/Models/ToneAnalysis.swift b/Source/ToneAnalyzerV3/Models/ToneAnalysis.swift index a7d13fde0..f55ad537d 100644 --- a/Source/ToneAnalyzerV3/Models/ToneAnalysis.swift +++ b/Source/ToneAnalyzerV3/Models/ToneAnalysis.swift @@ -19,10 +19,16 @@ import Foundation /** ToneAnalysis. */ public struct ToneAnalysis: Decodable { - /// An object of type `DocumentAnalysis` that provides the results of the analysis for the full input document. + /** + An object of type `DocumentAnalysis` that provides the results of the analysis for the full input document. + */ public var documentTone: DocumentAnalysis - /// An array of `SentenceAnalysis` objects that provides the results of the analysis for the individual sentences of the input content. The service returns results only for the first 100 sentences of the input. The field is omitted if the `sentences` parameter of the request is set to `false`. + /** + An array of `SentenceAnalysis` objects that provides the results of the analysis for the individual sentences of + the input content. The service returns results only for the first 100 sentences of the input. The field is omitted + if the `sentences` parameter of the request is set to `false`. + */ public var sentencesTone: [SentenceAnalysis]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ToneAnalyzerV3/Models/ToneCategory.swift b/Source/ToneAnalyzerV3/Models/ToneCategory.swift index 6f4a702ac..4da2cec4a 100644 --- a/Source/ToneAnalyzerV3/Models/ToneCategory.swift +++ b/Source/ToneAnalyzerV3/Models/ToneCategory.swift @@ -19,13 +19,20 @@ import Foundation /** ToneCategory. */ public struct ToneCategory: Decodable { - /// An array of `ToneScore` objects that provides the results for the tones of the category. + /** + An array of `ToneScore` objects that provides the results for the tones of the category. + */ public var tones: [ToneScore] - /// The unique, non-localized identifier of the category for the results. The service can return results for the following category IDs: `emotion_tone`, `language_tone`, and `social_tone`. + /** + The unique, non-localized identifier of the category for the results. The service can return results for the + following category IDs: `emotion_tone`, `language_tone`, and `social_tone`. + */ public var categoryID: String - /// The user-visible, localized name of the category. + /** + The user-visible, localized name of the category. + */ public var categoryName: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ToneAnalyzerV3/Models/ToneChatInput.swift b/Source/ToneAnalyzerV3/Models/ToneChatInput.swift index e247ed690..02208548e 100644 --- a/Source/ToneAnalyzerV3/Models/ToneChatInput.swift +++ b/Source/ToneAnalyzerV3/Models/ToneChatInput.swift @@ -19,7 +19,9 @@ import Foundation /** ToneChatInput. */ public struct ToneChatInput: Encodable { - /// An array of `Utterance` objects that provides the input content that the service is to analyze. + /** + An array of `Utterance` objects that provides the input content that the service is to analyze. + */ public var utterances: [Utterance] // Map each property name to the key that shall be used for encoding/decoding. @@ -34,7 +36,10 @@ public struct ToneChatInput: Encodable { - returns: An initialized `ToneChatInput`. */ - public init(utterances: [Utterance]) { + public init( + utterances: [Utterance] + ) + { self.utterances = utterances } diff --git a/Source/ToneAnalyzerV3/Models/ToneChatScore.swift b/Source/ToneAnalyzerV3/Models/ToneChatScore.swift index 03f2c6df2..c657ae269 100644 --- a/Source/ToneAnalyzerV3/Models/ToneChatScore.swift +++ b/Source/ToneAnalyzerV3/Models/ToneChatScore.swift @@ -19,13 +19,22 @@ import Foundation /** ToneChatScore. */ public struct ToneChatScore: Decodable { - /// The score for the tone in the range of 0.5 to 1. A score greater than 0.75 indicates a high likelihood that the tone is perceived in the utterance. + /** + The score for the tone in the range of 0.5 to 1. A score greater than 0.75 indicates a high likelihood that the + tone is perceived in the utterance. + */ public var score: Double - /// The unique, non-localized identifier of the tone for the results. The service can return results for the following tone IDs: `sad`, `frustrated`, `satisfied`, `excited`, `polite`, `impolite`, and `sympathetic`. The service returns results only for tones whose scores meet a minimum threshold of 0.5. + /** + The unique, non-localized identifier of the tone for the results. The service can return results for the following + tone IDs: `sad`, `frustrated`, `satisfied`, `excited`, `polite`, `impolite`, and `sympathetic`. The service returns + results only for tones whose scores meet a minimum threshold of 0.5. + */ public var toneID: String - /// The user-visible, localized name of the tone. + /** + The user-visible, localized name of the tone. + */ public var toneName: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ToneAnalyzerV3/Models/ToneInput.swift b/Source/ToneAnalyzerV3/Models/ToneInput.swift index 80d27c3ce..c7002e90e 100644 --- a/Source/ToneAnalyzerV3/Models/ToneInput.swift +++ b/Source/ToneAnalyzerV3/Models/ToneInput.swift @@ -19,7 +19,9 @@ import Foundation /** ToneInput. */ public struct ToneInput: Encodable { - /// The input content that the service is to analyze. + /** + The input content that the service is to analyze. + */ public var text: String // Map each property name to the key that shall be used for encoding/decoding. @@ -34,7 +36,10 @@ public struct ToneInput: Encodable { - returns: An initialized `ToneInput`. */ - public init(text: String) { + public init( + text: String + ) + { self.text = text } diff --git a/Source/ToneAnalyzerV3/Models/ToneScore.swift b/Source/ToneAnalyzerV3/Models/ToneScore.swift index 799107ba6..93d9e3869 100644 --- a/Source/ToneAnalyzerV3/Models/ToneScore.swift +++ b/Source/ToneAnalyzerV3/Models/ToneScore.swift @@ -19,13 +19,32 @@ import Foundation /** ToneScore. */ public struct ToneScore: Decodable { - /// The score for the tone. * **`2017-09-21`:** The score that is returned lies in the range of 0.5 to 1. A score greater than 0.75 indicates a high likelihood that the tone is perceived in the content. * **`2016-05-19`:** The score that is returned lies in the range of 0 to 1. A score less than 0.5 indicates that the tone is unlikely to be perceived in the content; a score greater than 0.75 indicates a high likelihood that the tone is perceived. + /** + The score for the tone. + * **`2017-09-21`:** The score that is returned lies in the range of 0.5 to 1. A score greater than 0.75 indicates a + high likelihood that the tone is perceived in the content. + * **`2016-05-19`:** The score that is returned lies in the range of 0 to 1. A score less than 0.5 indicates that + the tone is unlikely to be perceived in the content; a score greater than 0.75 indicates a high likelihood that the + tone is perceived. + */ public var score: Double - /// The unique, non-localized identifier of the tone. * **`2017-09-21`:** The service can return results for the following tone IDs: `anger`, `fear`, `joy`, and `sadness` (emotional tones); `analytical`, `confident`, and `tentative` (language tones). The service returns results only for tones whose scores meet a minimum threshold of 0.5. * **`2016-05-19`:** The service can return results for the following tone IDs of the different categories: for the `emotion` category: `anger`, `disgust`, `fear`, `joy`, and `sadness`; for the `language` category: `analytical`, `confident`, and `tentative`; for the `social` category: `openness_big5`, `conscientiousness_big5`, `extraversion_big5`, `agreeableness_big5`, and `emotional_range_big5`. The service returns scores for all tones of a category, regardless of their values. + /** + The unique, non-localized identifier of the tone. + * **`2017-09-21`:** The service can return results for the following tone IDs: `anger`, `fear`, `joy`, and + `sadness` (emotional tones); `analytical`, `confident`, and `tentative` (language tones). The service returns + results only for tones whose scores meet a minimum threshold of 0.5. + * **`2016-05-19`:** The service can return results for the following tone IDs of the different categories: for the + `emotion` category: `anger`, `disgust`, `fear`, `joy`, and `sadness`; for the `language` category: `analytical`, + `confident`, and `tentative`; for the `social` category: `openness_big5`, `conscientiousness_big5`, + `extraversion_big5`, `agreeableness_big5`, and `emotional_range_big5`. The service returns scores for all tones of + a category, regardless of their values. + */ public var toneID: String - /// The user-visible, localized name of the tone. + /** + The user-visible, localized name of the tone. + */ public var toneName: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ToneAnalyzerV3/Models/Utterance.swift b/Source/ToneAnalyzerV3/Models/Utterance.swift index e4ce3ae7c..c2def2246 100644 --- a/Source/ToneAnalyzerV3/Models/Utterance.swift +++ b/Source/ToneAnalyzerV3/Models/Utterance.swift @@ -19,10 +19,15 @@ import Foundation /** Utterance. */ public struct Utterance: Encodable { - /// An utterance contributed by a user in the conversation that is to be analyzed. The utterance can contain multiple sentences. + /** + An utterance contributed by a user in the conversation that is to be analyzed. The utterance can contain multiple + sentences. + */ public var text: String - /// A string that identifies the user who contributed the utterance specified by the `text` parameter. + /** + A string that identifies the user who contributed the utterance specified by the `text` parameter. + */ public var user: String? // Map each property name to the key that shall be used for encoding/decoding. @@ -34,12 +39,17 @@ public struct Utterance: Encodable { /** Initialize a `Utterance` with member variables. - - parameter text: An utterance contributed by a user in the conversation that is to be analyzed. The utterance can contain multiple sentences. + - parameter text: An utterance contributed by a user in the conversation that is to be analyzed. The utterance can contain multiple + sentences. - parameter user: A string that identifies the user who contributed the utterance specified by the `text` parameter. - returns: An initialized `Utterance`. */ - public init(text: String, user: String? = nil) { + public init( + text: String, + user: String? = nil + ) + { self.text = text self.user = user } diff --git a/Source/ToneAnalyzerV3/Models/UtteranceAnalyses.swift b/Source/ToneAnalyzerV3/Models/UtteranceAnalyses.swift index d7f51a206..298cf4058 100644 --- a/Source/ToneAnalyzerV3/Models/UtteranceAnalyses.swift +++ b/Source/ToneAnalyzerV3/Models/UtteranceAnalyses.swift @@ -19,10 +19,15 @@ import Foundation /** UtteranceAnalyses. */ public struct UtteranceAnalyses: Decodable { - /// An array of `UtteranceAnalysis` objects that provides the results for each utterance of the input. + /** + An array of `UtteranceAnalysis` objects that provides the results for each utterance of the input. + */ public var utterancesTone: [UtteranceAnalysis] - /// **`2017-09-21`:** A warning message if the content contains more than 50 utterances. The service analyzes only the first 50 utterances. **`2016-05-19`:** Not returned. + /** + **`2017-09-21`:** A warning message if the content contains more than 50 utterances. The service analyzes only the + first 50 utterances. **`2016-05-19`:** Not returned. + */ public var warning: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ToneAnalyzerV3/Models/UtteranceAnalysis.swift b/Source/ToneAnalyzerV3/Models/UtteranceAnalysis.swift index b0d384958..d7060c0db 100644 --- a/Source/ToneAnalyzerV3/Models/UtteranceAnalysis.swift +++ b/Source/ToneAnalyzerV3/Models/UtteranceAnalysis.swift @@ -19,16 +19,28 @@ import Foundation /** UtteranceAnalysis. */ public struct UtteranceAnalysis: Decodable { - /// The unique identifier of the utterance. The first utterance has ID 0, and the ID of each subsequent utterance is incremented by one. + /** + The unique identifier of the utterance. The first utterance has ID 0, and the ID of each subsequent utterance is + incremented by one. + */ public var utteranceID: Int - /// The text of the utterance. + /** + The text of the utterance. + */ public var utteranceText: String - /// An array of `ToneChatScore` objects that provides results for the most prevalent tones of the utterance. The array includes results for any tone whose score is at least 0.5. The array is empty if no tone has a score that meets this threshold. + /** + An array of `ToneChatScore` objects that provides results for the most prevalent tones of the utterance. The array + includes results for any tone whose score is at least 0.5. The array is empty if no tone has a score that meets + this threshold. + */ public var tones: [ToneChatScore] - /// **`2017-09-21`:** An error message if the utterance contains more than 500 characters. The service does not analyze the utterance. **`2016-05-19`:** Not returned. + /** + **`2017-09-21`:** An error message if the utterance contains more than 500 characters. The service does not analyze + the utterance. **`2016-05-19`:** Not returned. + */ public var error: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/ToneAnalyzerV3/ToneAnalyzer.swift b/Source/ToneAnalyzerV3/ToneAnalyzer.swift index e20cbafc1..2535d67ad 100644 --- a/Source/ToneAnalyzerV3/ToneAnalyzer.swift +++ b/Source/ToneAnalyzerV3/ToneAnalyzer.swift @@ -17,9 +17,9 @@ import Foundation /** - The IBM Watson Tone Analyzer service uses linguistic analysis to detect emotional and language tones in written text. - The service can analyze tone at both the document and sentence levels. You can use the service to understand how your - written communications are perceived and then to improve the tone of your communications. Businesses can use the + The IBM Watson™ Tone Analyzer service uses linguistic analysis to detect emotional and language tones in written + text. The service can analyze tone at both the document and sentence levels. You can use the service to understand how + your written communications are perceived and then to improve the tone of your communications. Businesses can use the service to learn the tone of their customers' communications and to respond to each customer appropriately, or to understand and improve their customer conversations. **Note:** Request logging is disabled for the Tone Analyzer service. The service neither logs nor retains data from @@ -123,30 +123,33 @@ public class ToneAnalyzer { Use the general purpose endpoint to analyze the tone of your input content. The service analyzes the content for emotional and language tones. The method always analyzes the tone of the full document; by default, it also - analyzes the tone of each individual sentence of the content. You can submit no more than 128 KB of total input - content and no more than 1000 individual sentences in JSON, plain text, or HTML format. The service analyzes the - first 1000 sentences for document-level analysis and only the first 100 sentences for sentence-level analysis. + analyzes the tone of each individual sentence of the content. + You can submit no more than 128 KB of total input content and no more than 1000 individual sentences in JSON, plain + text, or HTML format. The service analyzes the first 1000 sentences for document-level analysis and only the first + 100 sentences for sentence-level analysis. Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content type of plain text or HTML, include the `charset` parameter to indicate the character encoding of the input text; for example: `Content-Type: text/plain;charset=utf-8`. For `text/html`, the service removes HTML tags and analyzes only the textual content. - - parameter toneInput: The content to be analyzed. + - parameter toneInput: JSON input that contains the content to be analyzed. - parameter sentences: Indicates whether the service is to return an analysis of each individual sentence in addition to its analysis of - the full document. If `true` (the default), the service returns results for each sentence. + the full document. If `true` (the default), the service returns results for each sentence. - parameter tones: **`2017-09-21`:** Deprecated. The service continues to accept the parameter for backward-compatibility, but the - parameter no longer affects the response. **`2016-05-19`:** A comma-separated list of tones for which the service - is to return its analysis of the input; the indicated tones apply both to the full document and to individual - sentences of the document. You can specify one or more of the valid values. Omit the parameter to request results - for all three tones. + parameter no longer affects the response. + **`2016-05-19`:** A comma-separated list of tones for which the service is to return its analysis of the input; + the indicated tones apply both to the full document and to individual sentences of the document. You can specify + one or more of the valid values. Omit the parameter to request results for all three tones. - parameter contentLanguage: The language of the input text for the request: English or French. Regional variants are treated as their parent - language; for example, `en-US` is interpreted as `en`. The input content must match the specified language. Do not - submit content that contains both languages. You can use different languages for **Content-Language** and - **Accept-Language**. * **`2017-09-21`:** Accepts `en` or `fr`. * **`2016-05-19`:** Accepts only `en`. + language; for example, `en-US` is interpreted as `en`. The input content must match the specified language. Do + not submit content that contains both languages. You can use different languages for **Content-Language** and + **Accept-Language**. + * **`2017-09-21`:** Accepts `en` or `fr`. + * **`2016-05-19`:** Accepts only `en`. - parameter acceptLanguage: The desired language of the response. For two-character arguments, regional variants are treated as their parent - language; for example, `en-US` is interpreted as `en`. You can use different languages for **Content-Language** and - **Accept-Language**. + language; for example, `en-US` is interpreted as `en`. You can use different languages for **Content-Language** + and **Accept-Language**. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -218,30 +221,33 @@ public class ToneAnalyzer { Use the general purpose endpoint to analyze the tone of your input content. The service analyzes the content for emotional and language tones. The method always analyzes the tone of the full document; by default, it also - analyzes the tone of each individual sentence of the content. You can submit no more than 128 KB of total input - content and no more than 1000 individual sentences in JSON, plain text, or HTML format. The service analyzes the - first 1000 sentences for document-level analysis and only the first 100 sentences for sentence-level analysis. + analyzes the tone of each individual sentence of the content. + You can submit no more than 128 KB of total input content and no more than 1000 individual sentences in JSON, plain + text, or HTML format. The service analyzes the first 1000 sentences for document-level analysis and only the first + 100 sentences for sentence-level analysis. Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content type of plain text or HTML, include the `charset` parameter to indicate the character encoding of the input text; for example: `Content-Type: text/plain;charset=utf-8`. For `text/html`, the service removes HTML tags and analyzes only the textual content. - - parameter text: The content to be analyzed. + - parameter text: plain text input that contains the content to be analyzed. - parameter sentences: Indicates whether the service is to return an analysis of each individual sentence in addition to its analysis of the full document. If `true` (the default), the service returns results for each sentence. - parameter tones: **`2017-09-21`:** Deprecated. The service continues to accept the parameter for backward-compatibility, but the - parameter no longer affects the response. **`2016-05-19`:** A comma-separated list of tones for which the service - is to return its analysis of the input; the indicated tones apply both to the full document and to individual - sentences of the document. You can specify one or more of the valid values. Omit the parameter to request results - for all three tones. + parameter no longer affects the response. + **`2016-05-19`:** A comma-separated list of tones for which the service is to return its analysis of the input; + the indicated tones apply both to the full document and to individual sentences of the document. You can specify + one or more of the valid values. Omit the parameter to request results for all three tones. - parameter contentLanguage: The language of the input text for the request: English or French. Regional variants are treated as their parent - language; for example, `en-US` is interpreted as `en`. The input content must match the specified language. Do not - submit content that contains both languages. You can use different languages for **Content-Language** and - **Accept-Language**. * **`2017-09-21`:** Accepts `en` or `fr`. * **`2016-05-19`:** Accepts only `en`. - - parameter acceptLanguage: The desired language of the response. For two-character arguments, regional variants are treated as their parent - language; for example, `en-US` is interpreted as `en`. You can use different languages for **Content-Language** and + language; for example, `en-US` is interpreted as `en`. The input content must match the specified language. Do + not submit content that contains both languages. You can use different languages for **Content-Language** and **Accept-Language**. + * **`2017-09-21`:** Accepts `en` or `fr`. + * **`2016-05-19`:** Accepts only `en`. + - parameter acceptLanguage: The desired language of the response. For two-character arguments, regional variants are treated as their parent + language; for example, `en-US` is interpreted as `en`. You can use different languages for **Content-Language** + and **Accept-Language**. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -313,30 +319,33 @@ public class ToneAnalyzer { Use the general purpose endpoint to analyze the tone of your input content. The service analyzes the content for emotional and language tones. The method always analyzes the tone of the full document; by default, it also - analyzes the tone of each individual sentence of the content. You can submit no more than 128 KB of total input - content and no more than 1000 individual sentences in JSON, plain text, or HTML format. The service analyzes the - first 1000 sentences for document-level analysis and only the first 100 sentences for sentence-level analysis. + analyzes the tone of each individual sentence of the content. + You can submit no more than 128 KB of total input content and no more than 1000 individual sentences in JSON, plain + text, or HTML format. The service analyzes the first 1000 sentences for document-level analysis and only the first + 100 sentences for sentence-level analysis. Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content type of plain text or HTML, include the `charset` parameter to indicate the character encoding of the input text; for example: `Content-Type: text/plain;charset=utf-8`. For `text/html`, the service removes HTML tags and analyzes only the textual content. - - parameter html: The content to be analyzed. + - parameter html: HTML input that contains the content to be analyzed. - parameter sentences: Indicates whether the service is to return an analysis of each individual sentence in addition to its analysis of the full document. If `true` (the default), the service returns results for each sentence. - parameter tones: **`2017-09-21`:** Deprecated. The service continues to accept the parameter for backward-compatibility, but the - parameter no longer affects the response. **`2016-05-19`:** A comma-separated list of tones for which the service - is to return its analysis of the input; the indicated tones apply both to the full document and to individual - sentences of the document. You can specify one or more of the valid values. Omit the parameter to request results - for all three tones. + parameter no longer affects the response. + **`2016-05-19`:** A comma-separated list of tones for which the service is to return its analysis of the input; + the indicated tones apply both to the full document and to individual sentences of the document. You can specify + one or more of the valid values. Omit the parameter to request results for all three tones. - parameter contentLanguage: The language of the input text for the request: English or French. Regional variants are treated as their parent - language; for example, `en-US` is interpreted as `en`. The input content must match the specified language. Do not - submit content that contains both languages. You can use different languages for **Content-Language** and - **Accept-Language**. * **`2017-09-21`:** Accepts `en` or `fr`. * **`2016-05-19`:** Accepts only `en`. - - parameter acceptLanguage: The desired language of the response. For two-character arguments, regional variants are treated as their parent - language; for example, `en-US` is interpreted as `en`. You can use different languages for **Content-Language** and + language; for example, `en-US` is interpreted as `en`. The input content must match the specified language. Do + not submit content that contains both languages. You can use different languages for **Content-Language** and **Accept-Language**. + * **`2017-09-21`:** Accepts `en` or `fr`. + * **`2016-05-19`:** Accepts only `en`. + - parameter acceptLanguage: The desired language of the response. For two-character arguments, regional variants are treated as their parent + language; for example, `en-US` is interpreted as `en`. You can use different languages for **Content-Language** + and **Accept-Language**. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -408,20 +417,23 @@ public class ToneAnalyzer { Use the customer engagement endpoint to analyze the tone of customer service and customer support conversations. For each utterance of a conversation, the method reports the most prevalent subset of the following seven tones: - sad, frustrated, satisfied, excited, polite, impolite, and sympathetic. If you submit more than 50 utterances, - the service returns a warning for the overall content and analyzes only the first 50 utterances. If you submit a - single utterance that contains more than 500 characters, the service returns an error for that utterance and does - not analyze the utterance. The request fails if all utterances have more than 500 characters. Per the JSON - specification, the default character encoding for JSON content is effectively always UTF-8. + sad, frustrated, satisfied, excited, polite, impolite, and sympathetic. + If you submit more than 50 utterances, the service returns a warning for the overall content and analyzes only the + first 50 utterances. If you submit a single utterance that contains more than 500 characters, the service returns + an error for that utterance and does not analyze the utterance. The request fails if all utterances have more than + 500 characters. + Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8. - parameter utterances: An array of `Utterance` objects that provides the input content that the service is to analyze. - parameter contentLanguage: The language of the input text for the request: English or French. Regional variants are treated as their parent - language; for example, `en-US` is interpreted as `en`. The input content must match the specified language. Do not - submit content that contains both languages. You can use different languages for **Content-Language** and - **Accept-Language**. * **`2017-09-21`:** Accepts `en` or `fr`. * **`2016-05-19`:** Accepts only `en`. + language; for example, `en-US` is interpreted as `en`. The input content must match the specified language. Do + not submit content that contains both languages. You can use different languages for **Content-Language** and + **Accept-Language**. + * **`2017-09-21`:** Accepts `en` or `fr`. + * **`2016-05-19`:** Accepts only `en`. - parameter acceptLanguage: The desired language of the response. For two-character arguments, regional variants are treated as their parent - language; for example, `en-US` is interpreted as `en`. You can use different languages for **Content-Language** and - **Accept-Language**. + language; for example, `en-US` is interpreted as `en`. You can use different languages for **Content-Language** + and **Accept-Language**. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. diff --git a/Source/VisualRecognitionV3/Models/Class.swift b/Source/VisualRecognitionV3/Models/Class.swift index 47bd64f07..8c7388909 100644 --- a/Source/VisualRecognitionV3/Models/Class.swift +++ b/Source/VisualRecognitionV3/Models/Class.swift @@ -19,7 +19,9 @@ import Foundation /** A category within a classifier. */ public struct Class: Decodable { - /// The name of the class. + /** + The name of the class. + */ public var className: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/VisualRecognitionV3/Models/ClassResult.swift b/Source/VisualRecognitionV3/Models/ClassResult.swift index 7d510ebb7..50762f02b 100644 --- a/Source/VisualRecognitionV3/Models/ClassResult.swift +++ b/Source/VisualRecognitionV3/Models/ClassResult.swift @@ -19,13 +19,21 @@ import Foundation /** Result of a class within a classifier. */ public struct ClassResult: Decodable { - /// Name of the class. + /** + Name of the class. + */ public var className: String - /// Confidence score for the property in the range of 0 to 1. A higher score indicates greater likelihood that the class is depicted in the image. The default threshold for returning scores from a classifier is 0.5. + /** + Confidence score for the property in the range of 0 to 1. A higher score indicates greater likelihood that the + class is depicted in the image. The default threshold for returning scores from a classifier is 0.5. + */ public var score: Double? - /// Knowledge graph of the property. For example, `/fruit/pome/apple/eating apple/Granny Smith`. Included only if identified. + /** + Knowledge graph of the property. For example, `/fruit/pome/apple/eating apple/Granny Smith`. Included only if + identified. + */ public var typeHierarchy: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/VisualRecognitionV3/Models/ClassifiedImage.swift b/Source/VisualRecognitionV3/Models/ClassifiedImage.swift index c65f1e9d2..66b2986b5 100644 --- a/Source/VisualRecognitionV3/Models/ClassifiedImage.swift +++ b/Source/VisualRecognitionV3/Models/ClassifiedImage.swift @@ -19,19 +19,30 @@ import Foundation /** Results for one image. */ public struct ClassifiedImage: Decodable { - /// Source of the image before any redirects. Not returned when the image is uploaded. + /** + Source of the image before any redirects. Not returned when the image is uploaded. + */ public var sourceUrl: String? - /// Fully resolved URL of the image after redirects are followed. Not returned when the image is uploaded. + /** + Fully resolved URL of the image after redirects are followed. Not returned when the image is uploaded. + */ public var resolvedUrl: String? - /// Relative path of the image file if uploaded directly. Not returned when the image is passed by URL. + /** + Relative path of the image file if uploaded directly. Not returned when the image is passed by URL. + */ public var image: String? - /// Information about what might have caused a failure, such as an image that is too large. Not returned when there is no error. + /** + Information about what might have caused a failure, such as an image that is too large. Not returned when there is + no error. + */ public var error: ErrorInfo? - /// The classifiers. + /** + The classifiers. + */ public var classifiers: [ClassifierResult] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/VisualRecognitionV3/Models/ClassifiedImages.swift b/Source/VisualRecognitionV3/Models/ClassifiedImages.swift index 2b2c3f0d3..56325c561 100644 --- a/Source/VisualRecognitionV3/Models/ClassifiedImages.swift +++ b/Source/VisualRecognitionV3/Models/ClassifiedImages.swift @@ -19,16 +19,26 @@ import Foundation /** Results for all images. */ public struct ClassifiedImages: Decodable { - /// Number of custom classes identified in the images. + /** + Number of custom classes identified in the images. + */ public var customClasses: Int? - /// Number of images processed for the API call. + /** + Number of images processed for the API call. + */ public var imagesProcessed: Int? - /// Classified images. + /** + Classified images. + */ public var images: [ClassifiedImage] - /// Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file and a list of image URLs will still complete, but does not return the expected output. Not returned when there is no warning. + /** + Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file + and a list of image URLs will still complete, but does not return the expected output. Not returned when there is + no warning. + */ public var warnings: [WarningInfo]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/VisualRecognitionV3/Models/Classifier.swift b/Source/VisualRecognitionV3/Models/Classifier.swift index 007d5fb88..0a0bdc764 100644 --- a/Source/VisualRecognitionV3/Models/Classifier.swift +++ b/Source/VisualRecognitionV3/Models/Classifier.swift @@ -19,7 +19,9 @@ import Foundation /** Information about a classifier. */ public struct Classifier: Decodable { - /// Training status of classifier. + /** + Training status of classifier. + */ public enum Status: String { case ready = "ready" case training = "training" @@ -27,34 +29,57 @@ public struct Classifier: Decodable { case failed = "failed" } - /// ID of a classifier identified in the image. + /** + ID of a classifier identified in the image. + */ public var classifierID: String - /// Name of the classifier. + /** + Name of the classifier. + */ public var name: String - /// Unique ID of the account who owns the classifier. Returned when verbose=`true`. Might not be returned by some requests. + /** + Unique ID of the account who owns the classifier. Returned when verbose=`true`. Might not be returned by some + requests. + */ public var owner: String? - /// Training status of classifier. + /** + Training status of classifier. + */ public var status: String? - /// Whether the classifier can be downloaded as a Core ML model after the training status is `ready`. - public var coreMlEnabled: Bool + /** + Whether the classifier can be downloaded as a Core ML model after the training status is `ready`. + */ + public var coreMlEnabled: Bool? - /// If classifier training has failed, this field may explain why. + /** + If classifier training has failed, this field may explain why. + */ public var explanation: String? - /// Date and time in Coordinated Universal Time (UTC) that the classifier was created. + /** + Date and time in Coordinated Universal Time (UTC) that the classifier was created. + */ public var created: String? - /// Classes that define a classifier. + /** + Classes that define a classifier. + */ public var classes: [Class]? - /// Date and time in Coordinated Universal Time (UTC) that the classifier was updated. Returned when verbose=`true`. Might not be returned by some requests. Identical to `updated` and retained for backward compatibility. + /** + Date and time in Coordinated Universal Time (UTC) that the classifier was updated. Returned when verbose=`true`. + Might not be returned by some requests. Identical to `updated` and retained for backward compatibility. + */ public var retrained: String? - /// Date and time in Coordinated Universal Time (UTC) that the classifier was most recently updated. The field matches either `retrained` or `created`. Returned when verbose=`true`. Might not be returned by some requests. + /** + Date and time in Coordinated Universal Time (UTC) that the classifier was most recently updated. The field matches + either `retrained` or `created`. Returned when verbose=`true`. Might not be returned by some requests. + */ public var updated: String? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/VisualRecognitionV3/Models/ClassifierResult.swift b/Source/VisualRecognitionV3/Models/ClassifierResult.swift index b58f87d95..9297da8f8 100644 --- a/Source/VisualRecognitionV3/Models/ClassifierResult.swift +++ b/Source/VisualRecognitionV3/Models/ClassifierResult.swift @@ -19,13 +19,19 @@ import Foundation /** Classifier and score combination. */ public struct ClassifierResult: Decodable { - /// Name of the classifier. + /** + Name of the classifier. + */ public var name: String - /// ID of a classifier identified in the image. + /** + ID of a classifier identified in the image. + */ public var classifierID: String - /// Classes within the classifier. + /** + Classes within the classifier. + */ public var classes: [ClassResult] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/VisualRecognitionV3/Models/Classifiers.swift b/Source/VisualRecognitionV3/Models/Classifiers.swift index da84ccf6f..571212975 100644 --- a/Source/VisualRecognitionV3/Models/Classifiers.swift +++ b/Source/VisualRecognitionV3/Models/Classifiers.swift @@ -19,7 +19,9 @@ import Foundation /** A container for the list of classifiers. */ public struct Classifiers: Decodable { - /// List of classifiers. + /** + List of classifiers. + */ public var classifiers: [Classifier] // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/VisualRecognitionV3/Models/DetectedFaces.swift b/Source/VisualRecognitionV3/Models/DetectedFaces.swift index a76e13a92..86b217d4e 100644 --- a/Source/VisualRecognitionV3/Models/DetectedFaces.swift +++ b/Source/VisualRecognitionV3/Models/DetectedFaces.swift @@ -19,13 +19,21 @@ import Foundation /** Results for all faces. */ public struct DetectedFaces: Decodable { - /// Number of images processed for the API call. + /** + Number of images processed for the API call. + */ public var imagesProcessed: Int? - /// The images. + /** + The images. + */ public var images: [ImageWithFaces] - /// Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file and a list of image URLs will still complete, but does not return the expected output. Not returned when there is no warning. + /** + Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file + and a list of image URLs will still complete, but does not return the expected output. Not returned when there is + no warning. + */ public var warnings: [WarningInfo]? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/VisualRecognitionV3/Models/ErrorInfo.swift b/Source/VisualRecognitionV3/Models/ErrorInfo.swift index 3822d641b..7ab2c79f8 100644 --- a/Source/VisualRecognitionV3/Models/ErrorInfo.swift +++ b/Source/VisualRecognitionV3/Models/ErrorInfo.swift @@ -19,13 +19,19 @@ import Foundation /** Information about what might have caused a failure, such as an image that is too large. Not returned when there is no error. */ public struct ErrorInfo: Decodable { - /// HTTP status code. + /** + HTTP status code. + */ public var code: Int - /// Human-readable error description. For example, `File size limit exceeded`. + /** + Human-readable error description. For example, `File size limit exceeded`. + */ public var description: String - /// Codified error string. For example, `limit_exceeded`. + /** + Codified error string. For example, `limit_exceeded`. + */ public var errorID: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/VisualRecognitionV3/Models/Face.swift b/Source/VisualRecognitionV3/Models/Face.swift index cb25414d1..fcf515c38 100644 --- a/Source/VisualRecognitionV3/Models/Face.swift +++ b/Source/VisualRecognitionV3/Models/Face.swift @@ -19,15 +19,22 @@ import Foundation /** Information about the face. */ public struct Face: Decodable { - /// Age information about a face. + /** + Age information about a face. + */ public var age: FaceAge? - /// Information about the gender of the face. + /** + Information about the gender of the face. + */ public var gender: FaceGender? - /// The location of the bounding box around the face. + /** + The location of the bounding box around the face. + */ public var faceLocation: FaceLocation? + /** deprecated */ public var identity: FaceIdentity? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/VisualRecognitionV3/Models/FaceAge.swift b/Source/VisualRecognitionV3/Models/FaceAge.swift index e0e0a8d84..3a7966751 100644 --- a/Source/VisualRecognitionV3/Models/FaceAge.swift +++ b/Source/VisualRecognitionV3/Models/FaceAge.swift @@ -19,13 +19,20 @@ import Foundation /** Age information about a face. */ public struct FaceAge: Decodable { - /// Estimated minimum age. + /** + Estimated minimum age. + */ public var min: Int? - /// Estimated maximum age. + /** + Estimated maximum age. + */ public var max: Int? - /// Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the property. + /** + Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the + property. + */ public var score: Double? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/VisualRecognitionV3/Models/FaceGender.swift b/Source/VisualRecognitionV3/Models/FaceGender.swift index 7ca4d8d7d..964c88531 100644 --- a/Source/VisualRecognitionV3/Models/FaceGender.swift +++ b/Source/VisualRecognitionV3/Models/FaceGender.swift @@ -19,10 +19,15 @@ import Foundation /** Information about the gender of the face. */ public struct FaceGender: Decodable { - /// Gender identified by the face. For example, `MALE` or `FEMALE`. + /** + Gender identified by the face. For example, `MALE` or `FEMALE`. + */ public var gender: String - /// Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the property. + /** + Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the + property. + */ public var score: Double? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/VisualRecognitionV3/Models/FaceLocation.swift b/Source/VisualRecognitionV3/Models/FaceLocation.swift index b4436d99d..08e71077d 100644 --- a/Source/VisualRecognitionV3/Models/FaceLocation.swift +++ b/Source/VisualRecognitionV3/Models/FaceLocation.swift @@ -19,16 +19,24 @@ import Foundation /** The location of the bounding box around the face. */ public struct FaceLocation: Decodable { - /// Width in pixels of face region. + /** + Width in pixels of face region. + */ public var width: Double - /// Height in pixels of face region. + /** + Height in pixels of face region. + */ public var height: Double - /// X-position of top-left pixel of face region. + /** + X-position of top-left pixel of face region. + */ public var left: Double - /// Y-position of top-left pixel of face region. + /** + Y-position of top-left pixel of face region. + */ public var top: Double // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/VisualRecognitionV3/Models/ImageWithFaces.swift b/Source/VisualRecognitionV3/Models/ImageWithFaces.swift index f23496a7d..af66086d2 100644 --- a/Source/VisualRecognitionV3/Models/ImageWithFaces.swift +++ b/Source/VisualRecognitionV3/Models/ImageWithFaces.swift @@ -19,19 +19,30 @@ import Foundation /** Information about faces in the image. */ public struct ImageWithFaces: Decodable { - /// Faces detected in the images. + /** + Faces detected in the images. + */ public var faces: [Face] - /// Relative path of the image file if uploaded directly. Not returned when the image is passed by URL. + /** + Relative path of the image file if uploaded directly. Not returned when the image is passed by URL. + */ public var image: String? - /// Source of the image before any redirects. Not returned when the image is uploaded. + /** + Source of the image before any redirects. Not returned when the image is uploaded. + */ public var sourceUrl: String? - /// Fully resolved URL of the image after redirects are followed. Not returned when the image is uploaded. + /** + Fully resolved URL of the image after redirects are followed. Not returned when the image is uploaded. + */ public var resolvedUrl: String? - /// Information about what might have caused a failure, such as an image that is too large. Not returned when there is no error. + /** + Information about what might have caused a failure, such as an image that is too large. Not returned when there is + no error. + */ public var error: ErrorInfo? // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/VisualRecognitionV3/Models/WarningInfo.swift b/Source/VisualRecognitionV3/Models/WarningInfo.swift index e2e0e5360..3432dccc3 100644 --- a/Source/VisualRecognitionV3/Models/WarningInfo.swift +++ b/Source/VisualRecognitionV3/Models/WarningInfo.swift @@ -19,10 +19,14 @@ import Foundation /** Information about something that went wrong. */ public struct WarningInfo: Decodable { - /// Codified warning string, such as `limit_reached`. + /** + Codified warning string, such as `limit_reached`. + */ public var warningID: String - /// Information about the error. + /** + Information about the error. + */ public var description: String // Map each property name to the key that shall be used for encoding/decoding. diff --git a/Source/VisualRecognitionV3/VisualRecognition.swift b/Source/VisualRecognitionV3/VisualRecognition.swift index 7eb73ba99..08abd3aa8 100644 --- a/Source/VisualRecognitionV3/VisualRecognition.swift +++ b/Source/VisualRecognitionV3/VisualRecognition.swift @@ -17,8 +17,8 @@ import Foundation /** - The IBM Watson Visual Recognition service uses deep learning algorithms to identify scenes, objects, and faces in - images you upload to the service. You can create and train a custom classifier to identify subjects that suit your + The IBM Watson™ Visual Recognition service uses deep learning algorithms to identify scenes, objects, and faces + in images you upload to the service. You can create and train a custom classifier to identify subjects that suit your needs. */ public class VisualRecognition { @@ -141,27 +141,30 @@ public class VisualRecognition { Classify images with built-in or custom classifiers. - parameter imagesFile: An image file (.jpg, .png) or .zip file with images. Maximum image size is 10 MB. Include no more than 20 images - and limit the .zip file to 100 MB. Encode the image and .zip file names in UTF-8 if they contain non-ASCII - characters. The service assumes UTF-8 encoding if it encounters non-ASCII characters. You can also include an - image with the **url** parameter. + and limit the .zip file to 100 MB. Encode the image and .zip file names in UTF-8 if they contain non-ASCII + characters. The service assumes UTF-8 encoding if it encounters non-ASCII characters. + You can also include an image with the **url** parameter. - parameter acceptLanguage: The language of the output class names. The full set of languages is supported only for the built-in `default` - classifier ID. The class names of custom classifiers are not translated. The response might not be in the - specified language when the requested language is not supported or when there is no translation for the class name. + classifier ID. The class names of custom classifiers are not translated. + The response might not be in the specified language when the requested language is not supported or when there is + no translation for the class name. - parameter url: The URL of an image to analyze. Must be in .jpg, or .png format. The minimum recommended pixel density is 32X32 - pixels per inch, and the maximum image size is 10 MB. You can also include images with the **images_file** - parameter. + pixels per inch, and the maximum image size is 10 MB. + You can also include images with the **images_file** parameter. - parameter threshold: The minimum score a class must have to be displayed in the response. Set the threshold to `0.0` to ignore the - classification score and return all values. + classification score and return all values. - parameter owners: The categories of classifiers to apply. Use `IBM` to classify against the `default` general classifier, and use - `me` to classify against your custom classifiers. To analyze the image against both classifier categories, set the - value to both `IBM` and `me`. The built-in `default` classifier is used if both **classifier_ids** and **owners** - parameters are empty. The **classifier_ids** parameter overrides **owners**, so make sure that **classifier_ids** - is empty. - - parameter classifierIDs: Which classifiers to apply. Overrides the **owners** parameter. You can specify both custom and built-in classifier - IDs. The built-in `default` classifier is used if both **classifier_ids** and **owners** parameters are empty. The - following built-in classifier IDs require no training: - `default`: Returns classes from thousands of general tags. - - `food`: (Beta) Enhances specificity and accuracy for images of food items. - `explicit`: (Beta) Evaluates whether - the image might be pornographic. + `me` to classify against your custom classifiers. To analyze the image against both classifier categories, set + the value to both `IBM` and `me`. + The built-in `default` classifier is used if both **classifier_ids** and **owners** parameters are empty. + The **classifier_ids** parameter overrides **owners**, so make sure that **classifier_ids** is empty. + - parameter classifierIDs: Which classifiers to apply. Overrides the **owners** parameter. You can specify both custom and built-in + classifier IDs. The built-in `default` classifier is used if both **classifier_ids** and **owners** parameters + are empty. + The following built-in classifier IDs require no training: + - `default`: Returns classes from thousands of general tags. + - `food`: (Beta) Enhances specificity and accuracy for images of food items. + - `explicit`: (Beta) Evaluates whether the image might be pornographic. - parameter imagesFileContentType: The content type of imagesFile. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. @@ -257,19 +260,23 @@ public class VisualRecognition { **Important:** On April 2, 2018, the identity information in the response to calls to the Face model was removed. The identity information refers to the `name` of the person, `score`, and `type_hierarchy` knowledge graph. For details about the enhanced Face model, see the [Release - notes](https://console.bluemix.net/docs/services/visual-recognition/release-notes.html#2april2018). Analyze and - get data about faces in images. Responses can include estimated age and gender. This feature uses a built-in model, - so no training is necessary. The Detect faces method does not support general biometric facial recognition. + notes](https://console.bluemix.net/docs/services/visual-recognition/release-notes.html#2april2018). + Analyze and get data about faces in images. Responses can include estimated age and gender. This feature uses a + built-in model, so no training is necessary. The Detect faces method does not support general biometric facial + recognition. Supported image formats include .gif, .jpg, .png, and .tif. The maximum image size is 10 MB. The minimum recommended pixel density is 32X32 pixels per inch. - parameter imagesFile: An image file (gif, .jpg, .png, .tif.) or .zip file with images. Limit the .zip file to 100 MB. You can include a - maximum of 15 images in a request. Encode the image and .zip file names in UTF-8 if they contain non-ASCII - characters. The service assumes UTF-8 encoding if it encounters non-ASCII characters. You can also include an - image with the **url** parameter. - - parameter url: The URL of an image to analyze. Must be in .gif, .jpg, .png, or .tif format. The minimum recommended pixel density - is 32X32 pixels per inch, and the maximum image size is 10 MB. Redirects are followed, so you can use a shortened - URL. You can also include images with the **images_file** parameter. + maximum of 15 images in a request. + Encode the image and .zip file names in UTF-8 if they contain non-ASCII characters. The service assumes UTF-8 + encoding if it encounters non-ASCII characters. + You can also include an image with the **url** parameter. + - parameter url: The URL of an image to analyze. Must be in .gif, .jpg, .png, or .tif format. The minimum recommended pixel + density is 32X32 pixels per inch, and the maximum image size is 10 MB. Redirects are followed, so you can use a + shortened URL. + You can also include images with the **images_file** parameter. + - parameter imagesFileContentType: The content type of imagesFile. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -335,17 +342,20 @@ public class VisualRecognition { Train a new multi-faceted classifier on the uploaded image data. Create your custom classifier with positive or negative examples. Include at least two sets of examples, either two positive example files or one positive and one - negative file. You can upload a maximum of 256 MB per call. Encode all names in UTF-8 if they contain non-ASCII - characters (.zip and image file names, and classifier and class names). The service assumes UTF-8 encoding if it - encounters non-ASCII characters. + negative file. You can upload a maximum of 256 MB per call. + Encode all names in UTF-8 if they contain non-ASCII characters (.zip and image file names, and classifier and class + names). The service assumes UTF-8 encoding if it encounters non-ASCII characters. - parameter name: The name of the new classifier. Encode special characters in UTF-8. - - parameter positiveExamples: An array of positive examples, each with a name and a compressed - (.zip) file of images that depict the visual subject for a class within the new classifier. Include at least - 10 images in .jpg or .png format. The minimum recommended image resolution is 32X32 pixels. The maximum number - of images is 10,000 images or 100 MB per .zip file. + - parameter positiveExamples: An array of of positive examples, each with a name and a compressed + (.zip) file of images that depict the visual subject of a class in the new classifier. You can include more than + one positive example file in a call. + Include at least 10 images in .jpg or .png format. The minimum recommended image resolution is 32X32 pixels. The + maximum number of images is 10,000 images or 100 MB per .zip file. + Encode special characters in the file name in UTF-8. - parameter negativeExamples: A .zip file of images that do not depict the visual subject of any of the classes of the new classifier. Must - contain a minimum of 10 images. Encode special characters in the file name in UTF-8. + contain a minimum of 10 images. + Encode special characters in the file name in UTF-8. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -412,7 +422,8 @@ public class VisualRecognition { Retrieve a list of classifiers. - parameter owners: Unused. This parameter will be removed in a future release. - - parameter verbose: Specify `true` to return details about the classifiers. Omit this parameter to return a brief list of classifiers. + - parameter verbose: Specify `true` to return details about the classifiers. Omit this parameter to return a brief list of + classifiers. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -516,19 +527,22 @@ public class VisualRecognition { existing classes. You must supply at least one set of positive or negative examples. For details, see [Updating custom classifiers](https://console.bluemix.net/docs/services/visual-recognition/customizing.html#updating-custom-classifiers). - Encode all names in UTF-8 if they contain non-ASCII characters (.zip and image file names, and classifier and - class names). The service assumes UTF-8 encoding if it encounters non-ASCII characters. **Tip:** Don't make - retraining calls on a classifier until the status is ready. When you submit retraining requests in parallel, the - last request overwrites the previous requests. The retrained property shows the last time the classifier retraining - finished. + Encode all names in UTF-8 if they contain non-ASCII characters (.zip and image file names, and classifier and class + names). The service assumes UTF-8 encoding if it encounters non-ASCII characters. + **Tip:** Don't make retraining calls on a classifier until the status is ready. When you submit retraining requests + in parallel, the last request overwrites the previous requests. The retrained property shows the last time the + classifier retraining finished. - parameter classifierID: The ID of the classifier. - parameter positiveExamples: An array of positive examples, each with a name and a compressed - (.zip) file of images that depict the visual subject for a class within the new classifier. Include at least - 10 images in .jpg or .png format. The minimum recommended image resolution is 32X32 pixels. The maximum number - of images is 10,000 images or 100 MB per .zip file. + (.zip) file of images that depict the visual subject of a class in the classifier. The positive examples create + or update classes in the classifier. You can include more than one positive example file in a call. + Include at least 10 images in .jpg or .png format. The minimum recommended image resolution is 32X32 pixels. The + maximum number of images is 10,000 images or 100 MB per .zip file. + Encode special characters in the file name in UTF-8. - parameter negativeExamples: A .zip file of images that do not depict the visual subject of any of the classes of the new classifier. Must - contain a minimum of 10 images. Encode special characters in the file name in UTF-8. + contain a minimum of 10 images. + Encode special characters in the file name in UTF-8. - parameter headers: A dictionary of request headers to be sent with this request. - parameter failure: A function executed if an error occurs. - parameter success: A function executed with the successful result. @@ -698,8 +712,9 @@ public class VisualRecognition { Delete labeled data. Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with - the customer ID. You associate a customer ID with data by passing the `X-Watson-Metadata` header with a request - that passes data. For more information about personal data and customer IDs, see [Information + the customer ID. + You associate a customer ID with data by passing the `X-Watson-Metadata` header with a request that passes data. + For more information about personal data and customer IDs, see [Information security](https://console.bluemix.net/docs/services/visual-recognition/information-security.html). - parameter customerID: The customer ID for which all data is to be deleted. diff --git a/Tests/LanguageTranslatorV3Tests/LanguageTranslatorTests.swift b/Tests/LanguageTranslatorV3Tests/LanguageTranslatorTests.swift new file mode 100644 index 000000000..492de90d8 --- /dev/null +++ b/Tests/LanguageTranslatorV3Tests/LanguageTranslatorTests.swift @@ -0,0 +1,239 @@ +/** + * Copyright IBM Corporation 2016 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + +// swiftlint:disable function_body_length force_try force_unwrapping superfluous_disable_command + +import XCTest +import Foundation +import LanguageTranslatorV3 + +class LanguageTranslatorTests: XCTestCase { + + private var languageTranslator: LanguageTranslator! + + // MARK: - Test Configuration + + /** Set up for each test by instantiating the service. */ + override func setUp() { + super.setUp() + continueAfterFailure = false + instantiateLanguageTranslator() + deleteStaleCustomModels() + } + + static var allTests: [(String, (LanguageTranslatorTests) -> () throws -> Void)] { + return [ + ("testListModelsAll", testListModelsAll), + ("testListModelsBySourceLanguage", testListModelsBySourceLanguage), + ("testListModelsByTargetLanguage", testListModelsByTargetLanguage), + ("testListModelsDefault", testListModelsDefault), + ("testCreateDeleteModel", testCreateDeleteModel), + ("testGetModel", testGetModel), + ("testTranslateStringWithModelID", testTranslateStringWithModelID), + ("testTranslateStringWithSourceAndTarget", testTranslateStringWithSourceAndTarget), + ("testListIdentifiableLanguages", testListIdentifiableLanguages), + ("testIdentify", testIdentify), + ("testGetModelDoesntExist", testGetModelDoesntExist), + ] + } + + /** Instantiate Language Translator. */ + func instantiateLanguageTranslator() { + let username = Credentials.LanguageTranslatorV3Username + let password = Credentials.LanguageTranslatorV3Password + languageTranslator = LanguageTranslator(username: username, password: password, version: "2018-06-11") + languageTranslator.defaultHeaders["X-Watson-Learning-Opt-Out"] = "true" + languageTranslator.defaultHeaders["X-Watson-Test"] = "true" + } + + /** Delete any stale custom models that were previously created by unit tests. */ + func deleteStaleCustomModels() { + let description = "Delete any stale custom models previously created by unit tests." + let expectation = self.expectation(description: description) + languageTranslator.listModels(defaultModels: false, failure: failWithError) { models in + for model in models.models where model.baseModelID != "" { + self.languageTranslator.deleteModel(modelID: model.modelID, failure: self.failWithError) { _ in } + } + expectation.fulfill() + } + waitForExpectations() + } + + /** Fail false negatives. */ + func failWithError(error: Error) { + XCTFail("Positive test failed with error: \(error)") + } + + /** Fail false positives. */ + func failWithResult(result: T) { + XCTFail("Negative test returned a result.") + } + + /** Fail false positives. */ + func failWithResult() { + XCTFail("Negative test returned a result.") + } + + /** Wait for expectations. */ + func waitForExpectations(timeout: TimeInterval = 20.0) { + waitForExpectations(timeout: timeout) { error in + XCTAssertNil(error, "Timeout") + } + } + + // MARK: - Positive Tests + + func testListModelsAll() { + let expectation = self.expectation(description: "List all models.") + languageTranslator.listModels(failure: failWithError) { models in + XCTAssertGreaterThan(models.models.count, 0) + expectation.fulfill() + } + waitForExpectations() + } + + func testListModelsBySourceLanguage() { + let expectation = self.expectation(description: "List models, filtered by source language.") + languageTranslator.listModels(source: "es", failure: failWithError) { models in + XCTAssertGreaterThan(models.models.count, 0) + expectation.fulfill() + } + waitForExpectations() + } + + func testListModelsByTargetLanguage() { + let expectation = self.expectation(description: "List models, filtered by target language.") + languageTranslator.listModels(target: "pt", failure: failWithError) { models in + XCTAssertGreaterThan(models.models.count, 0) + expectation.fulfill() + } + waitForExpectations() + } + + func testListModelsDefault() { + let expectation = self.expectation(description: "List models, filtered by default models.") + languageTranslator.listModels(defaultModels: true, failure: failWithError) { models in + XCTAssertGreaterThan(models.models.count, 0) + expectation.fulfill() + } + waitForExpectations() + } + + func testCreateDeleteModel() { + let expectation = self.expectation(description: "Create and delete a custom language model.") + + #if os(Linux) + let glossary = URL(fileURLWithPath: "Tests/LanguageTranslatorV2Tests/glossary.tmx") + #else + let bundle = Bundle(for: type(of: self)) + guard let glossary = bundle.url(forResource: "glossary", withExtension: "tmx") else { + XCTFail("Unable to read forced glossary.") + return + } + #endif + + let failure = { (error: Error) in + if error.localizedDescription.contains("does not permit customization") { + expectation.fulfill() + } else { + XCTFail(error.localizedDescription) + + } + } + + languageTranslator.createModel( + baseModelID: "en-es", + name: "custom-english-to-spanish-model", + forcedGlossary: glossary, + failure: failure) + { + model in + XCTAssertNotEqual(model.modelID, "") + self.languageTranslator.deleteModel(modelID: model.modelID, failure: self.failWithError) { _ in + expectation.fulfill() + } + } + waitForExpectations() + } + + func testGetModel() { + let expectation = self.expectation(description: "Get model.") + languageTranslator.getModel(modelID: "en-es", failure: failWithError) { model in + XCTAssertEqual(model.status, TranslationModel.Status.available.rawValue) + expectation.fulfill() + } + waitForExpectations() + } + + func testTranslateStringWithModelID() { + let expectation = self.expectation(description: "Translate text string using model id.") + let request = TranslateRequest(text: ["Hello"], modelID: "en-es") + languageTranslator.translate(request: request, failure: failWithError) { + translation in + XCTAssertEqual(translation.wordCount, 1) + XCTAssertEqual(translation.characterCount, 5) + XCTAssertEqual(translation.translations.count, 1) + XCTAssertEqual(translation.translations.first?.translationOutput, "Hola") + expectation.fulfill() + } + waitForExpectations() + } + + func testTranslateStringWithSourceAndTarget() { + let expectation = self.expectation(description: "Translate text string using source and target.") + let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") + languageTranslator.translate(request: request, failure: failWithError) { + translation in + XCTAssertEqual(translation.wordCount, 1) + XCTAssertEqual(translation.characterCount, 5) + XCTAssertEqual(translation.translations.count, 1) + XCTAssertEqual(translation.translations.first?.translationOutput, "Hola") + expectation.fulfill() + } + waitForExpectations() + } + + func testListIdentifiableLanguages() { + let expectation = self.expectation(description: "List identifiable languages.") + languageTranslator.listIdentifiableLanguages(failure: failWithError) { identifiableLanguages in + XCTAssertGreaterThan(identifiableLanguages.languages.count, 0) + expectation.fulfill() + } + waitForExpectations() + } + + func testIdentify() { + let expectation = self.expectation(description: "Identify") + languageTranslator.identify(text: "Hola", failure: failWithError) { identifiableLanguages in + let languages = identifiableLanguages.languages + XCTAssertGreaterThan(languages.count, 0) + XCTAssertEqual(languages.first?.language, "es") + XCTAssertGreaterThanOrEqual(languages.first!.confidence, 0.0) + XCTAssertLessThanOrEqual(languages.first!.confidence, 1.0) + expectation.fulfill() + } + waitForExpectations() + } + + // MARK: - Negative Tests + + func testGetModelDoesntExist() { + let expectation = self.expectation(description: "Get model with invalid model id") + let failure = { (error: Error) in expectation.fulfill() } + languageTranslator.getModel(modelID: "invalid_model_id", failure: failure, success: failWithResult) + waitForExpectations() + } +} diff --git a/Tests/LanguageTranslatorV3Tests/glossary.tmx b/Tests/LanguageTranslatorV3Tests/glossary.tmx new file mode 100644 index 000000000..c3d0012a6 --- /dev/null +++ b/Tests/LanguageTranslatorV3Tests/glossary.tmx @@ -0,0 +1,25 @@ + + +
+ + + + International Business Machines + + + International Business Machines + + + + + patent + + + brevent + + + + diff --git a/Tests/VisualRecognitionV3Tests/VisualRecognitionTests.swift b/Tests/VisualRecognitionV3Tests/VisualRecognitionTests.swift index 9627b684f..13c6c30ff 100644 --- a/Tests/VisualRecognitionV3Tests/VisualRecognitionTests.swift +++ b/Tests/VisualRecognitionV3Tests/VisualRecognitionTests.swift @@ -30,6 +30,7 @@ class VisualRecognitionTests: XCTestCase { static var allTests: [(String, (VisualRecognitionTests) -> () throws -> Void)] { return [ ("testListClassifiers", testListClassifiers), + ("testListClassifiersVerbose", testListClassifiersVerbose), // disabled: ("testCreateDeleteClassifier1", testCreateDeleteClassifier1), // disabled: ("testCreateDeleteClassifier2", testCreateDeleteClassifier2), ("testGetClassifier", testGetClassifier), @@ -131,6 +132,20 @@ class VisualRecognitionTests: XCTestCase { func testListClassifiers() { let expectation = self.expectation(description: "Retrieve a list of user-trained classifiers.") + visualRecognition.listClassifiers(failure: failWithError) { classifiers in + for classifier in classifiers.classifiers where classifier.classifierID == self.classifierID { + expectation.fulfill() + return + } + XCTFail("Could not retrieve the trained classifier.") + } + waitForExpectations() + } + + /** Retrieve a verbose list of user-trained classifiers. */ + func testListClassifiersVerbose() { + let expectation = self.expectation(description: "Retrieve a list of user-trained classifiers.") + visualRecognition.listClassifiers(verbose: true, failure: failWithError) { classifiers in for classifier in classifiers.classifiers where classifier.classifierID == self.classifierID { expectation.fulfill() diff --git a/WatsonDeveloperCloud.xcodeproj/project.pbxproj b/WatsonDeveloperCloud.xcodeproj/project.pbxproj index 7ffc0f228..8e6575a67 100644 --- a/WatsonDeveloperCloud.xcodeproj/project.pbxproj +++ b/WatsonDeveloperCloud.xcodeproj/project.pbxproj @@ -561,6 +561,30 @@ 7AC97FC81D830A020046124C /* os_types.h in Headers */ = {isa = PBXBuildFile; fileRef = 7A9EC8151D79B76100507725 /* os_types.h */; settings = {ATTRIBUTES = (Public, ); }; }; 7AF31BFB1D7A414D0040D944 /* SpeechToTextTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7AAA9A251CEE3026002C9564 /* SpeechToTextTests.swift */; }; CA151FA2200EE23F00DBA44F /* carz.zip in Resources */ = {isa = PBXBuildFile; fileRef = CA151FA0200EE0CF00DBA44F /* carz.zip */; }; + CA28815D20CB07D600FC992C /* Credentials.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7A6C7B3C1D8C960300CD97FA /* Credentials.swift */; }; + CA28817620CB095100FC992C /* glossary.tmx in Resources */ = {isa = PBXBuildFile; fileRef = CA28817420CB095100FC992C /* glossary.tmx */; }; + CA28817720CB095100FC992C /* LanguageTranslatorTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = CA28817520CB095100FC992C /* LanguageTranslatorTests.swift */; }; + CA28817920CB099D00FC992C /* DeleteModelResult.swift in Sources */ = {isa = PBXBuildFile; fileRef = CA28815F20CB090700FC992C /* DeleteModelResult.swift */; }; + CA28817A20CB099D00FC992C /* IdentifiableLanguage.swift in Sources */ = {isa = PBXBuildFile; fileRef = CA28816020CB090700FC992C /* IdentifiableLanguage.swift */; }; + CA28817B20CB099D00FC992C /* Translation.swift in Sources */ = {isa = PBXBuildFile; fileRef = CA28816120CB090700FC992C /* Translation.swift */; }; + CA28817C20CB099D00FC992C /* TranslationResult.swift in Sources */ = {isa = PBXBuildFile; fileRef = CA28816220CB090700FC992C /* TranslationResult.swift */; }; + CA28817D20CB099D00FC992C /* IdentifiedLanguages.swift in Sources */ = {isa = PBXBuildFile; fileRef = CA28816320CB090700FC992C /* IdentifiedLanguages.swift */; }; + CA28817E20CB099D00FC992C /* TranslationModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = CA28816420CB090700FC992C /* TranslationModel.swift */; }; + CA28817F20CB099D00FC992C /* IdentifiedLanguage.swift in Sources */ = {isa = PBXBuildFile; fileRef = CA28816520CB090700FC992C /* IdentifiedLanguage.swift */; }; + CA28818020CB099D00FC992C /* TranslationModels.swift in Sources */ = {isa = PBXBuildFile; fileRef = CA28816620CB090700FC992C /* TranslationModels.swift */; }; + CA28818120CB099D00FC992C /* TranslateRequest.swift in Sources */ = {isa = PBXBuildFile; fileRef = CA28816720CB090700FC992C /* TranslateRequest.swift */; }; + CA28818220CB099D00FC992C /* IdentifiableLanguages.swift in Sources */ = {isa = PBXBuildFile; fileRef = CA28816820CB090700FC992C /* IdentifiableLanguages.swift */; }; + CAD2685B20CAF28B002BA2C4 /* LanguageTranslatorV3.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = CAD2685220CAF28A002BA2C4 /* LanguageTranslatorV3.framework */; }; + CAD2686E20CAF919002BA2C4 /* LanguageTranslator.swift in Sources */ = {isa = PBXBuildFile; fileRef = CAD2686A20CAF919002BA2C4 /* LanguageTranslator.swift */; }; + CAD2687320CB00F2002BA2C4 /* Authentication.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6836B8FD2091D1AF006DF944 /* Authentication.swift */; }; + CAD2687420CB00F2002BA2C4 /* CodableExtensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 68B213E71F84296D0052DC00 /* CodableExtensions.swift */; }; + CAD2687520CB00F2002BA2C4 /* JSON.swift in Sources */ = {isa = PBXBuildFile; fileRef = 68B213E81F84296D0052DC00 /* JSON.swift */; }; + CAD2687620CB00F2002BA2C4 /* MultipartFormData.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7AD240081DC7B4360002FEB5 /* MultipartFormData.swift */; }; + CAD2687720CB00F2002BA2C4 /* RestError.swift in Sources */ = {isa = PBXBuildFile; fileRef = 681BA1B41F7DCB1E006633A3 /* RestError.swift */; }; + CAD2687820CB00F2002BA2C4 /* RestRequest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7A61174F1CB5988B009A4DA1 /* RestRequest.swift */; }; + CAD2687920CB00F2002BA2C4 /* RestToken.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7AAA9A3D1CEE3059002C9564 /* RestToken.swift */; }; + CAD2687A20CB00F2002BA2C4 /* RestUtilities.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7AAA9A3C1CEE3059002C9564 /* RestUtilities.swift */; }; + CAD2687D20CB0196002BA2C4 /* LanguageTranslatorV3.h in Headers */ = {isa = PBXBuildFile; fileRef = CAD2687B20CB0195002BA2C4 /* LanguageTranslatorV3.h */; settings = {ATTRIBUTES = (Public, ); }; }; CAF9A5C420ACED3E006C86B7 /* CHANGELOG.md in Resources */ = {isa = PBXBuildFile; fileRef = CAF9A5C320ACED3E006C86B7 /* CHANGELOG.md */; }; CAF9A5CB20B75B3A006C86B7 /* VisualRecognitionWithIAMTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = CAF9A5C920B753B7006C86B7 /* VisualRecognitionWithIAMTests.swift */; }; CE6B98D41DF09D4B004CD6B5 /* face1.jpg in Resources */ = {isa = PBXBuildFile; fileRef = CE6B98D31DF09D4B004CD6B5 /* face1.jpg */; }; @@ -650,6 +674,13 @@ remoteGlobalIDString = 7AB445231D3E647A00E8748A; remoteInfo = ConversationV1; }; + CAD2685C20CAF28B002BA2C4 /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 7A0F95AA1C23288E004C01C0 /* Project object */; + proxyType = 1; + remoteGlobalIDString = CAD2685120CAF28A002BA2C4; + remoteInfo = LanguageTranslatorV3; + }; /* End PBXContainerItemProxy section */ /* Begin PBXCopyFilesBuildPhase section */ @@ -1198,8 +1229,24 @@ B1F21DF71CE2461800393146 /* ToneAnalyzerTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ToneAnalyzerTests.swift; sourceTree = ""; }; B1F21DF81CE2461800393146 /* ToneAnalyzer.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ToneAnalyzer.swift; sourceTree = ""; }; CA151FA0200EE0CF00DBA44F /* carz.zip */ = {isa = PBXFileReference; lastKnownFileType = archive.zip; path = carz.zip; sourceTree = ""; }; + CA28815F20CB090700FC992C /* DeleteModelResult.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = DeleteModelResult.swift; sourceTree = ""; }; + CA28816020CB090700FC992C /* IdentifiableLanguage.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = IdentifiableLanguage.swift; sourceTree = ""; }; + CA28816120CB090700FC992C /* Translation.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Translation.swift; sourceTree = ""; }; + CA28816220CB090700FC992C /* TranslationResult.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TranslationResult.swift; sourceTree = ""; }; + CA28816320CB090700FC992C /* IdentifiedLanguages.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = IdentifiedLanguages.swift; sourceTree = ""; }; + CA28816420CB090700FC992C /* TranslationModel.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TranslationModel.swift; sourceTree = ""; }; + CA28816520CB090700FC992C /* IdentifiedLanguage.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = IdentifiedLanguage.swift; sourceTree = ""; }; + CA28816620CB090700FC992C /* TranslationModels.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TranslationModels.swift; sourceTree = ""; }; + CA28816720CB090700FC992C /* TranslateRequest.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TranslateRequest.swift; sourceTree = ""; }; + CA28816820CB090700FC992C /* IdentifiableLanguages.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = IdentifiableLanguages.swift; sourceTree = ""; }; + CA28817420CB095100FC992C /* glossary.tmx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xml; name = glossary.tmx; path = Tests/LanguageTranslatorV3Tests/glossary.tmx; sourceTree = SOURCE_ROOT; }; + CA28817520CB095100FC992C /* LanguageTranslatorTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = LanguageTranslatorTests.swift; path = Tests/LanguageTranslatorV3Tests/LanguageTranslatorTests.swift; sourceTree = SOURCE_ROOT; }; CA45954820A62FBE0060BF9B /* README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = ""; }; CA45954920A630080060BF9B /* CONTRIBUTING.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; name = CONTRIBUTING.md; path = .github/CONTRIBUTING.md; sourceTree = ""; }; + CAD2685220CAF28A002BA2C4 /* LanguageTranslatorV3.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = LanguageTranslatorV3.framework; sourceTree = BUILT_PRODUCTS_DIR; }; + CAD2685A20CAF28A002BA2C4 /* LanguageTranslatorV3Tests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = LanguageTranslatorV3Tests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; + CAD2686A20CAF919002BA2C4 /* LanguageTranslator.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = LanguageTranslator.swift; sourceTree = ""; }; + CAD2687B20CB0195002BA2C4 /* LanguageTranslatorV3.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = LanguageTranslatorV3.h; path = Source/SupportingFiles/LanguageTranslatorV3.h; sourceTree = ""; }; CAF9A5C320ACED3E006C86B7 /* CHANGELOG.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = net.daringfireball.markdown; path = CHANGELOG.md; sourceTree = ""; }; CAF9A5C920B753B7006C86B7 /* VisualRecognitionWithIAMTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = VisualRecognitionWithIAMTests.swift; sourceTree = ""; }; CE6B98D31DF09D4B004CD6B5 /* face1.jpg */ = {isa = PBXFileReference; lastKnownFileType = image.jpeg; path = face1.jpg; sourceTree = ""; }; @@ -1392,6 +1439,21 @@ ); runOnlyForDeploymentPostprocessing = 0; }; + CAD2684E20CAF28A002BA2C4 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + CAD2685720CAF28A002BA2C4 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + CAD2685B20CAF28B002BA2C4 /* LanguageTranslatorV3.framework in Frameworks */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; /* End PBXFrameworksBuildPhase section */ /* Begin PBXGroup section */ @@ -1781,6 +1843,7 @@ 7AB445181D3E643B00E8748A /* ConversationV1 */, 12F800591DF71B6B006851D6 /* DiscoveryV1 */, 7A6117911CB6D3F2009A4DA1 /* LanguageTranslatorV2 */, + CAD2685320CAF28A002BA2C4 /* LanguageTranslatorV3 */, 12AE2BCB1CCFB5090034CF4E /* NaturalLanguageClassifierV1 */, 1241DFC61E38103C00B8B33E /* NaturalLanguageUnderstandingV1 */, 7A6711971DD0F1790070CA9D /* PersonalityInsightsV3 */, @@ -1824,6 +1887,8 @@ 1241DFB61E380F0A00B8B33E /* NaturalLanguageUnderstandingV1Tests.xctest */, 6877FA9A2056D4F100383B25 /* AssistantV1.framework */, 6877FAAA2056D4F500383B25 /* AssistantV1Tests.xctest */, + CAD2685220CAF28A002BA2C4 /* LanguageTranslatorV3.framework */, + CAD2685A20CAF28A002BA2C4 /* LanguageTranslatorV3Tests.xctest */, ); name = Products; sourceTree = ""; @@ -1848,6 +1913,7 @@ 7A0F95B81C23288E004C01C0 /* Info-Release.plist */, 7A0F95C41C23288E004C01C0 /* Info-Tests.plist */, 7AAAF5AF1CEEA62C00B74848 /* LanguageTranslatorV2.h */, + CAD2687B20CB0195002BA2C4 /* LanguageTranslatorV3.h */, 7AAAF5B01CEEA62C00B74848 /* NaturalLanguageClassifierV1.h */, 1241DFCC1E3810BF00B8B33E /* NaturalLanguageUnderstandingV1.h */, 7A6711821DD0EEEB0070CA9D /* PersonalityInsightsV3.h */, @@ -2258,6 +2324,44 @@ path = ../../Tests/ToneAnalyzerV3Tests; sourceTree = ""; }; + CA28815E20CB090700FC992C /* Models */ = { + isa = PBXGroup; + children = ( + CA28815F20CB090700FC992C /* DeleteModelResult.swift */, + CA28816020CB090700FC992C /* IdentifiableLanguage.swift */, + CA28816120CB090700FC992C /* Translation.swift */, + CA28816220CB090700FC992C /* TranslationResult.swift */, + CA28816320CB090700FC992C /* IdentifiedLanguages.swift */, + CA28816420CB090700FC992C /* TranslationModel.swift */, + CA28816520CB090700FC992C /* IdentifiedLanguage.swift */, + CA28816620CB090700FC992C /* TranslationModels.swift */, + CA28816720CB090700FC992C /* TranslateRequest.swift */, + CA28816820CB090700FC992C /* IdentifiableLanguages.swift */, + ); + path = Models; + sourceTree = ""; + }; + CA28817320CB092500FC992C /* Tests */ = { + isa = PBXGroup; + children = ( + CA28817420CB095100FC992C /* glossary.tmx */, + CA28817520CB095100FC992C /* LanguageTranslatorTests.swift */, + ); + name = Tests; + path = ../../Tests/LanguageTranslatorV3Tests; + sourceTree = ""; + }; + CAD2685320CAF28A002BA2C4 /* LanguageTranslatorV3 */ = { + isa = PBXGroup; + children = ( + CAD2686A20CAF919002BA2C4 /* LanguageTranslator.swift */, + CA28815E20CB090700FC992C /* Models */, + CA28817320CB092500FC992C /* Tests */, + ); + name = LanguageTranslatorV3; + path = Source/LanguageTranslatorV3; + sourceTree = ""; + }; /* End PBXGroup section */ /* Begin PBXHeadersBuildPhase section */ @@ -2362,6 +2466,14 @@ ); runOnlyForDeploymentPostprocessing = 0; }; + CAD2684F20CAF28A002BA2C4 /* Headers */ = { + isa = PBXHeadersBuildPhase; + buildActionMask = 2147483647; + files = ( + CAD2687D20CB0196002BA2C4 /* LanguageTranslatorV3.h in Headers */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; /* End PBXHeadersBuildPhase section */ /* Begin PBXNativeTarget section */ @@ -2810,13 +2922,50 @@ productReference = 7AB4452D1D3E647A00E8748A /* ConversationV1Tests.xctest */; productType = "com.apple.product-type.bundle.unit-test"; }; + CAD2685120CAF28A002BA2C4 /* LanguageTranslatorV3 */ = { + isa = PBXNativeTarget; + buildConfigurationList = CAD2686720CAF28B002BA2C4 /* Build configuration list for PBXNativeTarget "LanguageTranslatorV3" */; + buildPhases = ( + CAD2684D20CAF28A002BA2C4 /* Sources */, + CA28818D20CB241200FC992C /* Run SwiftLint */, + CAD2684E20CAF28A002BA2C4 /* Frameworks */, + CAD2684F20CAF28A002BA2C4 /* Headers */, + CAD2685020CAF28A002BA2C4 /* Resources */, + ); + buildRules = ( + ); + dependencies = ( + ); + name = LanguageTranslatorV3; + productName = LanguageTranslatorV3; + productReference = CAD2685220CAF28A002BA2C4 /* LanguageTranslatorV3.framework */; + productType = "com.apple.product-type.framework"; + }; + CAD2685920CAF28A002BA2C4 /* LanguageTranslatorV3Tests */ = { + isa = PBXNativeTarget; + buildConfigurationList = CAD2686820CAF28B002BA2C4 /* Build configuration list for PBXNativeTarget "LanguageTranslatorV3Tests" */; + buildPhases = ( + CAD2685620CAF28A002BA2C4 /* Sources */, + CAD2685720CAF28A002BA2C4 /* Frameworks */, + CAD2685820CAF28A002BA2C4 /* Resources */, + ); + buildRules = ( + ); + dependencies = ( + CAD2685D20CAF28B002BA2C4 /* PBXTargetDependency */, + ); + name = LanguageTranslatorV3Tests; + productName = LanguageTranslatorV3Tests; + productReference = CAD2685A20CAF28A002BA2C4 /* LanguageTranslatorV3Tests.xctest */; + productType = "com.apple.product-type.bundle.unit-test"; + }; /* End PBXNativeTarget section */ /* Begin PBXProject section */ 7A0F95AA1C23288E004C01C0 /* Project object */ = { isa = PBXProject; attributes = { - LastSwiftUpdateCheck = 0820; + LastSwiftUpdateCheck = 0940; LastUpgradeCheck = 0930; ORGANIZATIONNAME = "Glenn R. Fisher"; TargetAttributes = { @@ -2909,6 +3058,15 @@ DevelopmentTeam = CDXLDASP22; LastSwiftMigration = 0800; }; + CAD2685120CAF28A002BA2C4 = { + CreatedOnToolsVersion = 9.4; + LastSwiftMigration = 0940; + ProvisioningStyle = Manual; + }; + CAD2685920CAF28A002BA2C4 = { + CreatedOnToolsVersion = 9.4; + ProvisioningStyle = Automatic; + }; }; }; buildConfigurationList = 7A0F95AD1C23288E004C01C0 /* Build configuration list for PBXProject "WatsonDeveloperCloud" */; @@ -2931,6 +3089,8 @@ 12F800471DF71921006851D6 /* DiscoveryV1Tests */, 7AAAF4DB1CEEA16100B74848 /* LanguageTranslatorV2 */, 7AAAF4E41CEEA16100B74848 /* LanguageTranslatorV2Tests */, + CAD2685120CAF28A002BA2C4 /* LanguageTranslatorV3 */, + CAD2685920CAF28A002BA2C4 /* LanguageTranslatorV3Tests */, 7AAAF4AE1CEEA10600B74848 /* NaturalLanguageClassifierV1 */, 7AAAF4B71CEEA10700B74848 /* NaturalLanguageClassifierV1Tests */, 1241DFAD1E380F0A00B8B33E /* NaturalLanguageUnderstandingV1 */, @@ -3141,6 +3301,21 @@ ); runOnlyForDeploymentPostprocessing = 0; }; + CAD2685020CAF28A002BA2C4 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + CAD2685820CAF28A002BA2C4 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + CA28817620CB095100FC992C /* glossary.tmx in Resources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; /* End PBXResourcesBuildPhase section */ /* Begin PBXShellScriptBuildPhase section */ @@ -3326,6 +3501,20 @@ shellPath = /bin/sh; shellScript = "if which swiftlint >/dev/null; then\n swiftlint lint --config \"${PROJECT_DIR}/.swiftlint.yml\" --no-cache --path Tests/AssistantV1Tests\nelse\n echo \"SwiftLint is not available. Install SwiftLint to obtain linter results. See https://github.com/realm/SwiftLint\"\nfi"; }; + CA28818D20CB241200FC992C /* Run SwiftLint */ = { + isa = PBXShellScriptBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + inputPaths = ( + ); + name = "Run SwiftLint"; + outputPaths = ( + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "if which swiftlint >/dev/null; then\nswiftlint lint --config \"${PROJECT_DIR}/.swiftlint.yml\" --no-cache --path Source/LanguageTranslatorV3\nelse\necho \"SwiftLint is not available. Install SwiftLint to obtain linter results. See https://github.com/realm/SwiftLint\"\nfi"; + }; CAEC7A671FE961C7002EF4FD /* Run SwiftLint */ = { isa = PBXShellScriptBuildPhase; buildActionMask = 2147483647; @@ -4121,6 +4310,41 @@ ); runOnlyForDeploymentPostprocessing = 0; }; + CAD2684D20CAF28A002BA2C4 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + CA28817D20CB099D00FC992C /* IdentifiedLanguages.swift in Sources */, + CA28818020CB099D00FC992C /* TranslationModels.swift in Sources */, + CAD2687820CB00F2002BA2C4 /* RestRequest.swift in Sources */, + CA28817E20CB099D00FC992C /* TranslationModel.swift in Sources */, + CAD2687920CB00F2002BA2C4 /* RestToken.swift in Sources */, + CAD2687720CB00F2002BA2C4 /* RestError.swift in Sources */, + CAD2686E20CAF919002BA2C4 /* LanguageTranslator.swift in Sources */, + CAD2687320CB00F2002BA2C4 /* Authentication.swift in Sources */, + CAD2687420CB00F2002BA2C4 /* CodableExtensions.swift in Sources */, + CA28817A20CB099D00FC992C /* IdentifiableLanguage.swift in Sources */, + CAD2687A20CB00F2002BA2C4 /* RestUtilities.swift in Sources */, + CA28817920CB099D00FC992C /* DeleteModelResult.swift in Sources */, + CA28818220CB099D00FC992C /* IdentifiableLanguages.swift in Sources */, + CAD2687520CB00F2002BA2C4 /* JSON.swift in Sources */, + CA28817F20CB099D00FC992C /* IdentifiedLanguage.swift in Sources */, + CA28818120CB099D00FC992C /* TranslateRequest.swift in Sources */, + CAD2687620CB00F2002BA2C4 /* MultipartFormData.swift in Sources */, + CA28817C20CB099D00FC992C /* TranslationResult.swift in Sources */, + CA28817B20CB099D00FC992C /* Translation.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; + CAD2685620CAF28A002BA2C4 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + CA28815D20CB07D600FC992C /* Credentials.swift in Sources */, + CA28817720CB095100FC992C /* LanguageTranslatorTests.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; /* End PBXSourcesBuildPhase section */ /* Begin PBXTargetDependency section */ @@ -4179,6 +4403,11 @@ target = 7AB445231D3E647A00E8748A /* ConversationV1 */; targetProxy = 7AB4452F1D3E647A00E8748A /* PBXContainerItemProxy */; }; + CAD2685D20CAF28B002BA2C4 /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = CAD2685120CAF28A002BA2C4 /* LanguageTranslatorV3 */; + targetProxy = CAD2685C20CAF28B002BA2C4 /* PBXContainerItemProxy */; + }; /* End PBXTargetDependency section */ /* Begin XCBuildConfiguration section */ @@ -5143,6 +5372,77 @@ }; name = Release; }; + CAD2686320CAF28B002BA2C4 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + CLANG_ANALYZER_NONNULL = YES; + CLANG_ENABLE_MODULES = YES; + "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = ""; + DEFINES_MODULE = YES; + DYLIB_COMPATIBILITY_VERSION = 1; + DYLIB_CURRENT_VERSION = 1; + DYLIB_INSTALL_NAME_BASE = "@rpath"; + FRAMEWORK_SEARCH_PATHS = "$(inherited)"; + INFOPLIST_FILE = "Source/SupportingFiles/Info-Release.plist"; + INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks"; + IPHONEOS_DEPLOYMENT_TARGET = 8.0; + LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks"; + PRODUCT_BUNDLE_IDENTIFIER = "com.ibm.watson.developer-cloud.LanguageTranslatorV3"; + PRODUCT_NAME = "$(TARGET_NAME)"; + SKIP_INSTALL = YES; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + SWIFT_VERSION = 4.0; + }; + name = Debug; + }; + CAD2686420CAF28B002BA2C4 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + CLANG_ANALYZER_NONNULL = YES; + CLANG_ENABLE_MODULES = YES; + "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = ""; + DEFINES_MODULE = YES; + DYLIB_COMPATIBILITY_VERSION = 1; + DYLIB_CURRENT_VERSION = 1; + DYLIB_INSTALL_NAME_BASE = "@rpath"; + FRAMEWORK_SEARCH_PATHS = "$(inherited)"; + INFOPLIST_FILE = "Source/SupportingFiles/Info-Release.plist"; + INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks"; + IPHONEOS_DEPLOYMENT_TARGET = 8.0; + LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks"; + PRODUCT_BUNDLE_IDENTIFIER = "com.ibm.watson.developer-cloud.LanguageTranslatorV3"; + PRODUCT_NAME = "$(TARGET_NAME)"; + SKIP_INSTALL = YES; + SWIFT_VERSION = 4.0; + }; + name = Release; + }; + CAD2686520CAF28B002BA2C4 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + CLANG_ANALYZER_NONNULL = YES; + INFOPLIST_FILE = "Source/SupportingFiles/Info-Tests.plist"; + IPHONEOS_DEPLOYMENT_TARGET = 9.3; + LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks"; + PRODUCT_BUNDLE_IDENTIFIER = "com.ibm.watson.developer-cloud.LanguageTranslatorV3Tests"; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 4.0; + }; + name = Debug; + }; + CAD2686620CAF28B002BA2C4 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + CLANG_ANALYZER_NONNULL = YES; + INFOPLIST_FILE = "Source/SupportingFiles/Info-Tests.plist"; + IPHONEOS_DEPLOYMENT_TARGET = 9.3; + LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks"; + PRODUCT_BUNDLE_IDENTIFIER = "com.ibm.watson.developer-cloud.LanguageTranslatorV3Tests"; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 4.0; + }; + name = Release; + }; /* End XCBuildConfiguration section */ /* Begin XCConfigurationList section */ @@ -5362,6 +5662,24 @@ defaultConfigurationIsVisible = 0; defaultConfigurationName = Release; }; + CAD2686720CAF28B002BA2C4 /* Build configuration list for PBXNativeTarget "LanguageTranslatorV3" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + CAD2686320CAF28B002BA2C4 /* Debug */, + CAD2686420CAF28B002BA2C4 /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + CAD2686820CAF28B002BA2C4 /* Build configuration list for PBXNativeTarget "LanguageTranslatorV3Tests" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + CAD2686520CAF28B002BA2C4 /* Debug */, + CAD2686620CAF28B002BA2C4 /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; /* End XCConfigurationList section */ }; rootObject = 7A0F95AA1C23288E004C01C0 /* Project object */; diff --git a/docs/swift-api/services/AssistantV1/Classes.html b/docs/swift-api/services/AssistantV1/Classes.html index ba4ed8699..789b42c66 100644 --- a/docs/swift-api/services/AssistantV1/Classes.html +++ b/docs/swift-api/services/AssistantV1/Classes.html @@ -170,9 +170,6 @@ - @@ -314,8 +311,8 @@

Classes

-

The IBM Watson Assistant service combines machine learning, natural language understanding, and integrated dialog tools -to create conversation flows between your apps and your users.

+

The IBM Watson™ Assistant service combines machine learning, natural language understanding, and integrated +dialog tools to create conversation flows between your apps and your users.

See more
@@ -335,7 +332,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Classes/Assistant.html b/docs/swift-api/services/AssistantV1/Classes/Assistant.html index c762b157c..f9f8805d5 100644 --- a/docs/swift-api/services/AssistantV1/Classes/Assistant.html +++ b/docs/swift-api/services/AssistantV1/Classes/Assistant.html @@ -170,9 +170,6 @@ - @@ -301,8 +298,8 @@

Assistant

-

The IBM Watson Assistant service combines machine learning, natural language understanding, and integrated dialog tools -to create conversation flows between your apps and your users.

+

The IBM Watson™ Assistant service combines machine learning, natural language understanding, and integrated +dialog tools to create conversation flows between your apps and your users.

@@ -605,7 +602,8 @@

Declaration

Get response to user input.

-

Get a response to a user’s input. There is no rate limit for this operation.

+

Get a response to a user’s input. +There is no rate limit for this operation.

@@ -646,8 +644,8 @@

Parameters

-

The message to be sent. This includes the user’s input, along with optional intents, entities, and context from the -last response.

+

The message to be sent. This includes the user’s input, along with optional intents, entities, and context from +the last response.

@@ -659,8 +657,8 @@

Parameters

-

Whether to include additional diagnostic information about the dialog nodes that were visited during processing of -the message.

+

Whether to include additional diagnostic information about the dialog nodes that were visited during processing +of the message.

@@ -721,8 +719,8 @@

Parameters

List workspaces.

-

List the workspaces associated with a Watson Assistant service instance. This operation is limited to 500 -requests per 30 minutes. For more information, see Rate limiting.

+

List the workspaces associated with a Watson Assistant service instance. +This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

@@ -864,8 +862,8 @@

Parameters

Create workspace.

Create a workspace based on component objects. You must provide workspace components defining the content of the -new workspace. This operation is limited to 30 requests per 30 minutes. For more information, see Rate -limiting.

+new workspace. +This operation is limited to 30 requests per 30 minutes. For more information, see Rate limiting.

@@ -892,8 +890,9 @@

Parameters

-

The content of the new workspace. The maximum size for this data is 50MB. If you need to import a larger -workspace, consider importing the workspace without intents and entities and then adding them separately.

+

The content of the new workspace. +The maximum size for this data is 50MB. If you need to import a larger workspace, consider importing the +workspace without intents and entities and then adding them separately.

@@ -954,9 +953,9 @@

Parameters

Get information about a workspace.

-

Get information about a workspace, optionally including all workspace content. With export=false, this -operation is limited to 6000 requests per 5 minutes. With export=true, the limit is 20 requests per 30 -minutes. For more information, see Rate limiting.

+

Get information about a workspace, optionally including all workspace content. +With export=false, this operation is limited to 6000 requests per 5 minutes. With export=true, the +limit is 20 requests per 30 minutes. For more information, see Rate limiting.

@@ -997,8 +996,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -1072,8 +1071,8 @@

Parameters

Update workspace.

Update an existing workspace with new or modified data. You must provide component objects defining the content of -the updated workspace. This operation is limited to 30 request per 30 minutes. For more information, see Rate -limiting.

+the updated workspace. +This operation is limited to 30 request per 30 minutes. For more information, see Rate limiting.

@@ -1114,9 +1113,9 @@

Parameters

-

Valid data defining the new and updated workspace content. The maximum size for this data is 50MB. If you need -to import a larger amount of workspace data, consider importing components such as intents and entities using -separate operations.

+

Valid data defining the new and updated workspace content. +The maximum size for this data is 50MB. If you need to import a larger amount of workspace data, consider +importing components such as intents and entities using separate operations.

@@ -1131,8 +1130,9 @@

Parameters

Whether the new data is to be appended to the existing data in the workspace. If append=false, elements included in the new data completely replace the corresponding existing elements, including all subelements. For example, if the new data includes entities and append=false, all existing entities in the workspace are -discarded and replaced with the new entities. If append=true, existing elements are preserved, and the new -elements are added. If any elements in the new data collide with existing elements, the update request fails.

+discarded and replaced with the new entities. +If append=true, existing elements are preserved, and the new elements are added. If any elements in the new +data collide with existing elements, the update request fails.

@@ -1193,8 +1193,8 @@

Parameters

Delete workspace.

-

Delete a workspace from the service instance. This operation is limited to 30 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete a workspace from the service instance. +This operation is limited to 30 requests per 30 minutes. For more information, see Rate limiting.

@@ -1282,9 +1282,9 @@

Parameters

List intents.

-

List the intents for a workspace. With export=false, this operation is limited to 2000 requests per 30 -minutes. With export=true, the limit is 400 requests per 30 minutes. For more information, see Rate -limiting.

+

List the intents for a workspace. +With export=false, this operation is limited to 2000 requests per 30 minutes. With export=true, the +limit is 400 requests per 30 minutes. For more information, see Rate limiting.

@@ -1329,8 +1329,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -1452,8 +1452,8 @@

Parameters

Create intent.

-

Create a new intent. This operation is limited to 2000 requests per 30 minutes. For more information, see Rate -limiting.

+

Create a new intent. +This operation is limited to 2000 requests per 30 minutes. For more information, see Rate limiting.

@@ -1495,9 +1495,13 @@

Parameters

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode -alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It -must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +

@@ -1509,8 +1513,8 @@

Parameters

-

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must -be no longer than 128 characters.

+

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -1583,9 +1587,9 @@

Parameters

Get intent.

-

Get information about an intent, optionally including all intent content. With export=false, this -operation is limited to 6000 requests per 5 minutes. With export=true, the limit is 400 requests per 30 -minutes. For more information, see Rate limiting.

+

Get information about an intent, optionally including all intent content. +With export=false, this operation is limited to 6000 requests per 5 minutes. With export=true, the +limit is 400 requests per 30 minutes. For more information, see Rate limiting.

@@ -1639,8 +1643,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -1714,8 +1718,8 @@

Parameters

Update intent.

Update an existing intent with new or modified data. You must provide component objects defining the content of the -updated intent. This operation is limited to 2000 requests per 30 minutes. For more information, see Rate -limiting.

+updated intent. +This operation is limited to 2000 requests per 30 minutes. For more information, see Rate limiting.

@@ -1770,9 +1774,13 @@

Parameters

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode -alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It -must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +

@@ -1857,8 +1865,8 @@

Parameters

Delete intent.

-

Delete an intent from a workspace. This operation is limited to 2000 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete an intent from a workspace. +This operation is limited to 2000 requests per 30 minutes. For more information, see Rate limiting.

@@ -1959,8 +1967,8 @@

Parameters

List user input examples.

-

List the user input examples for an intent. This operation is limited to 2500 requests per 30 minutes. For more -information, see Rate limiting.

+

List the user input examples for an intent. +This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

@@ -2127,8 +2135,8 @@

Parameters

Create user input example.

-

Add a new user input example to an intent. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Add a new user input example to an intent. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -2181,9 +2189,13 @@

Parameters

-

The text of a user input example. This string must conform to the following restrictions: - It cannot contain -carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no -longer than 1024 characters.

+

The text of a user input example. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +

@@ -2244,8 +2256,8 @@

Parameters

Get user input example.

-

Get information about a user input example. This operation is limited to 6000 requests per 5 minutes. For more -information, see Rate limiting.

+

Get information about a user input example. +This operation is limited to 6000 requests per 5 minutes. For more information, see Rate limiting.

@@ -2372,8 +2384,8 @@

Parameters

Update user input example.

-

Update the text of a user input example. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Update the text of a user input example. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -2439,9 +2451,13 @@

Parameters

-

The text of the user input example. This string must conform to the following restrictions: - It cannot contain -carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no -longer than 1024 characters.

+

The text of the user input example. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +

@@ -2502,8 +2518,8 @@

Parameters

Delete user input example.

-

Delete a user input example from an intent. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete a user input example from an intent. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -2618,7 +2634,7 @@

Parameters

List counterexamples.

List the counterexamples for a workspace. Counterexamples are examples that have been marked as irrelevant input. - This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

+This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

@@ -2813,9 +2829,13 @@

Parameters

-

The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It -cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It -must be no longer than 1024 characters.

+

The text of a user input marked as irrelevant input. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters
  • +
  • It cannot consist of only whitespace characters
  • +
  • It must be no longer than 1024 characters.
  • +

@@ -3107,7 +3127,7 @@

Parameters

Delete counterexample.

Delete a counterexample from a workspace. Counterexamples are examples that have been marked as irrelevant input. - This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

+This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -3208,9 +3228,9 @@

Parameters

List entities.

-

List the entities for a workspace. With export=false, this operation is limited to 1000 requests per 30 -minutes. With export=true, the limit is 200 requests per 30 minutes. For more information, see Rate -limiting.

+

List the entities for a workspace. +With export=false, this operation is limited to 1000 requests per 30 minutes. With export=true, the +limit is 200 requests per 30 minutes. For more information, see Rate limiting.

@@ -3255,8 +3275,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -3378,8 +3398,8 @@

Parameters

Create entity.

-

Create a new entity. This operation is limited to 1000 requests per 30 minutes. For more information, see Rate -limiting.

+

Create a new entity. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -3480,9 +3500,9 @@

Parameters

Get entity.

-

Get information about an entity, optionally including all entity content. With export=false, this -operation is limited to 6000 requests per 5 minutes. With export=true, the limit is 200 requests per 30 -minutes. For more information, see Rate limiting.

+

Get information about an entity, optionally including all entity content. +With export=false, this operation is limited to 6000 requests per 5 minutes. With export=true, the +limit is 200 requests per 30 minutes. For more information, see Rate limiting.

@@ -3536,8 +3556,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -3611,8 +3631,8 @@

Parameters

Update entity.

Update an existing entity with new or modified data. You must provide component objects defining the content of the -updated entity. This operation is limited to 1000 requests per 30 minutes. For more information, see Rate -limiting.

+updated entity. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -3667,8 +3687,8 @@

Parameters

The updated content of the entity. Any elements included in the new data will completely replace the equivalent existing elements, including all subelements. (Previously existing subelements are not retained unless they are -also included in the new data.) For example, if you update the values for an entity, the previously existing values -are discarded and replaced with the new values specified in the update.

+also included in the new data.) For example, if you update the values for an entity, the previously existing +values are discarded and replaced with the new values specified in the update.

@@ -3729,8 +3749,8 @@

Parameters

Delete entity.

-

Delete an entity from a workspace. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete an entity from a workspace. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -3831,8 +3851,8 @@

Parameters

List entity values.

-

List the values for an entity. This operation is limited to 2500 requests per 30 minutes. For more information, -see Rate limiting.

+

List the values for an entity. +This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

@@ -3890,8 +3910,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -4013,8 +4033,8 @@

Parameters

Add entity value.

-

Create a new value for an entity. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Create a new value for an entity. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -4128,8 +4148,8 @@

Parameters

Get entity value.

-

Get information about an entity value. This operation is limited to 6000 requests per 5 minutes. For more -information, see Rate limiting.

+

Get information about an entity value. +This operation is limited to 6000 requests per 5 minutes. For more information, see Rate limiting.

@@ -4196,8 +4216,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -4271,8 +4291,8 @@

Parameters

Update entity value.

Update an existing entity value with new or modified data. You must provide component objects defining the content -of the updated entity value. This operation is limited to 1000 requests per 30 minutes. For more information, -see Rate limiting.

+of the updated entity value. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -4338,10 +4358,11 @@

Parameters

-

The updated content of the entity value. Any elements included in the new data will completely replace the -equivalent existing elements, including all subelements. (Previously existing subelements are not retained unless -they are also included in the new data.) For example, if you update the synonyms for an entity value, the -previously existing synonyms are discarded and replaced with the new synonyms specified in the update.

+

The updated content of the entity value. +Any elements included in the new data will completely replace the equivalent existing elements, including all +subelements. (Previously existing subelements are not retained unless they are also included in the new data.) +For example, if you update the synonyms for an entity value, the previously existing synonyms are discarded and +replaced with the new synonyms specified in the update.

@@ -4402,8 +4423,8 @@

Parameters

Delete entity value.

-

Delete a value from an entity. This operation is limited to 1000 requests per 30 minutes. For more information, -see Rate limiting.

+

Delete a value from an entity. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -4517,8 +4538,8 @@

Parameters

List entity value synonyms.

-

List the synonyms for an entity value. This operation is limited to 2500 requests per 30 minutes. For more -information, see Rate limiting.

+

List the synonyms for an entity value. +This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

@@ -4698,8 +4719,8 @@

Parameters

Add entity value synonym.

-

Add a new synonym to an entity value. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Add a new synonym to an entity value. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -4765,9 +4786,13 @@

Parameters

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage -return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer -than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -4828,8 +4853,8 @@

Parameters

Get entity value synonym.

-

Get information about a synonym of an entity value. This operation is limited to 6000 requests per 5 minutes. -For more information, see Rate limiting.

+

Get information about a synonym of an entity value. +This operation is limited to 6000 requests per 5 minutes. For more information, see Rate limiting.

@@ -4969,8 +4994,8 @@

Parameters

Update entity value synonym.

-

Update an existing entity value synonym with new text. This operation is limited to 1000 requests per 30 -minutes. For more information, see Rate limiting.

+

Update an existing entity value synonym with new text. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -5049,9 +5074,13 @@

Parameters

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage -return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer -than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -5112,8 +5141,8 @@

Parameters

Delete entity value synonym.

-

Delete a synonym from an entity value. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete a synonym from an entity value. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -5240,8 +5269,8 @@

Parameters

List dialog nodes.

-

List the dialog nodes for a workspace. This operation is limited to 2500 requests per 30 minutes. For more -information, see Rate limiting.

+

List the dialog nodes for a workspace. +This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

@@ -5395,8 +5424,8 @@

Parameters

Create dialog node.

-

Create a new dialog node. This operation is limited to 500 requests per 30 minutes. For more information, see -Rate limiting.

+

Create a new dialog node. +This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

@@ -5497,8 +5526,8 @@

Parameters

Get dialog node.

-

Get information about a dialog node. This operation is limited to 6000 requests per 5 minutes. For more -information, see Rate limiting.

+

Get information about a dialog node. +This operation is limited to 6000 requests per 5 minutes. For more information, see Rate limiting.

@@ -5612,8 +5641,8 @@

Parameters

Update dialog node.

-

Update an existing dialog node with new or modified data. This operation is limited to 500 requests per 30 -minutes. For more information, see Rate limiting.

+

Update an existing dialog node with new or modified data. +This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

@@ -5666,10 +5695,11 @@

Parameters

-

The updated content of the dialog node. Any elements included in the new data will completely replace the -equivalent existing elements, including all subelements. (Previously existing subelements are not retained unless -they are also included in the new data.) For example, if you update the actions for a dialog node, the previously -existing actions are discarded and replaced with the new actions specified in the update.

+

The updated content of the dialog node. +Any elements included in the new data will completely replace the equivalent existing elements, including all +subelements. (Previously existing subelements are not retained unless they are also included in the new data.) +For example, if you update the actions for a dialog node, the previously existing actions are discarded and +replaced with the new actions specified in the update.

@@ -5730,8 +5760,8 @@

Parameters

Delete dialog node.

-

Delete a dialog node from a workspace. This operation is limited to 500 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete a dialog node from a workspace. +This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

@@ -5832,9 +5862,9 @@

Parameters

List log events in a workspace.

-

List the events from the log of a specific workspace. If cursor is not specified, this operation is limited -to 40 requests per 30 minutes. If cursor is specified, the limit is 120 requests per minute. For more -information, see Rate limiting.

+

List the events from the log of a specific workspace. +If cursor is not specified, this operation is limited to 40 requests per 30 minutes. If cursor is +specified, the limit is 120 requests per minute. For more information, see Rate limiting.

@@ -5890,7 +5920,8 @@

Parameters

-

A cacheable parameter that limits the results to those matching the specified filter. For more information, see the +

A cacheable parameter that limits the results to those matching the specified filter. For more information, see +the documentation.

@@ -5976,9 +6007,9 @@

Parameters

List log events in all workspaces.

-

List the events from the logs of all workspaces in the service instance. If cursor is not specified, this -operation is limited to 40 requests per 30 minutes. If cursor is specified, the limit is 120 requests per -minute. For more information, see Rate limiting.

+

List the events from the logs of all workspaces in the service instance. +If cursor is not specified, this operation is limited to 40 requests per 30 minutes. If cursor is +specified, the limit is 120 requests per minute. For more information, see Rate limiting.

@@ -6110,8 +6141,9 @@

Parameters

Delete labeled data.

Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with -the customer ID. You associate a customer ID with data by passing the X-Watson-Metadata header with a request -that passes data. For more information about personal data and customer IDs, see Information +the customer ID. +You associate a customer ID with data by passing the X-Watson-Metadata header with a request that passes data. +For more information about personal data and customer IDs, see Information security.

@@ -6190,7 +6222,7 @@

Parameters

diff --git a/docs/swift-api/services/AssistantV1/Enums.html b/docs/swift-api/services/AssistantV1/Enums.html index 97f77788d..e4ca8d15d 100644 --- a/docs/swift-api/services/AssistantV1/Enums.html +++ b/docs/swift-api/services/AssistantV1/Enums.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Enums/JSON.html b/docs/swift-api/services/AssistantV1/Enums/JSON.html index 98150f602..0b592c9fd 100644 --- a/docs/swift-api/services/AssistantV1/Enums/JSON.html +++ b/docs/swift-api/services/AssistantV1/Enums/JSON.html @@ -170,9 +170,6 @@ - @@ -636,7 +633,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Enums/RestError.html b/docs/swift-api/services/AssistantV1/Enums/RestError.html index 8ab9a05e5..635a6043a 100644 --- a/docs/swift-api/services/AssistantV1/Enums/RestError.html +++ b/docs/swift-api/services/AssistantV1/Enums/RestError.html @@ -170,9 +170,6 @@ - @@ -503,7 +500,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs.html b/docs/swift-api/services/AssistantV1/Structs.html index f538c76bf..8543ffb3e 100644 --- a/docs/swift-api/services/AssistantV1/Structs.html +++ b/docs/swift-api/services/AssistantV1/Structs.html @@ -170,9 +170,6 @@ - @@ -2027,49 +2024,10 @@

Declaration

-
-
- - - -

JSON

-
-
-
    -
  • -
    - - - - JSONWrapper - -
    -
    -
    -
    -
    -
    -

    Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct JSONWrapper
    - -
    -
    -
    -
    -
  • -
-
diff --git a/docs/swift-api/services/AssistantV1/Structs/CaptureGroup.html b/docs/swift-api/services/AssistantV1/Structs/CaptureGroup.html index 503c119cf..2a85d1b7d 100644 --- a/docs/swift-api/services/AssistantV1/Structs/CaptureGroup.html +++ b/docs/swift-api/services/AssistantV1/Structs/CaptureGroup.html @@ -170,9 +170,6 @@ - @@ -381,7 +378,10 @@

Declaration

Declaration

Swift

-
public init(group: String, location: [Int]? = nil)
+
public init(
+    group: String,
+    location: [Int]? = nil
+)
@@ -428,7 +428,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/Context.html b/docs/swift-api/services/AssistantV1/Structs/Context.html index 41f7557ef..f38828b9c 100644 --- a/docs/swift-api/services/AssistantV1/Structs/Context.html +++ b/docs/swift-api/services/AssistantV1/Structs/Context.html @@ -170,9 +170,6 @@ - @@ -408,7 +405,11 @@

Declaration

Declaration

Swift

-
public init(conversationID: String? = nil, system: SystemResponse? = nil, additionalProperties: [String: JSON] = [:])
+
public init(
+    conversationID: String? = nil,
+    system: SystemResponse? = nil,
+    additionalProperties: [String: JSON] = [:]
+)
@@ -507,7 +508,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/Counterexample.html b/docs/swift-api/services/AssistantV1/Structs/Counterexample.html index 6eb821de1..823e87cf8 100644 --- a/docs/swift-api/services/AssistantV1/Structs/Counterexample.html +++ b/docs/swift-api/services/AssistantV1/Structs/Counterexample.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/CounterexampleCollection.html b/docs/swift-api/services/AssistantV1/Structs/CounterexampleCollection.html index b1621c8fd..2e3de6d4e 100644 --- a/docs/swift-api/services/AssistantV1/Structs/CounterexampleCollection.html +++ b/docs/swift-api/services/AssistantV1/Structs/CounterexampleCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/CreateCounterexample.html b/docs/swift-api/services/AssistantV1/Structs/CreateCounterexample.html index 6cf0d0bb7..bef33f794 100644 --- a/docs/swift-api/services/AssistantV1/Structs/CreateCounterexample.html +++ b/docs/swift-api/services/AssistantV1/Structs/CreateCounterexample.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

CreateCounterexample

-

The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It must be no longer than 1024 characters.

+

The text of a user input marked as irrelevant input. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters
  • +
  • It cannot consist of only whitespace characters
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -354,7 +357,9 @@

Declaration

Declaration

Swift

-
public init(text: String)
+
public init(
+    text: String
+)
@@ -370,7 +375,13 @@

Parameters

-

The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It must be no longer than 1024 characters.

+

The text of a user input marked as irrelevant input. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters
  • +
  • It cannot consist of only whitespace characters
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -389,7 +400,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode.html b/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode.html index 381f9fb52..3fc5ca83b 100644 --- a/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode.html +++ b/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode.html @@ -170,9 +170,6 @@ - @@ -460,7 +457,12 @@

Declaration

-

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

+

The dialog node ID. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -487,7 +489,8 @@

Declaration

-

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -514,7 +517,8 @@

Declaration

-

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab +characters, and it must be no longer than 2048 characters.

@@ -595,7 +599,8 @@

Declaration

-

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

+

The output of the dialog node. For more information about how to specify dialog node output, see the +documentation.

@@ -730,7 +735,12 @@

Declaration

-

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

+

The alias used to identify the dialog node. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -926,7 +936,25 @@

Declaration

Declaration

Swift

-
public init(dialogNode: String, description: String? = nil, conditions: String? = nil, parent: String? = nil, previousSibling: String? = nil, output: [String: JSON]? = nil, context: [String: JSON]? = nil, metadata: [String: JSON]? = nil, nextStep: DialogNodeNextStep? = nil, actions: [DialogNodeAction]? = nil, title: String? = nil, nodeType: String? = nil, eventName: String? = nil, variable: String? = nil, digressIn: String? = nil, digressOut: String? = nil, digressOutSlots: String? = nil)
+
public init(
+    dialogNode: String,
+    description: String? = nil,
+    conditions: String? = nil,
+    parent: String? = nil,
+    previousSibling: String? = nil,
+    output: [String: JSON]? = nil,
+    context: [String: JSON]? = nil,
+    metadata: [String: JSON]? = nil,
+    nextStep: DialogNodeNextStep? = nil,
+    actions: [DialogNodeAction]? = nil,
+    title: String? = nil,
+    nodeType: String? = nil,
+    eventName: String? = nil,
+    variable: String? = nil,
+    digressIn: String? = nil,
+    digressOut: String? = nil,
+    digressOutSlots: String? = nil
+)
@@ -942,7 +970,12 @@

Parameters

-

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

+

The dialog node ID. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 1024 characters.
  • +

@@ -954,7 +987,8 @@

Parameters

-

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and +it must be no longer than 128 characters.

@@ -966,7 +1000,8 @@

Parameters

-

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab +characters, and it must be no longer than 2048 characters.

@@ -1002,7 +1037,8 @@

Parameters

-

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

+

The output of the dialog node. For more information about how to specify dialog node output, see the +documentation.

@@ -1062,7 +1098,12 @@

Parameters

-

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

+

The alias used to identify the dialog node. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -1153,7 +1194,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode/DigressIn.html b/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode/DigressIn.html index 026c903d5..f81a55c9e 100644 --- a/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode/DigressIn.html +++ b/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode/DigressIn.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode/DigressOut.html b/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode/DigressOut.html index 1bd1ebe89..adcf9afc0 100644 --- a/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode/DigressOut.html +++ b/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode/DigressOut.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode/DigressOutSlots.html b/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode/DigressOutSlots.html index f7cedcfc4..10e004b0b 100644 --- a/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode/DigressOutSlots.html +++ b/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode/DigressOutSlots.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode/EventName.html b/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode/EventName.html index 136bec4fe..b6a2925ec 100644 --- a/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode/EventName.html +++ b/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode/EventName.html @@ -170,9 +170,6 @@ - @@ -555,7 +552,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode/NodeType.html b/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode/NodeType.html index a6b890883..172733bd2 100644 --- a/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode/NodeType.html +++ b/docs/swift-api/services/AssistantV1/Structs/CreateDialogNode/NodeType.html @@ -170,9 +170,6 @@ - @@ -474,7 +471,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/CreateEntity.html b/docs/swift-api/services/AssistantV1/Structs/CreateEntity.html index 6c88ad9fc..3ca291961 100644 --- a/docs/swift-api/services/AssistantV1/Structs/CreateEntity.html +++ b/docs/swift-api/services/AssistantV1/Structs/CreateEntity.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

CreateEntity

-

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

+

The name of the entity. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, underscore, and hyphen characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -347,7 +350,8 @@

Declaration

-

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must +be no longer than 128 characters.

@@ -462,7 +466,13 @@

Declaration

Declaration

Swift

-
public init(entity: String, description: String? = nil, metadata: [String: JSON]? = nil, values: [CreateValue]? = nil, fuzzyMatch: Bool? = nil)
+
public init(
+    entity: String,
+    description: String? = nil,
+    metadata: [String: JSON]? = nil,
+    values: [CreateValue]? = nil,
+    fuzzyMatch: Bool? = nil
+)
@@ -478,7 +488,13 @@

Parameters

-

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

+

The name of the entity. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, and hyphen characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -490,7 +506,8 @@

Parameters

-

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -545,7 +562,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/CreateExample.html b/docs/swift-api/services/AssistantV1/Structs/CreateExample.html index 33dcd404a..b2429caf3 100644 --- a/docs/swift-api/services/AssistantV1/Structs/CreateExample.html +++ b/docs/swift-api/services/AssistantV1/Structs/CreateExample.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

CreateExample

-

The text of a user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

+

The text of a user input example. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -354,7 +357,9 @@

Declaration

Declaration

Swift

-
public init(text: String)
+
public init(
+    text: String
+)
@@ -370,7 +375,13 @@

Parameters

-

The text of a user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

+

The text of a user input example. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -389,7 +400,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/CreateIntent.html b/docs/swift-api/services/AssistantV1/Structs/CreateIntent.html index 0874cc2fa..56f77ed1c 100644 --- a/docs/swift-api/services/AssistantV1/Structs/CreateIntent.html +++ b/docs/swift-api/services/AssistantV1/Structs/CreateIntent.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

CreateIntent

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +
@@ -347,7 +350,8 @@

Declaration

-

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must +be no longer than 128 characters.

@@ -408,7 +412,11 @@

Declaration

Declaration

Swift

-
public init(intent: String, description: String? = nil, examples: [CreateExample]? = nil)
+
public init(
+    intent: String,
+    description: String? = nil,
+    examples: [CreateExample]? = nil
+)
@@ -424,7 +432,13 @@

Parameters

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +

@@ -436,7 +450,8 @@

Parameters

-

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -467,7 +482,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/CreateSynonym.html b/docs/swift-api/services/AssistantV1/Structs/CreateSynonym.html index 0a640ad45..823a02ca5 100644 --- a/docs/swift-api/services/AssistantV1/Structs/CreateSynonym.html +++ b/docs/swift-api/services/AssistantV1/Structs/CreateSynonym.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

CreateSynonym

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -354,7 +357,9 @@

Declaration

Declaration

Swift

-
public init(synonym: String)
+
public init(
+    synonym: String
+)
@@ -370,7 +375,13 @@

Parameters

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -389,7 +400,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/CreateValue.html b/docs/swift-api/services/AssistantV1/Structs/CreateValue.html index d82db12a9..8ea7a0d32 100644 --- a/docs/swift-api/services/AssistantV1/Structs/CreateValue.html +++ b/docs/swift-api/services/AssistantV1/Structs/CreateValue.html @@ -170,9 +170,6 @@ - @@ -348,7 +345,13 @@

Declaration

-

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the entity value. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -402,7 +405,14 @@

Declaration

-

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by +type), but not both. A synonym must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -429,7 +439,10 @@

Declaration

-

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

+

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), +but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to +specify a pattern, see the +documentation.

@@ -490,7 +503,13 @@

Declaration

Declaration

Swift

-
public init(value: String, metadata: [String: JSON]? = nil, synonyms: [String]? = nil, patterns: [String]? = nil, valueType: String? = nil)
+
public init(
+    value: String,
+    metadata: [String: JSON]? = nil,
+    synonyms: [String]? = nil,
+    patterns: [String]? = nil,
+    valueType: String? = nil
+)
@@ -506,7 +525,13 @@

Parameters

-

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the entity value. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -530,7 +555,14 @@

Parameters

-

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated +by type), but not both. A synonym must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -542,7 +574,10 @@

Parameters

-

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

+

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by +type), but not both. A pattern is a regular expression no longer than 128 characters. For more information +about how to specify a pattern, see the +documentation.

@@ -573,7 +608,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/CreateValue/ValueType.html b/docs/swift-api/services/AssistantV1/Structs/CreateValue/ValueType.html index 1b7b8608a..f038cbfd3 100644 --- a/docs/swift-api/services/AssistantV1/Structs/CreateValue/ValueType.html +++ b/docs/swift-api/services/AssistantV1/Structs/CreateValue/ValueType.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/CreateWorkspace.html b/docs/swift-api/services/AssistantV1/Structs/CreateWorkspace.html index e394c3479..84c89e2d2 100644 --- a/docs/swift-api/services/AssistantV1/Structs/CreateWorkspace.html +++ b/docs/swift-api/services/AssistantV1/Structs/CreateWorkspace.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,8 @@

CreateWorkspace

-

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

+

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be +no longer than 64 characters.

@@ -347,7 +345,8 @@

Declaration

-

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -536,7 +535,8 @@

Declaration

-

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that +workspace training data is not to be used.

@@ -570,7 +570,17 @@

Declaration

Declaration

Swift

-
public init(name: String? = nil, description: String? = nil, language: String? = nil, intents: [CreateIntent]? = nil, entities: [CreateEntity]? = nil, dialogNodes: [CreateDialogNode]? = nil, counterexamples: [CreateCounterexample]? = nil, metadata: [String: JSON]? = nil, learningOptOut: Bool? = nil)
+
public init(
+    name: String? = nil,
+    description: String? = nil,
+    language: String? = nil,
+    intents: [CreateIntent]? = nil,
+    entities: [CreateEntity]? = nil,
+    dialogNodes: [CreateDialogNode]? = nil,
+    counterexamples: [CreateCounterexample]? = nil,
+    metadata: [String: JSON]? = nil,
+    learningOptOut: Bool? = nil
+)
@@ -586,7 +596,8 @@

Parameters

-

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

+

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be +no longer than 64 characters.

@@ -598,7 +609,8 @@

Parameters

-

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -682,7 +694,8 @@

Parameters

-

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace can be used by IBM for general service improvements. true indicates +that workspace training data is not to be used.

@@ -701,7 +714,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/DialogNode.html b/docs/swift-api/services/AssistantV1/Structs/DialogNode.html index 92c528307..14e34f4a7 100644 --- a/docs/swift-api/services/AssistantV1/Structs/DialogNode.html +++ b/docs/swift-api/services/AssistantV1/Structs/DialogNode.html @@ -170,9 +170,6 @@ - @@ -568,7 +565,8 @@

Declaration

-

The ID of the previous sibling dialog node. This property is not returned if the dialog node has no previous sibling.

+

The ID of the previous sibling dialog node. This property is not returned if the dialog node has no previous +sibling.

@@ -965,7 +963,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/DialogNode/DigressIn.html b/docs/swift-api/services/AssistantV1/Structs/DialogNode/DigressIn.html index fe61a871f..556a17edf 100644 --- a/docs/swift-api/services/AssistantV1/Structs/DialogNode/DigressIn.html +++ b/docs/swift-api/services/AssistantV1/Structs/DialogNode/DigressIn.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/DialogNode/DigressOut.html b/docs/swift-api/services/AssistantV1/Structs/DialogNode/DigressOut.html index cfdeb2f5f..fb07b38f1 100644 --- a/docs/swift-api/services/AssistantV1/Structs/DialogNode/DigressOut.html +++ b/docs/swift-api/services/AssistantV1/Structs/DialogNode/DigressOut.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/DialogNode/DigressOutSlots.html b/docs/swift-api/services/AssistantV1/Structs/DialogNode/DigressOutSlots.html index 354e93d4c..7bbf7e284 100644 --- a/docs/swift-api/services/AssistantV1/Structs/DialogNode/DigressOutSlots.html +++ b/docs/swift-api/services/AssistantV1/Structs/DialogNode/DigressOutSlots.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/DialogNode/EventName.html b/docs/swift-api/services/AssistantV1/Structs/DialogNode/EventName.html index 0cd37a2f0..3ecfbf141 100644 --- a/docs/swift-api/services/AssistantV1/Structs/DialogNode/EventName.html +++ b/docs/swift-api/services/AssistantV1/Structs/DialogNode/EventName.html @@ -170,9 +170,6 @@ - @@ -555,7 +552,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/DialogNode/NodeType.html b/docs/swift-api/services/AssistantV1/Structs/DialogNode/NodeType.html index 4f315a4d5..3ae76d0b4 100644 --- a/docs/swift-api/services/AssistantV1/Structs/DialogNode/NodeType.html +++ b/docs/swift-api/services/AssistantV1/Structs/DialogNode/NodeType.html @@ -170,9 +170,6 @@ - @@ -474,7 +471,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/DialogNodeAction.html b/docs/swift-api/services/AssistantV1/Structs/DialogNodeAction.html index a7dd5a618..f701f831e 100644 --- a/docs/swift-api/services/AssistantV1/Structs/DialogNodeAction.html +++ b/docs/swift-api/services/AssistantV1/Structs/DialogNodeAction.html @@ -170,9 +170,6 @@ - @@ -490,7 +487,13 @@

Declaration

Declaration

Swift

-
public init(name: String, resultVariable: String, actionType: String? = nil, parameters: [String: JSON]? = nil, credentials: String? = nil)
+
public init(
+    name: String,
+    resultVariable: String,
+    actionType: String? = nil,
+    parameters: [String: JSON]? = nil,
+    credentials: String? = nil
+)
@@ -573,7 +576,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/DialogNodeAction/ActionType.html b/docs/swift-api/services/AssistantV1/Structs/DialogNodeAction/ActionType.html index 275d3f50e..bb481f28c 100644 --- a/docs/swift-api/services/AssistantV1/Structs/DialogNodeAction/ActionType.html +++ b/docs/swift-api/services/AssistantV1/Structs/DialogNodeAction/ActionType.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/DialogNodeCollection.html b/docs/swift-api/services/AssistantV1/Structs/DialogNodeCollection.html index 39cdf1692..20411b330 100644 --- a/docs/swift-api/services/AssistantV1/Structs/DialogNodeCollection.html +++ b/docs/swift-api/services/AssistantV1/Structs/DialogNodeCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/DialogNodeNextStep.html b/docs/swift-api/services/AssistantV1/Structs/DialogNodeNextStep.html index 96193fe3c..96fd098b2 100644 --- a/docs/swift-api/services/AssistantV1/Structs/DialogNodeNextStep.html +++ b/docs/swift-api/services/AssistantV1/Structs/DialogNodeNextStep.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,40 @@

DialogNodeNextStep

-

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

+

What happens after the dialog node completes. The valid values depend on the node type:

+ +
    +
  • The following values are valid for any node: + +
      +
    • get_user_input
    • +
    • skip_user_input
    • +
    • jump_to
    • +
  • +
  • If the node is of type event_handler and its parent node is of type slot or frame, additional values are +also valid: + +
      +
    • if event_name=filled and the type of the parent node is slot:
    • +
    • reprompt
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=nomatch and the type of the parent node is slot: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=generic and the type of the parent node is frame: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots +If you specify jump_to, then you must also specify a value for the dialog_node property.
    • +
  • +
See more
@@ -376,7 +406,40 @@

Declaration

-

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

+

What happens after the dialog node completes. The valid values depend on the node type:

+ +
    +
  • The following values are valid for any node: + +
      +
    • get_user_input
    • +
    • skip_user_input
    • +
    • jump_to
    • +
  • +
  • If the node is of type event_handler and its parent node is of type slot or frame, additional values are +also valid: + +
      +
    • if event_name=filled and the type of the parent node is slot:
    • +
    • reprompt
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=nomatch and the type of the parent node is slot: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=generic and the type of the parent node is frame: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots +If you specify jump_to, then you must also specify a value for the dialog_node property.
    • +
  • +
@@ -464,7 +527,11 @@

Declaration

Declaration

Swift

-
public init(behavior: String, dialogNode: String? = nil, selector: String? = nil)
+
public init(
+    behavior: String,
+    dialogNode: String? = nil,
+    selector: String? = nil
+)
@@ -480,7 +547,37 @@

Parameters

-

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

+

What happens after the dialog node completes. The valid values depend on the node type: + +

    +
  • The following values are valid for any node:
  • +
  • get_user_input
  • +
  • skip_user_input
  • +
  • jump_to
  • +
  • If the node is of type event_handler and its parent node is of type slot or frame, additional values are +also valid:
  • +
  • if event_name=filled and the type of the parent node is slot: + +
      +
    • reprompt
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=nomatch and the type of the parent node is slot: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=generic and the type of the parent node is frame: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots +If you specify jump_to, then you must also specify a value for the dialog_node property.
    • +
  • +

@@ -523,7 +620,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/DialogNodeNextStep/Behavior.html b/docs/swift-api/services/AssistantV1/Structs/DialogNodeNextStep/Behavior.html index 53799cdd3..4bd370528 100644 --- a/docs/swift-api/services/AssistantV1/Structs/DialogNodeNextStep/Behavior.html +++ b/docs/swift-api/services/AssistantV1/Structs/DialogNodeNextStep/Behavior.html @@ -170,9 +170,6 @@ - @@ -301,7 +298,40 @@

Behavior

-

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

+

What happens after the dialog node completes. The valid values depend on the node type:

+ +
    +
  • The following values are valid for any node: + +
      +
    • get_user_input
    • +
    • skip_user_input
    • +
    • jump_to
    • +
  • +
  • If the node is of type event_handler and its parent node is of type slot or frame, additional values are +also valid: + +
      +
    • if event_name=filled and the type of the parent node is slot:
    • +
    • reprompt
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=nomatch and the type of the parent node is slot: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=generic and the type of the parent node is frame: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots +If you specify jump_to, then you must also specify a value for the dialog_node property.
    • +
  • +
@@ -474,7 +504,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/DialogNodeNextStep/Selector.html b/docs/swift-api/services/AssistantV1/Structs/DialogNodeNextStep/Selector.html index 0fde407b9..ef827fc13 100644 --- a/docs/swift-api/services/AssistantV1/Structs/DialogNodeNextStep/Selector.html +++ b/docs/swift-api/services/AssistantV1/Structs/DialogNodeNextStep/Selector.html @@ -170,9 +170,6 @@ - @@ -420,7 +417,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/DialogNodeVisitedDetails.html b/docs/swift-api/services/AssistantV1/Structs/DialogNodeVisitedDetails.html index 91f190b03..922f6a140 100644 --- a/docs/swift-api/services/AssistantV1/Structs/DialogNodeVisitedDetails.html +++ b/docs/swift-api/services/AssistantV1/Structs/DialogNodeVisitedDetails.html @@ -170,9 +170,6 @@ - @@ -408,7 +405,11 @@

Declaration

Declaration

Swift

-
public init(dialogNode: String? = nil, title: String? = nil, conditions: String? = nil)
+
public init(
+    dialogNode: String? = nil,
+    title: String? = nil,
+    conditions: String? = nil
+)
@@ -467,7 +468,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/Entity.html b/docs/swift-api/services/AssistantV1/Structs/Entity.html index 631fa015b..2da990277 100644 --- a/docs/swift-api/services/AssistantV1/Structs/Entity.html +++ b/docs/swift-api/services/AssistantV1/Structs/Entity.html @@ -170,9 +170,6 @@ - @@ -474,7 +471,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/EntityCollection.html b/docs/swift-api/services/AssistantV1/Structs/EntityCollection.html index 7ad62efa9..2d0729d5b 100644 --- a/docs/swift-api/services/AssistantV1/Structs/EntityCollection.html +++ b/docs/swift-api/services/AssistantV1/Structs/EntityCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/EntityExport.html b/docs/swift-api/services/AssistantV1/Structs/EntityExport.html index c074afef5..f6b8cae60 100644 --- a/docs/swift-api/services/AssistantV1/Structs/EntityExport.html +++ b/docs/swift-api/services/AssistantV1/Structs/EntityExport.html @@ -170,9 +170,6 @@ - @@ -501,7 +498,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/Example.html b/docs/swift-api/services/AssistantV1/Structs/Example.html index afaba25f0..ffb77f1e2 100644 --- a/docs/swift-api/services/AssistantV1/Structs/Example.html +++ b/docs/swift-api/services/AssistantV1/Structs/Example.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/ExampleCollection.html b/docs/swift-api/services/AssistantV1/Structs/ExampleCollection.html index 65174f946..c16e1fbae 100644 --- a/docs/swift-api/services/AssistantV1/Structs/ExampleCollection.html +++ b/docs/swift-api/services/AssistantV1/Structs/ExampleCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/InputData.html b/docs/swift-api/services/AssistantV1/Structs/InputData.html index 6e31e84f1..69c3dfe95 100644 --- a/docs/swift-api/services/AssistantV1/Structs/InputData.html +++ b/docs/swift-api/services/AssistantV1/Structs/InputData.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,8 @@

InputData

-

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be +no longer than 2048 characters.

@@ -354,7 +352,9 @@

Declaration

Declaration

Swift

-
public init(text: String)
+
public init(
+    text: String
+)
@@ -370,7 +370,8 @@

Parameters

-

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must +be no longer than 2048 characters.

@@ -389,7 +390,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/Intent.html b/docs/swift-api/services/AssistantV1/Structs/Intent.html index 7962ff256..f71f20837 100644 --- a/docs/swift-api/services/AssistantV1/Structs/Intent.html +++ b/docs/swift-api/services/AssistantV1/Structs/Intent.html @@ -170,9 +170,6 @@ - @@ -420,7 +417,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/IntentCollection.html b/docs/swift-api/services/AssistantV1/Structs/IntentCollection.html index 9da1b6cfc..8a207a70e 100644 --- a/docs/swift-api/services/AssistantV1/Structs/IntentCollection.html +++ b/docs/swift-api/services/AssistantV1/Structs/IntentCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/IntentExport.html b/docs/swift-api/services/AssistantV1/Structs/IntentExport.html index e3075719b..efa900484 100644 --- a/docs/swift-api/services/AssistantV1/Structs/IntentExport.html +++ b/docs/swift-api/services/AssistantV1/Structs/IntentExport.html @@ -170,9 +170,6 @@ - @@ -447,7 +444,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/LogCollection.html b/docs/swift-api/services/AssistantV1/Structs/LogCollection.html index ed320d29b..31921ffa5 100644 --- a/docs/swift-api/services/AssistantV1/Structs/LogCollection.html +++ b/docs/swift-api/services/AssistantV1/Structs/LogCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/LogExport.html b/docs/swift-api/services/AssistantV1/Structs/LogExport.html index fd351f5d2..175396872 100644 --- a/docs/swift-api/services/AssistantV1/Structs/LogExport.html +++ b/docs/swift-api/services/AssistantV1/Structs/LogExport.html @@ -170,9 +170,6 @@ - @@ -501,7 +498,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/LogMessage.html b/docs/swift-api/services/AssistantV1/Structs/LogMessage.html index 25893ef7b..f1b081e52 100644 --- a/docs/swift-api/services/AssistantV1/Structs/LogMessage.html +++ b/docs/swift-api/services/AssistantV1/Structs/LogMessage.html @@ -170,9 +170,6 @@ - @@ -436,7 +433,11 @@

Declaration

Declaration

Swift

-
public init(level: String, msg: String, additionalProperties: [String: JSON] = [:])
+
public init(
+    level: String,
+    msg: String,
+    additionalProperties: [String: JSON] = [:]
+)
@@ -535,7 +536,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/LogMessage/Level.html b/docs/swift-api/services/AssistantV1/Structs/LogMessage/Level.html index ff2481f78..1c203e6af 100644 --- a/docs/swift-api/services/AssistantV1/Structs/LogMessage/Level.html +++ b/docs/swift-api/services/AssistantV1/Structs/LogMessage/Level.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/LogPagination.html b/docs/swift-api/services/AssistantV1/Structs/LogPagination.html index 2c15ee320..247f41791 100644 --- a/docs/swift-api/services/AssistantV1/Structs/LogPagination.html +++ b/docs/swift-api/services/AssistantV1/Structs/LogPagination.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/MessageInput.html b/docs/swift-api/services/AssistantV1/Structs/MessageInput.html index f310a375b..181267765 100644 --- a/docs/swift-api/services/AssistantV1/Structs/MessageInput.html +++ b/docs/swift-api/services/AssistantV1/Structs/MessageInput.html @@ -170,9 +170,6 @@ - @@ -339,7 +336,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/MessageRequest.html b/docs/swift-api/services/AssistantV1/Structs/MessageRequest.html index c2e5afa1b..e113be139 100644 --- a/docs/swift-api/services/AssistantV1/Structs/MessageRequest.html +++ b/docs/swift-api/services/AssistantV1/Structs/MessageRequest.html @@ -170,9 +170,6 @@ - @@ -374,7 +371,8 @@

Declaration

-

State information for the conversation. Continue a conversation by including the context object from the previous response.

+

State information for the conversation. Continue a conversation by including the context object from the previous +response.

@@ -401,7 +399,8 @@

Declaration

-

Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input.

+

Entities to use when evaluating the message. Include entities from the previous response to continue using those +entities rather than detecting entities in the new input.

@@ -428,7 +427,8 @@

Declaration

-

Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input.

+

Intents to use when evaluating the user input. Include intents from the previous response to continue using those +intents rather than trying to recognize intents in the new input.

@@ -455,7 +455,8 @@

Declaration

-

System output. Include the output from the previous response to maintain intermediate information over multiple requests.

+

System output. Include the output from the previous response to maintain intermediate information over multiple +requests.

@@ -489,7 +490,14 @@

Declaration

Declaration

Swift

-
public init(input: InputData? = nil, alternateIntents: Bool? = nil, context: Context? = nil, entities: [RuntimeEntity]? = nil, intents: [RuntimeIntent]? = nil, output: OutputData? = nil)
+
public init(
+    input: InputData? = nil,
+    alternateIntents: Bool? = nil,
+    context: Context? = nil,
+    entities: [RuntimeEntity]? = nil,
+    intents: [RuntimeIntent]? = nil,
+    output: OutputData? = nil
+)
@@ -529,7 +537,8 @@

Parameters

-

State information for the conversation. Continue a conversation by including the context object from the previous response.

+

State information for the conversation. Continue a conversation by including the context object from the previous +response.

@@ -541,7 +550,8 @@

Parameters

-

Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input.

+

Entities to use when evaluating the message. Include entities from the previous response to continue using those +entities rather than detecting entities in the new input.

@@ -553,7 +563,8 @@

Parameters

-

Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input.

+

Intents to use when evaluating the user input. Include intents from the previous response to continue using those +intents rather than trying to recognize intents in the new input.

@@ -565,7 +576,8 @@

Parameters

-

System output. Include the output from the previous response to maintain intermediate information over multiple requests.

+

System output. Include the output from the previous response to maintain intermediate information over multiple +requests.

@@ -584,7 +596,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/MessageResponse.html b/docs/swift-api/services/AssistantV1/Structs/MessageResponse.html index 0a38e5a1f..ead17adff 100644 --- a/docs/swift-api/services/AssistantV1/Structs/MessageResponse.html +++ b/docs/swift-api/services/AssistantV1/Structs/MessageResponse.html @@ -170,9 +170,6 @@ - @@ -527,7 +524,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/OutputData.html b/docs/swift-api/services/AssistantV1/Structs/OutputData.html index b7a91af7f..916efdc7e 100644 --- a/docs/swift-api/services/AssistantV1/Structs/OutputData.html +++ b/docs/swift-api/services/AssistantV1/Structs/OutputData.html @@ -170,9 +170,6 @@ - @@ -374,7 +371,8 @@

Declaration

-

An array of the nodes that were triggered to create the response, in the order in which they were visited. This information is useful for debugging and for tracing the path taken through the node tree.

+

An array of the nodes that were triggered to create the response, in the order in which they were visited. This +information is useful for debugging and for tracing the path taken through the node tree.

@@ -401,7 +399,9 @@

Declaration

-

An array of objects containing detailed diagnostic information about the nodes that were triggered during processing of the input message. Included only if nodes_visited_details is set to true in the message request.

+

An array of objects containing detailed diagnostic information about the nodes that were triggered during +processing of the input message. Included only if nodes_visited_details is set to true in the message +request.

@@ -462,7 +462,13 @@

Declaration

Declaration

Swift

-
public init(logMessages: [LogMessage], text: [String], nodesVisited: [String]? = nil, nodesVisitedDetails: [DialogNodeVisitedDetails]? = nil, additionalProperties: [String: JSON] = [:])
+
public init(
+    logMessages: [LogMessage],
+    text: [String],
+    nodesVisited: [String]? = nil,
+    nodesVisitedDetails: [DialogNodeVisitedDetails]? = nil,
+    additionalProperties: [String: JSON] = [:]
+)
@@ -502,7 +508,8 @@

Parameters

-

An array of the nodes that were triggered to create the response, in the order in which they were visited. This information is useful for debugging and for tracing the path taken through the node tree.

+

An array of the nodes that were triggered to create the response, in the order in which they were visited. This +information is useful for debugging and for tracing the path taken through the node tree.

@@ -514,7 +521,9 @@

Parameters

-

An array of objects containing detailed diagnostic information about the nodes that were triggered during processing of the input message. Included only if nodes_visited_details is set to true in the message request.

+

An array of objects containing detailed diagnostic information about the nodes that were triggered during +processing of the input message. Included only if nodes_visited_details is set to true in the message +request.

@@ -585,7 +594,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/Pagination.html b/docs/swift-api/services/AssistantV1/Structs/Pagination.html index 88a8a34a3..4c504906c 100644 --- a/docs/swift-api/services/AssistantV1/Structs/Pagination.html +++ b/docs/swift-api/services/AssistantV1/Structs/Pagination.html @@ -170,9 +170,6 @@ - @@ -474,7 +471,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/RuntimeEntity.html b/docs/swift-api/services/AssistantV1/Structs/RuntimeEntity.html index 4ce778c6a..1aa647096 100644 --- a/docs/swift-api/services/AssistantV1/Structs/RuntimeEntity.html +++ b/docs/swift-api/services/AssistantV1/Structs/RuntimeEntity.html @@ -170,9 +170,6 @@ - @@ -347,7 +344,8 @@

Declaration

-

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text.

+

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input +text.

@@ -516,7 +514,15 @@

Declaration

Declaration

Swift

-
public init(entity: String, location: [Int], value: String, confidence: Double? = nil, metadata: [String: JSON]? = nil, groups: [CaptureGroup]? = nil, additionalProperties: [String: JSON] = [:])
+
public init(
+    entity: String,
+    location: [Int],
+    value: String,
+    confidence: Double? = nil,
+    metadata: [String: JSON]? = nil,
+    groups: [CaptureGroup]? = nil,
+    additionalProperties: [String: JSON] = [:]
+)
@@ -544,7 +550,8 @@

Parameters

-

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text.

+

An array of zero-based character offsets that indicate where the detected entity values begin and end in the +input text.

@@ -663,7 +670,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/RuntimeIntent.html b/docs/swift-api/services/AssistantV1/Structs/RuntimeIntent.html index d70efb48e..82e65e97e 100644 --- a/docs/swift-api/services/AssistantV1/Structs/RuntimeIntent.html +++ b/docs/swift-api/services/AssistantV1/Structs/RuntimeIntent.html @@ -170,9 +170,6 @@ - @@ -408,7 +405,11 @@

Declaration

Declaration

Swift

-
public init(intent: String, confidence: Double, additionalProperties: [String: JSON] = [:])
+
public init(
+    intent: String,
+    confidence: Double,
+    additionalProperties: [String: JSON] = [:]
+)
@@ -507,7 +508,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/Synonym.html b/docs/swift-api/services/AssistantV1/Structs/Synonym.html index cd150b888..58b7f9f9c 100644 --- a/docs/swift-api/services/AssistantV1/Structs/Synonym.html +++ b/docs/swift-api/services/AssistantV1/Structs/Synonym.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/SynonymCollection.html b/docs/swift-api/services/AssistantV1/Structs/SynonymCollection.html index 79ea1376f..b9b14968c 100644 --- a/docs/swift-api/services/AssistantV1/Structs/SynonymCollection.html +++ b/docs/swift-api/services/AssistantV1/Structs/SynonymCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/SystemResponse.html b/docs/swift-api/services/AssistantV1/Structs/SystemResponse.html index 728bd4881..f052244c0 100644 --- a/docs/swift-api/services/AssistantV1/Structs/SystemResponse.html +++ b/docs/swift-api/services/AssistantV1/Structs/SystemResponse.html @@ -170,9 +170,6 @@ - @@ -354,7 +351,9 @@

Declaration

Declaration

Swift

-
public init(additionalProperties: [String: JSON] = [:])
+
public init(
+    additionalProperties: [String: JSON] = [:]
+)
@@ -422,7 +421,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/UpdateCounterexample.html b/docs/swift-api/services/AssistantV1/Structs/UpdateCounterexample.html index 00215d685..ceba9e354 100644 --- a/docs/swift-api/services/AssistantV1/Structs/UpdateCounterexample.html +++ b/docs/swift-api/services/AssistantV1/Structs/UpdateCounterexample.html @@ -170,9 +170,6 @@ - @@ -354,7 +351,9 @@

Declaration

Declaration

Swift

-
public init(text: String? = nil)
+
public init(
+    text: String? = nil
+)
@@ -389,7 +388,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode.html b/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode.html index 725ec329d..648ebbd4b 100644 --- a/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode.html +++ b/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode.html @@ -170,9 +170,6 @@ - @@ -460,7 +457,12 @@

Declaration

-

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

+

The dialog node ID. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -487,7 +489,8 @@

Declaration

-

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -514,7 +517,8 @@

Declaration

-

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab +characters, and it must be no longer than 2048 characters.

@@ -595,7 +599,8 @@

Declaration

-

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

+

The output of the dialog node. For more information about how to specify dialog node output, see the +documentation.

@@ -703,7 +708,12 @@

Declaration

-

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

+

The alias used to identify the dialog node. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -926,7 +936,25 @@

Declaration

Declaration

Swift

-
public init(dialogNode: String? = nil, description: String? = nil, conditions: String? = nil, parent: String? = nil, previousSibling: String? = nil, output: [String: JSON]? = nil, context: [String: JSON]? = nil, metadata: [String: JSON]? = nil, nextStep: DialogNodeNextStep? = nil, title: String? = nil, nodeType: String? = nil, eventName: String? = nil, variable: String? = nil, actions: [DialogNodeAction]? = nil, digressIn: String? = nil, digressOut: String? = nil, digressOutSlots: String? = nil)
+
public init(
+    dialogNode: String? = nil,
+    description: String? = nil,
+    conditions: String? = nil,
+    parent: String? = nil,
+    previousSibling: String? = nil,
+    output: [String: JSON]? = nil,
+    context: [String: JSON]? = nil,
+    metadata: [String: JSON]? = nil,
+    nextStep: DialogNodeNextStep? = nil,
+    title: String? = nil,
+    nodeType: String? = nil,
+    eventName: String? = nil,
+    variable: String? = nil,
+    actions: [DialogNodeAction]? = nil,
+    digressIn: String? = nil,
+    digressOut: String? = nil,
+    digressOutSlots: String? = nil
+)
@@ -942,7 +970,12 @@

Parameters

-

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

+

The dialog node ID. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 1024 characters.
  • +

@@ -954,7 +987,8 @@

Parameters

-

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and +it must be no longer than 128 characters.

@@ -966,7 +1000,8 @@

Parameters

-

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab +characters, and it must be no longer than 2048 characters.

@@ -1002,7 +1037,8 @@

Parameters

-

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

+

The output of the dialog node. For more information about how to specify dialog node output, see the +documentation.

@@ -1050,7 +1086,12 @@

Parameters

-

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

+

The alias used to identify the dialog node. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -1153,7 +1194,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode/DigressIn.html b/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode/DigressIn.html index d6c720e0e..94a96c2c5 100644 --- a/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode/DigressIn.html +++ b/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode/DigressIn.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode/DigressOut.html b/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode/DigressOut.html index 9d5df78d6..388c5c5cc 100644 --- a/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode/DigressOut.html +++ b/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode/DigressOut.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode/DigressOutSlots.html b/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode/DigressOutSlots.html index d09b582c1..1c245fe3d 100644 --- a/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode/DigressOutSlots.html +++ b/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode/DigressOutSlots.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode/EventName.html b/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode/EventName.html index 1d9bf574a..61dbde16c 100644 --- a/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode/EventName.html +++ b/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode/EventName.html @@ -170,9 +170,6 @@ - @@ -555,7 +552,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode/NodeType.html b/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode/NodeType.html index 02807b463..f0a767d7f 100644 --- a/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode/NodeType.html +++ b/docs/swift-api/services/AssistantV1/Structs/UpdateDialogNode/NodeType.html @@ -170,9 +170,6 @@ - @@ -474,7 +471,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/UpdateEntity.html b/docs/swift-api/services/AssistantV1/Structs/UpdateEntity.html index 720892d1c..3579c9a75 100644 --- a/docs/swift-api/services/AssistantV1/Structs/UpdateEntity.html +++ b/docs/swift-api/services/AssistantV1/Structs/UpdateEntity.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

UpdateEntity

-

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

+

The name of the entity. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, underscore, and hyphen characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -347,7 +350,8 @@

Declaration

-

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must +be no longer than 128 characters.

@@ -462,7 +466,13 @@

Declaration

Declaration

Swift

-
public init(entity: String? = nil, description: String? = nil, metadata: [String: JSON]? = nil, fuzzyMatch: Bool? = nil, values: [CreateValue]? = nil)
+
public init(
+    entity: String? = nil,
+    description: String? = nil,
+    metadata: [String: JSON]? = nil,
+    fuzzyMatch: Bool? = nil,
+    values: [CreateValue]? = nil
+)
@@ -478,7 +488,13 @@

Parameters

-

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

+

The name of the entity. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, and hyphen characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -490,7 +506,8 @@

Parameters

-

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -545,7 +562,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/UpdateExample.html b/docs/swift-api/services/AssistantV1/Structs/UpdateExample.html index 2ea78d9f8..8f6055c1e 100644 --- a/docs/swift-api/services/AssistantV1/Structs/UpdateExample.html +++ b/docs/swift-api/services/AssistantV1/Structs/UpdateExample.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

UpdateExample

-

The text of the user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

+

The text of the user input example. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -354,7 +357,9 @@

Declaration

Declaration

Swift

-
public init(text: String? = nil)
+
public init(
+    text: String? = nil
+)
@@ -370,7 +375,13 @@

Parameters

-

The text of the user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

+

The text of the user input example. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -389,7 +400,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/UpdateIntent.html b/docs/swift-api/services/AssistantV1/Structs/UpdateIntent.html index b40880da0..c9dd45fc5 100644 --- a/docs/swift-api/services/AssistantV1/Structs/UpdateIntent.html +++ b/docs/swift-api/services/AssistantV1/Structs/UpdateIntent.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

UpdateIntent

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +
@@ -408,7 +411,11 @@

Declaration

Declaration

Swift

-
public init(intent: String? = nil, description: String? = nil, examples: [CreateExample]? = nil)
+
public init(
+    intent: String? = nil,
+    description: String? = nil,
+    examples: [CreateExample]? = nil
+)
@@ -424,7 +431,13 @@

Parameters

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +

@@ -467,7 +480,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/UpdateSynonym.html b/docs/swift-api/services/AssistantV1/Structs/UpdateSynonym.html index afeae3c7c..0d6bcda8b 100644 --- a/docs/swift-api/services/AssistantV1/Structs/UpdateSynonym.html +++ b/docs/swift-api/services/AssistantV1/Structs/UpdateSynonym.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

UpdateSynonym

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -354,7 +357,9 @@

Declaration

Declaration

Swift

-
public init(synonym: String? = nil)
+
public init(
+    synonym: String? = nil
+)
@@ -370,7 +375,13 @@

Parameters

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -389,7 +400,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/UpdateValue.html b/docs/swift-api/services/AssistantV1/Structs/UpdateValue.html index 1945df233..06c018611 100644 --- a/docs/swift-api/services/AssistantV1/Structs/UpdateValue.html +++ b/docs/swift-api/services/AssistantV1/Structs/UpdateValue.html @@ -170,9 +170,6 @@ - @@ -348,7 +345,13 @@

Declaration

-

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the entity value. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -429,7 +432,14 @@

Declaration

-

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following resrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), +but not both. A synonym must conform to the following resrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -456,7 +466,10 @@

Declaration

-

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

+

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), +but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to +specify a pattern, see the +documentation.

@@ -490,7 +503,13 @@

Declaration

Declaration

Swift

-
public init(value: String? = nil, metadata: [String: JSON]? = nil, valueType: String? = nil, synonyms: [String]? = nil, patterns: [String]? = nil)
+
public init(
+    value: String? = nil,
+    metadata: [String: JSON]? = nil,
+    valueType: String? = nil,
+    synonyms: [String]? = nil,
+    patterns: [String]? = nil
+)
@@ -506,7 +525,13 @@

Parameters

-

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the entity value. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -542,7 +567,14 @@

Parameters

-

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following resrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by +type), but not both. A synonym must conform to the following resrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -554,7 +586,10 @@

Parameters

-

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

+

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by +type), but not both. A pattern is a regular expression no longer than 128 characters. For more information +about how to specify a pattern, see the +documentation.

@@ -573,7 +608,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/UpdateValue/ValueType.html b/docs/swift-api/services/AssistantV1/Structs/UpdateValue/ValueType.html index fb4c74bd7..38ebd1931 100644 --- a/docs/swift-api/services/AssistantV1/Structs/UpdateValue/ValueType.html +++ b/docs/swift-api/services/AssistantV1/Structs/UpdateValue/ValueType.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/UpdateWorkspace.html b/docs/swift-api/services/AssistantV1/Structs/UpdateWorkspace.html index a89c8b721..936a15c79 100644 --- a/docs/swift-api/services/AssistantV1/Structs/UpdateWorkspace.html +++ b/docs/swift-api/services/AssistantV1/Structs/UpdateWorkspace.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,8 @@

UpdateWorkspace

-

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

+

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be +no longer than 64 characters.

@@ -347,7 +345,8 @@

Declaration

-

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -536,7 +535,8 @@

Declaration

-

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that +workspace training data is not to be used.

@@ -570,7 +570,17 @@

Declaration

Declaration

Swift

-
public init(name: String? = nil, description: String? = nil, language: String? = nil, intents: [CreateIntent]? = nil, entities: [CreateEntity]? = nil, dialogNodes: [CreateDialogNode]? = nil, counterexamples: [CreateCounterexample]? = nil, metadata: [String: JSON]? = nil, learningOptOut: Bool? = nil)
+
public init(
+    name: String? = nil,
+    description: String? = nil,
+    language: String? = nil,
+    intents: [CreateIntent]? = nil,
+    entities: [CreateEntity]? = nil,
+    dialogNodes: [CreateDialogNode]? = nil,
+    counterexamples: [CreateCounterexample]? = nil,
+    metadata: [String: JSON]? = nil,
+    learningOptOut: Bool? = nil
+)
@@ -586,7 +596,8 @@

Parameters

-

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

+

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be +no longer than 64 characters.

@@ -598,7 +609,8 @@

Parameters

-

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -682,7 +694,8 @@

Parameters

-

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace can be used by IBM for general service improvements. true indicates +that workspace training data is not to be used.

@@ -701,7 +714,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/Structs/Value.html b/docs/swift-api/services/AssistantV1/Structs/Value.html index 28e262aba..7168d215f 100644 --- a/docs/swift-api/services/AssistantV1/Structs/Value.html +++ b/docs/swift-api/services/AssistantV1/Structs/Value.html @@ -170,9 +170,6 @@ - @@ -529,7 +526,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/Value/ValueType.html b/docs/swift-api/services/AssistantV1/Structs/Value/ValueType.html index bbd439992..6adc9e484 100644 --- a/docs/swift-api/services/AssistantV1/Structs/Value/ValueType.html +++ b/docs/swift-api/services/AssistantV1/Structs/Value/ValueType.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/ValueCollection.html b/docs/swift-api/services/AssistantV1/Structs/ValueCollection.html index 6df80f481..d1a9ab485 100644 --- a/docs/swift-api/services/AssistantV1/Structs/ValueCollection.html +++ b/docs/swift-api/services/AssistantV1/Structs/ValueCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/ValueExport.html b/docs/swift-api/services/AssistantV1/Structs/ValueExport.html index 313dee3d9..50a6c277a 100644 --- a/docs/swift-api/services/AssistantV1/Structs/ValueExport.html +++ b/docs/swift-api/services/AssistantV1/Structs/ValueExport.html @@ -170,9 +170,6 @@ - @@ -529,7 +526,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/ValueExport/ValueType.html b/docs/swift-api/services/AssistantV1/Structs/ValueExport/ValueType.html index 2bbf301df..733b2e29c 100644 --- a/docs/swift-api/services/AssistantV1/Structs/ValueExport/ValueType.html +++ b/docs/swift-api/services/AssistantV1/Structs/ValueExport/ValueType.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/Workspace.html b/docs/swift-api/services/AssistantV1/Structs/Workspace.html index 844ed406b..cc7fa593a 100644 --- a/docs/swift-api/services/AssistantV1/Structs/Workspace.html +++ b/docs/swift-api/services/AssistantV1/Structs/Workspace.html @@ -170,9 +170,6 @@ - @@ -509,7 +506,8 @@

Declaration

-

Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for +general service improvements. true indicates that workspace training data is not to be used.

@@ -528,7 +526,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/WorkspaceCollection.html b/docs/swift-api/services/AssistantV1/Structs/WorkspaceCollection.html index 74d3d6a18..4d4dc0eec 100644 --- a/docs/swift-api/services/AssistantV1/Structs/WorkspaceCollection.html +++ b/docs/swift-api/services/AssistantV1/Structs/WorkspaceCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/WorkspaceExport.html b/docs/swift-api/services/AssistantV1/Structs/WorkspaceExport.html index 0255073b1..54cfa797f 100644 --- a/docs/swift-api/services/AssistantV1/Structs/WorkspaceExport.html +++ b/docs/swift-api/services/AssistantV1/Structs/WorkspaceExport.html @@ -170,9 +170,6 @@ - @@ -564,7 +561,8 @@

Declaration

-

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that +workspace training data is not to be used.

@@ -691,7 +689,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/Structs/WorkspaceExport/Status.html b/docs/swift-api/services/AssistantV1/Structs/WorkspaceExport/Status.html index 9057f1c48..c70d754fe 100644 --- a/docs/swift-api/services/AssistantV1/Structs/WorkspaceExport/Status.html +++ b/docs/swift-api/services/AssistantV1/Structs/WorkspaceExport/Status.html @@ -170,9 +170,6 @@ - @@ -447,7 +444,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Classes.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Classes.html index ba4ed8699..789b42c66 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Classes.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Classes.html @@ -170,9 +170,6 @@ - @@ -314,8 +311,8 @@

Classes

-

The IBM Watson Assistant service combines machine learning, natural language understanding, and integrated dialog tools -to create conversation flows between your apps and your users.

+

The IBM Watson™ Assistant service combines machine learning, natural language understanding, and integrated +dialog tools to create conversation flows between your apps and your users.

See more
@@ -335,7 +332,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Classes/Assistant.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Classes/Assistant.html index c762b157c..f9f8805d5 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Classes/Assistant.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Classes/Assistant.html @@ -170,9 +170,6 @@ - @@ -301,8 +298,8 @@

Assistant

-

The IBM Watson Assistant service combines machine learning, natural language understanding, and integrated dialog tools -to create conversation flows between your apps and your users.

+

The IBM Watson™ Assistant service combines machine learning, natural language understanding, and integrated +dialog tools to create conversation flows between your apps and your users.

@@ -605,7 +602,8 @@

Declaration

Get response to user input.

-

Get a response to a user’s input. There is no rate limit for this operation.

+

Get a response to a user’s input. +There is no rate limit for this operation.

@@ -646,8 +644,8 @@

Parameters

-

The message to be sent. This includes the user’s input, along with optional intents, entities, and context from the -last response.

+

The message to be sent. This includes the user’s input, along with optional intents, entities, and context from +the last response.

@@ -659,8 +657,8 @@

Parameters

-

Whether to include additional diagnostic information about the dialog nodes that were visited during processing of -the message.

+

Whether to include additional diagnostic information about the dialog nodes that were visited during processing +of the message.

@@ -721,8 +719,8 @@

Parameters

List workspaces.

-

List the workspaces associated with a Watson Assistant service instance. This operation is limited to 500 -requests per 30 minutes. For more information, see Rate limiting.

+

List the workspaces associated with a Watson Assistant service instance. +This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

@@ -864,8 +862,8 @@

Parameters

Create workspace.

Create a workspace based on component objects. You must provide workspace components defining the content of the -new workspace. This operation is limited to 30 requests per 30 minutes. For more information, see Rate -limiting.

+new workspace. +This operation is limited to 30 requests per 30 minutes. For more information, see Rate limiting.

@@ -892,8 +890,9 @@

Parameters

-

The content of the new workspace. The maximum size for this data is 50MB. If you need to import a larger -workspace, consider importing the workspace without intents and entities and then adding them separately.

+

The content of the new workspace. +The maximum size for this data is 50MB. If you need to import a larger workspace, consider importing the +workspace without intents and entities and then adding them separately.

@@ -954,9 +953,9 @@

Parameters

Get information about a workspace.

-

Get information about a workspace, optionally including all workspace content. With export=false, this -operation is limited to 6000 requests per 5 minutes. With export=true, the limit is 20 requests per 30 -minutes. For more information, see Rate limiting.

+

Get information about a workspace, optionally including all workspace content. +With export=false, this operation is limited to 6000 requests per 5 minutes. With export=true, the +limit is 20 requests per 30 minutes. For more information, see Rate limiting.

@@ -997,8 +996,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -1072,8 +1071,8 @@

Parameters

Update workspace.

Update an existing workspace with new or modified data. You must provide component objects defining the content of -the updated workspace. This operation is limited to 30 request per 30 minutes. For more information, see Rate -limiting.

+the updated workspace. +This operation is limited to 30 request per 30 minutes. For more information, see Rate limiting.

@@ -1114,9 +1113,9 @@

Parameters

-

Valid data defining the new and updated workspace content. The maximum size for this data is 50MB. If you need -to import a larger amount of workspace data, consider importing components such as intents and entities using -separate operations.

+

Valid data defining the new and updated workspace content. +The maximum size for this data is 50MB. If you need to import a larger amount of workspace data, consider +importing components such as intents and entities using separate operations.

@@ -1131,8 +1130,9 @@

Parameters

Whether the new data is to be appended to the existing data in the workspace. If append=false, elements included in the new data completely replace the corresponding existing elements, including all subelements. For example, if the new data includes entities and append=false, all existing entities in the workspace are -discarded and replaced with the new entities. If append=true, existing elements are preserved, and the new -elements are added. If any elements in the new data collide with existing elements, the update request fails.

+discarded and replaced with the new entities. +If append=true, existing elements are preserved, and the new elements are added. If any elements in the new +data collide with existing elements, the update request fails.

@@ -1193,8 +1193,8 @@

Parameters

Delete workspace.

-

Delete a workspace from the service instance. This operation is limited to 30 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete a workspace from the service instance. +This operation is limited to 30 requests per 30 minutes. For more information, see Rate limiting.

@@ -1282,9 +1282,9 @@

Parameters

List intents.

-

List the intents for a workspace. With export=false, this operation is limited to 2000 requests per 30 -minutes. With export=true, the limit is 400 requests per 30 minutes. For more information, see Rate -limiting.

+

List the intents for a workspace. +With export=false, this operation is limited to 2000 requests per 30 minutes. With export=true, the +limit is 400 requests per 30 minutes. For more information, see Rate limiting.

@@ -1329,8 +1329,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -1452,8 +1452,8 @@

Parameters

Create intent.

-

Create a new intent. This operation is limited to 2000 requests per 30 minutes. For more information, see Rate -limiting.

+

Create a new intent. +This operation is limited to 2000 requests per 30 minutes. For more information, see Rate limiting.

@@ -1495,9 +1495,13 @@

Parameters

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode -alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It -must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +

@@ -1509,8 +1513,8 @@

Parameters

-

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must -be no longer than 128 characters.

+

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -1583,9 +1587,9 @@

Parameters

Get intent.

-

Get information about an intent, optionally including all intent content. With export=false, this -operation is limited to 6000 requests per 5 minutes. With export=true, the limit is 400 requests per 30 -minutes. For more information, see Rate limiting.

+

Get information about an intent, optionally including all intent content. +With export=false, this operation is limited to 6000 requests per 5 minutes. With export=true, the +limit is 400 requests per 30 minutes. For more information, see Rate limiting.

@@ -1639,8 +1643,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -1714,8 +1718,8 @@

Parameters

Update intent.

Update an existing intent with new or modified data. You must provide component objects defining the content of the -updated intent. This operation is limited to 2000 requests per 30 minutes. For more information, see Rate -limiting.

+updated intent. +This operation is limited to 2000 requests per 30 minutes. For more information, see Rate limiting.

@@ -1770,9 +1774,13 @@

Parameters

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode -alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It -must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +

@@ -1857,8 +1865,8 @@

Parameters

Delete intent.

-

Delete an intent from a workspace. This operation is limited to 2000 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete an intent from a workspace. +This operation is limited to 2000 requests per 30 minutes. For more information, see Rate limiting.

@@ -1959,8 +1967,8 @@

Parameters

List user input examples.

-

List the user input examples for an intent. This operation is limited to 2500 requests per 30 minutes. For more -information, see Rate limiting.

+

List the user input examples for an intent. +This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

@@ -2127,8 +2135,8 @@

Parameters

Create user input example.

-

Add a new user input example to an intent. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Add a new user input example to an intent. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -2181,9 +2189,13 @@

Parameters

-

The text of a user input example. This string must conform to the following restrictions: - It cannot contain -carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no -longer than 1024 characters.

+

The text of a user input example. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +

@@ -2244,8 +2256,8 @@

Parameters

Get user input example.

-

Get information about a user input example. This operation is limited to 6000 requests per 5 minutes. For more -information, see Rate limiting.

+

Get information about a user input example. +This operation is limited to 6000 requests per 5 minutes. For more information, see Rate limiting.

@@ -2372,8 +2384,8 @@

Parameters

Update user input example.

-

Update the text of a user input example. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Update the text of a user input example. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -2439,9 +2451,13 @@

Parameters

-

The text of the user input example. This string must conform to the following restrictions: - It cannot contain -carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no -longer than 1024 characters.

+

The text of the user input example. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +

@@ -2502,8 +2518,8 @@

Parameters

Delete user input example.

-

Delete a user input example from an intent. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete a user input example from an intent. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -2618,7 +2634,7 @@

Parameters

List counterexamples.

List the counterexamples for a workspace. Counterexamples are examples that have been marked as irrelevant input. - This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

+This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

@@ -2813,9 +2829,13 @@

Parameters

-

The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It -cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It -must be no longer than 1024 characters.

+

The text of a user input marked as irrelevant input. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters
  • +
  • It cannot consist of only whitespace characters
  • +
  • It must be no longer than 1024 characters.
  • +

@@ -3107,7 +3127,7 @@

Parameters

Delete counterexample.

Delete a counterexample from a workspace. Counterexamples are examples that have been marked as irrelevant input. - This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

+This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -3208,9 +3228,9 @@

Parameters

List entities.

-

List the entities for a workspace. With export=false, this operation is limited to 1000 requests per 30 -minutes. With export=true, the limit is 200 requests per 30 minutes. For more information, see Rate -limiting.

+

List the entities for a workspace. +With export=false, this operation is limited to 1000 requests per 30 minutes. With export=true, the +limit is 200 requests per 30 minutes. For more information, see Rate limiting.

@@ -3255,8 +3275,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -3378,8 +3398,8 @@

Parameters

Create entity.

-

Create a new entity. This operation is limited to 1000 requests per 30 minutes. For more information, see Rate -limiting.

+

Create a new entity. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -3480,9 +3500,9 @@

Parameters

Get entity.

-

Get information about an entity, optionally including all entity content. With export=false, this -operation is limited to 6000 requests per 5 minutes. With export=true, the limit is 200 requests per 30 -minutes. For more information, see Rate limiting.

+

Get information about an entity, optionally including all entity content. +With export=false, this operation is limited to 6000 requests per 5 minutes. With export=true, the +limit is 200 requests per 30 minutes. For more information, see Rate limiting.

@@ -3536,8 +3556,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -3611,8 +3631,8 @@

Parameters

Update entity.

Update an existing entity with new or modified data. You must provide component objects defining the content of the -updated entity. This operation is limited to 1000 requests per 30 minutes. For more information, see Rate -limiting.

+updated entity. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -3667,8 +3687,8 @@

Parameters

The updated content of the entity. Any elements included in the new data will completely replace the equivalent existing elements, including all subelements. (Previously existing subelements are not retained unless they are -also included in the new data.) For example, if you update the values for an entity, the previously existing values -are discarded and replaced with the new values specified in the update.

+also included in the new data.) For example, if you update the values for an entity, the previously existing +values are discarded and replaced with the new values specified in the update.

@@ -3729,8 +3749,8 @@

Parameters

Delete entity.

-

Delete an entity from a workspace. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete an entity from a workspace. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -3831,8 +3851,8 @@

Parameters

List entity values.

-

List the values for an entity. This operation is limited to 2500 requests per 30 minutes. For more information, -see Rate limiting.

+

List the values for an entity. +This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

@@ -3890,8 +3910,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -4013,8 +4033,8 @@

Parameters

Add entity value.

-

Create a new value for an entity. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Create a new value for an entity. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -4128,8 +4148,8 @@

Parameters

Get entity value.

-

Get information about an entity value. This operation is limited to 6000 requests per 5 minutes. For more -information, see Rate limiting.

+

Get information about an entity value. +This operation is limited to 6000 requests per 5 minutes. For more information, see Rate limiting.

@@ -4196,8 +4216,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -4271,8 +4291,8 @@

Parameters

Update entity value.

Update an existing entity value with new or modified data. You must provide component objects defining the content -of the updated entity value. This operation is limited to 1000 requests per 30 minutes. For more information, -see Rate limiting.

+of the updated entity value. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -4338,10 +4358,11 @@

Parameters

-

The updated content of the entity value. Any elements included in the new data will completely replace the -equivalent existing elements, including all subelements. (Previously existing subelements are not retained unless -they are also included in the new data.) For example, if you update the synonyms for an entity value, the -previously existing synonyms are discarded and replaced with the new synonyms specified in the update.

+

The updated content of the entity value. +Any elements included in the new data will completely replace the equivalent existing elements, including all +subelements. (Previously existing subelements are not retained unless they are also included in the new data.) +For example, if you update the synonyms for an entity value, the previously existing synonyms are discarded and +replaced with the new synonyms specified in the update.

@@ -4402,8 +4423,8 @@

Parameters

Delete entity value.

-

Delete a value from an entity. This operation is limited to 1000 requests per 30 minutes. For more information, -see Rate limiting.

+

Delete a value from an entity. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -4517,8 +4538,8 @@

Parameters

List entity value synonyms.

-

List the synonyms for an entity value. This operation is limited to 2500 requests per 30 minutes. For more -information, see Rate limiting.

+

List the synonyms for an entity value. +This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

@@ -4698,8 +4719,8 @@

Parameters

Add entity value synonym.

-

Add a new synonym to an entity value. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Add a new synonym to an entity value. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -4765,9 +4786,13 @@

Parameters

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage -return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer -than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -4828,8 +4853,8 @@

Parameters

Get entity value synonym.

-

Get information about a synonym of an entity value. This operation is limited to 6000 requests per 5 minutes. -For more information, see Rate limiting.

+

Get information about a synonym of an entity value. +This operation is limited to 6000 requests per 5 minutes. For more information, see Rate limiting.

@@ -4969,8 +4994,8 @@

Parameters

Update entity value synonym.

-

Update an existing entity value synonym with new text. This operation is limited to 1000 requests per 30 -minutes. For more information, see Rate limiting.

+

Update an existing entity value synonym with new text. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -5049,9 +5074,13 @@

Parameters

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage -return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer -than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -5112,8 +5141,8 @@

Parameters

Delete entity value synonym.

-

Delete a synonym from an entity value. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete a synonym from an entity value. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -5240,8 +5269,8 @@

Parameters

List dialog nodes.

-

List the dialog nodes for a workspace. This operation is limited to 2500 requests per 30 minutes. For more -information, see Rate limiting.

+

List the dialog nodes for a workspace. +This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

@@ -5395,8 +5424,8 @@

Parameters

Create dialog node.

-

Create a new dialog node. This operation is limited to 500 requests per 30 minutes. For more information, see -Rate limiting.

+

Create a new dialog node. +This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

@@ -5497,8 +5526,8 @@

Parameters

Get dialog node.

-

Get information about a dialog node. This operation is limited to 6000 requests per 5 minutes. For more -information, see Rate limiting.

+

Get information about a dialog node. +This operation is limited to 6000 requests per 5 minutes. For more information, see Rate limiting.

@@ -5612,8 +5641,8 @@

Parameters

Update dialog node.

-

Update an existing dialog node with new or modified data. This operation is limited to 500 requests per 30 -minutes. For more information, see Rate limiting.

+

Update an existing dialog node with new or modified data. +This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

@@ -5666,10 +5695,11 @@

Parameters

-

The updated content of the dialog node. Any elements included in the new data will completely replace the -equivalent existing elements, including all subelements. (Previously existing subelements are not retained unless -they are also included in the new data.) For example, if you update the actions for a dialog node, the previously -existing actions are discarded and replaced with the new actions specified in the update.

+

The updated content of the dialog node. +Any elements included in the new data will completely replace the equivalent existing elements, including all +subelements. (Previously existing subelements are not retained unless they are also included in the new data.) +For example, if you update the actions for a dialog node, the previously existing actions are discarded and +replaced with the new actions specified in the update.

@@ -5730,8 +5760,8 @@

Parameters

Delete dialog node.

-

Delete a dialog node from a workspace. This operation is limited to 500 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete a dialog node from a workspace. +This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

@@ -5832,9 +5862,9 @@

Parameters

List log events in a workspace.

-

List the events from the log of a specific workspace. If cursor is not specified, this operation is limited -to 40 requests per 30 minutes. If cursor is specified, the limit is 120 requests per minute. For more -information, see Rate limiting.

+

List the events from the log of a specific workspace. +If cursor is not specified, this operation is limited to 40 requests per 30 minutes. If cursor is +specified, the limit is 120 requests per minute. For more information, see Rate limiting.

@@ -5890,7 +5920,8 @@

Parameters

-

A cacheable parameter that limits the results to those matching the specified filter. For more information, see the +

A cacheable parameter that limits the results to those matching the specified filter. For more information, see +the documentation.

@@ -5976,9 +6007,9 @@

Parameters

List log events in all workspaces.

-

List the events from the logs of all workspaces in the service instance. If cursor is not specified, this -operation is limited to 40 requests per 30 minutes. If cursor is specified, the limit is 120 requests per -minute. For more information, see Rate limiting.

+

List the events from the logs of all workspaces in the service instance. +If cursor is not specified, this operation is limited to 40 requests per 30 minutes. If cursor is +specified, the limit is 120 requests per minute. For more information, see Rate limiting.

@@ -6110,8 +6141,9 @@

Parameters

Delete labeled data.

Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with -the customer ID. You associate a customer ID with data by passing the X-Watson-Metadata header with a request -that passes data. For more information about personal data and customer IDs, see Information +the customer ID. +You associate a customer ID with data by passing the X-Watson-Metadata header with a request that passes data. +For more information about personal data and customer IDs, see Information security.

@@ -6190,7 +6222,7 @@

Parameters

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Enums.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Enums.html index 97f77788d..e4ca8d15d 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Enums.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Enums.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html index 98150f602..0b592c9fd 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html @@ -170,9 +170,6 @@ - @@ -636,7 +633,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html index 8ab9a05e5..635a6043a 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html @@ -170,9 +170,6 @@ - @@ -503,7 +500,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs.html index f538c76bf..8543ffb3e 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs.html @@ -170,9 +170,6 @@ - @@ -2027,49 +2024,10 @@

Declaration

-
-
- - - -

JSON

-
-
-
    -
  • -
    - - - - JSONWrapper - -
    -
    -
    -
    -
    -
    -

    Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct JSONWrapper
    - -
    -
    -
    -
    -
  • -
-
diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CaptureGroup.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CaptureGroup.html index 503c119cf..2a85d1b7d 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CaptureGroup.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CaptureGroup.html @@ -170,9 +170,6 @@ - @@ -381,7 +378,10 @@

Declaration

Declaration

Swift

-
public init(group: String, location: [Int]? = nil)
+
public init(
+    group: String,
+    location: [Int]? = nil
+)
@@ -428,7 +428,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Context.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Context.html index 41f7557ef..f38828b9c 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Context.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Context.html @@ -170,9 +170,6 @@ - @@ -408,7 +405,11 @@

Declaration

Declaration

Swift

-
public init(conversationID: String? = nil, system: SystemResponse? = nil, additionalProperties: [String: JSON] = [:])
+
public init(
+    conversationID: String? = nil,
+    system: SystemResponse? = nil,
+    additionalProperties: [String: JSON] = [:]
+)
@@ -507,7 +508,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Counterexample.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Counterexample.html index 6eb821de1..823e87cf8 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Counterexample.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Counterexample.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CounterexampleCollection.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CounterexampleCollection.html index b1621c8fd..2e3de6d4e 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CounterexampleCollection.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CounterexampleCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateCounterexample.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateCounterexample.html index 6cf0d0bb7..bef33f794 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateCounterexample.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateCounterexample.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

CreateCounterexample

-

The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It must be no longer than 1024 characters.

+

The text of a user input marked as irrelevant input. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters
  • +
  • It cannot consist of only whitespace characters
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -354,7 +357,9 @@

Declaration

Declaration

Swift

-
public init(text: String)
+
public init(
+    text: String
+)
@@ -370,7 +375,13 @@

Parameters

-

The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It must be no longer than 1024 characters.

+

The text of a user input marked as irrelevant input. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters
  • +
  • It cannot consist of only whitespace characters
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -389,7 +400,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode.html index 381f9fb52..3fc5ca83b 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode.html @@ -170,9 +170,6 @@ - @@ -460,7 +457,12 @@

Declaration

-

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

+

The dialog node ID. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -487,7 +489,8 @@

Declaration

-

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -514,7 +517,8 @@

Declaration

-

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab +characters, and it must be no longer than 2048 characters.

@@ -595,7 +599,8 @@

Declaration

-

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

+

The output of the dialog node. For more information about how to specify dialog node output, see the +documentation.

@@ -730,7 +735,12 @@

Declaration

-

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

+

The alias used to identify the dialog node. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -926,7 +936,25 @@

Declaration

Declaration

Swift

-
public init(dialogNode: String, description: String? = nil, conditions: String? = nil, parent: String? = nil, previousSibling: String? = nil, output: [String: JSON]? = nil, context: [String: JSON]? = nil, metadata: [String: JSON]? = nil, nextStep: DialogNodeNextStep? = nil, actions: [DialogNodeAction]? = nil, title: String? = nil, nodeType: String? = nil, eventName: String? = nil, variable: String? = nil, digressIn: String? = nil, digressOut: String? = nil, digressOutSlots: String? = nil)
+
public init(
+    dialogNode: String,
+    description: String? = nil,
+    conditions: String? = nil,
+    parent: String? = nil,
+    previousSibling: String? = nil,
+    output: [String: JSON]? = nil,
+    context: [String: JSON]? = nil,
+    metadata: [String: JSON]? = nil,
+    nextStep: DialogNodeNextStep? = nil,
+    actions: [DialogNodeAction]? = nil,
+    title: String? = nil,
+    nodeType: String? = nil,
+    eventName: String? = nil,
+    variable: String? = nil,
+    digressIn: String? = nil,
+    digressOut: String? = nil,
+    digressOutSlots: String? = nil
+)
@@ -942,7 +970,12 @@

Parameters

-

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

+

The dialog node ID. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 1024 characters.
  • +

@@ -954,7 +987,8 @@

Parameters

-

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and +it must be no longer than 128 characters.

@@ -966,7 +1000,8 @@

Parameters

-

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab +characters, and it must be no longer than 2048 characters.

@@ -1002,7 +1037,8 @@

Parameters

-

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

+

The output of the dialog node. For more information about how to specify dialog node output, see the +documentation.

@@ -1062,7 +1098,12 @@

Parameters

-

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

+

The alias used to identify the dialog node. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -1153,7 +1194,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressIn.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressIn.html index 026c903d5..f81a55c9e 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressIn.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressIn.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressOut.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressOut.html index 1bd1ebe89..adcf9afc0 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressOut.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressOut.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressOutSlots.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressOutSlots.html index f7cedcfc4..10e004b0b 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressOutSlots.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressOutSlots.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/EventName.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/EventName.html index 136bec4fe..b6a2925ec 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/EventName.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/EventName.html @@ -170,9 +170,6 @@ - @@ -555,7 +552,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/NodeType.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/NodeType.html index a6b890883..172733bd2 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/NodeType.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/NodeType.html @@ -170,9 +170,6 @@ - @@ -474,7 +471,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateEntity.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateEntity.html index 6c88ad9fc..3ca291961 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateEntity.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateEntity.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

CreateEntity

-

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

+

The name of the entity. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, underscore, and hyphen characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -347,7 +350,8 @@

Declaration

-

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must +be no longer than 128 characters.

@@ -462,7 +466,13 @@

Declaration

Declaration

Swift

-
public init(entity: String, description: String? = nil, metadata: [String: JSON]? = nil, values: [CreateValue]? = nil, fuzzyMatch: Bool? = nil)
+
public init(
+    entity: String,
+    description: String? = nil,
+    metadata: [String: JSON]? = nil,
+    values: [CreateValue]? = nil,
+    fuzzyMatch: Bool? = nil
+)
@@ -478,7 +488,13 @@

Parameters

-

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

+

The name of the entity. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, and hyphen characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -490,7 +506,8 @@

Parameters

-

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -545,7 +562,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateExample.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateExample.html index 33dcd404a..b2429caf3 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateExample.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateExample.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

CreateExample

-

The text of a user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

+

The text of a user input example. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -354,7 +357,9 @@

Declaration

Declaration

Swift

-
public init(text: String)
+
public init(
+    text: String
+)
@@ -370,7 +375,13 @@

Parameters

-

The text of a user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

+

The text of a user input example. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -389,7 +400,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateIntent.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateIntent.html index 0874cc2fa..56f77ed1c 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateIntent.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateIntent.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

CreateIntent

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +
@@ -347,7 +350,8 @@

Declaration

-

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must +be no longer than 128 characters.

@@ -408,7 +412,11 @@

Declaration

Declaration

Swift

-
public init(intent: String, description: String? = nil, examples: [CreateExample]? = nil)
+
public init(
+    intent: String,
+    description: String? = nil,
+    examples: [CreateExample]? = nil
+)
@@ -424,7 +432,13 @@

Parameters

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +

@@ -436,7 +450,8 @@

Parameters

-

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -467,7 +482,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateSynonym.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateSynonym.html index 0a640ad45..823a02ca5 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateSynonym.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateSynonym.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

CreateSynonym

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -354,7 +357,9 @@

Declaration

Declaration

Swift

-
public init(synonym: String)
+
public init(
+    synonym: String
+)
@@ -370,7 +375,13 @@

Parameters

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -389,7 +400,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateValue.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateValue.html index d82db12a9..8ea7a0d32 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateValue.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateValue.html @@ -170,9 +170,6 @@ - @@ -348,7 +345,13 @@

Declaration

-

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the entity value. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -402,7 +405,14 @@

Declaration

-

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by +type), but not both. A synonym must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -429,7 +439,10 @@

Declaration

-

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

+

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), +but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to +specify a pattern, see the +documentation.

@@ -490,7 +503,13 @@

Declaration

Declaration

Swift

-
public init(value: String, metadata: [String: JSON]? = nil, synonyms: [String]? = nil, patterns: [String]? = nil, valueType: String? = nil)
+
public init(
+    value: String,
+    metadata: [String: JSON]? = nil,
+    synonyms: [String]? = nil,
+    patterns: [String]? = nil,
+    valueType: String? = nil
+)
@@ -506,7 +525,13 @@

Parameters

-

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the entity value. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -530,7 +555,14 @@

Parameters

-

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated +by type), but not both. A synonym must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -542,7 +574,10 @@

Parameters

-

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

+

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by +type), but not both. A pattern is a regular expression no longer than 128 characters. For more information +about how to specify a pattern, see the +documentation.

@@ -573,7 +608,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateValue/ValueType.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateValue/ValueType.html index 1b7b8608a..f038cbfd3 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateValue/ValueType.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateValue/ValueType.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateWorkspace.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateWorkspace.html index e394c3479..84c89e2d2 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateWorkspace.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateWorkspace.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,8 @@

CreateWorkspace

-

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

+

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be +no longer than 64 characters.

@@ -347,7 +345,8 @@

Declaration

-

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -536,7 +535,8 @@

Declaration

-

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that +workspace training data is not to be used.

@@ -570,7 +570,17 @@

Declaration

Declaration

Swift

-
public init(name: String? = nil, description: String? = nil, language: String? = nil, intents: [CreateIntent]? = nil, entities: [CreateEntity]? = nil, dialogNodes: [CreateDialogNode]? = nil, counterexamples: [CreateCounterexample]? = nil, metadata: [String: JSON]? = nil, learningOptOut: Bool? = nil)
+
public init(
+    name: String? = nil,
+    description: String? = nil,
+    language: String? = nil,
+    intents: [CreateIntent]? = nil,
+    entities: [CreateEntity]? = nil,
+    dialogNodes: [CreateDialogNode]? = nil,
+    counterexamples: [CreateCounterexample]? = nil,
+    metadata: [String: JSON]? = nil,
+    learningOptOut: Bool? = nil
+)
@@ -586,7 +596,8 @@

Parameters

-

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

+

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be +no longer than 64 characters.

@@ -598,7 +609,8 @@

Parameters

-

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -682,7 +694,8 @@

Parameters

-

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace can be used by IBM for general service improvements. true indicates +that workspace training data is not to be used.

@@ -701,7 +714,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode.html index 92c528307..14e34f4a7 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode.html @@ -170,9 +170,6 @@ - @@ -568,7 +565,8 @@

Declaration

-

The ID of the previous sibling dialog node. This property is not returned if the dialog node has no previous sibling.

+

The ID of the previous sibling dialog node. This property is not returned if the dialog node has no previous +sibling.

@@ -965,7 +963,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressIn.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressIn.html index fe61a871f..556a17edf 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressIn.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressIn.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressOut.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressOut.html index cfdeb2f5f..fb07b38f1 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressOut.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressOut.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressOutSlots.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressOutSlots.html index 354e93d4c..7bbf7e284 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressOutSlots.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressOutSlots.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/EventName.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/EventName.html index 0cd37a2f0..3ecfbf141 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/EventName.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/EventName.html @@ -170,9 +170,6 @@ - @@ -555,7 +552,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/NodeType.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/NodeType.html index 4f315a4d5..3ae76d0b4 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/NodeType.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/NodeType.html @@ -170,9 +170,6 @@ - @@ -474,7 +471,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeAction.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeAction.html index a7dd5a618..f701f831e 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeAction.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeAction.html @@ -170,9 +170,6 @@ - @@ -490,7 +487,13 @@

Declaration

Declaration

Swift

-
public init(name: String, resultVariable: String, actionType: String? = nil, parameters: [String: JSON]? = nil, credentials: String? = nil)
+
public init(
+    name: String,
+    resultVariable: String,
+    actionType: String? = nil,
+    parameters: [String: JSON]? = nil,
+    credentials: String? = nil
+)
@@ -573,7 +576,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeAction/ActionType.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeAction/ActionType.html index 275d3f50e..bb481f28c 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeAction/ActionType.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeAction/ActionType.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeCollection.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeCollection.html index 39cdf1692..20411b330 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeCollection.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep.html index 96193fe3c..96fd098b2 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,40 @@

DialogNodeNextStep

-

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

+

What happens after the dialog node completes. The valid values depend on the node type:

+ +
    +
  • The following values are valid for any node: + +
      +
    • get_user_input
    • +
    • skip_user_input
    • +
    • jump_to
    • +
  • +
  • If the node is of type event_handler and its parent node is of type slot or frame, additional values are +also valid: + +
      +
    • if event_name=filled and the type of the parent node is slot:
    • +
    • reprompt
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=nomatch and the type of the parent node is slot: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=generic and the type of the parent node is frame: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots +If you specify jump_to, then you must also specify a value for the dialog_node property.
    • +
  • +
See more
@@ -376,7 +406,40 @@

Declaration

-

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

+

What happens after the dialog node completes. The valid values depend on the node type:

+ +
    +
  • The following values are valid for any node: + +
      +
    • get_user_input
    • +
    • skip_user_input
    • +
    • jump_to
    • +
  • +
  • If the node is of type event_handler and its parent node is of type slot or frame, additional values are +also valid: + +
      +
    • if event_name=filled and the type of the parent node is slot:
    • +
    • reprompt
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=nomatch and the type of the parent node is slot: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=generic and the type of the parent node is frame: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots +If you specify jump_to, then you must also specify a value for the dialog_node property.
    • +
  • +
@@ -464,7 +527,11 @@

Declaration

Declaration

Swift

-
public init(behavior: String, dialogNode: String? = nil, selector: String? = nil)
+
public init(
+    behavior: String,
+    dialogNode: String? = nil,
+    selector: String? = nil
+)
@@ -480,7 +547,37 @@

Parameters

-

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

+

What happens after the dialog node completes. The valid values depend on the node type: + +

    +
  • The following values are valid for any node:
  • +
  • get_user_input
  • +
  • skip_user_input
  • +
  • jump_to
  • +
  • If the node is of type event_handler and its parent node is of type slot or frame, additional values are +also valid:
  • +
  • if event_name=filled and the type of the parent node is slot: + +
      +
    • reprompt
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=nomatch and the type of the parent node is slot: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=generic and the type of the parent node is frame: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots +If you specify jump_to, then you must also specify a value for the dialog_node property.
    • +
  • +

@@ -523,7 +620,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep/Behavior.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep/Behavior.html index 53799cdd3..4bd370528 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep/Behavior.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep/Behavior.html @@ -170,9 +170,6 @@ - @@ -301,7 +298,40 @@

Behavior

-

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

+

What happens after the dialog node completes. The valid values depend on the node type:

+ +
    +
  • The following values are valid for any node: + +
      +
    • get_user_input
    • +
    • skip_user_input
    • +
    • jump_to
    • +
  • +
  • If the node is of type event_handler and its parent node is of type slot or frame, additional values are +also valid: + +
      +
    • if event_name=filled and the type of the parent node is slot:
    • +
    • reprompt
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=nomatch and the type of the parent node is slot: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=generic and the type of the parent node is frame: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots +If you specify jump_to, then you must also specify a value for the dialog_node property.
    • +
  • +
@@ -474,7 +504,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep/Selector.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep/Selector.html index 0fde407b9..ef827fc13 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep/Selector.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep/Selector.html @@ -170,9 +170,6 @@ - @@ -420,7 +417,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeVisitedDetails.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeVisitedDetails.html index 91f190b03..922f6a140 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeVisitedDetails.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeVisitedDetails.html @@ -170,9 +170,6 @@ - @@ -408,7 +405,11 @@

Declaration

Declaration

Swift

-
public init(dialogNode: String? = nil, title: String? = nil, conditions: String? = nil)
+
public init(
+    dialogNode: String? = nil,
+    title: String? = nil,
+    conditions: String? = nil
+)
@@ -467,7 +468,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Entity.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Entity.html index 631fa015b..2da990277 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Entity.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Entity.html @@ -170,9 +170,6 @@ - @@ -474,7 +471,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/EntityCollection.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/EntityCollection.html index 7ad62efa9..2d0729d5b 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/EntityCollection.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/EntityCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/EntityExport.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/EntityExport.html index c074afef5..f6b8cae60 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/EntityExport.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/EntityExport.html @@ -170,9 +170,6 @@ - @@ -501,7 +498,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Example.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Example.html index afaba25f0..ffb77f1e2 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Example.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Example.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/ExampleCollection.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/ExampleCollection.html index 65174f946..c16e1fbae 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/ExampleCollection.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/ExampleCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/InputData.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/InputData.html index 6e31e84f1..69c3dfe95 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/InputData.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/InputData.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,8 @@

InputData

-

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be +no longer than 2048 characters.

@@ -354,7 +352,9 @@

Declaration

Declaration

Swift

-
public init(text: String)
+
public init(
+    text: String
+)
@@ -370,7 +370,8 @@

Parameters

-

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must +be no longer than 2048 characters.

@@ -389,7 +390,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Intent.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Intent.html index 7962ff256..f71f20837 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Intent.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Intent.html @@ -170,9 +170,6 @@ - @@ -420,7 +417,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/IntentCollection.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/IntentCollection.html index 9da1b6cfc..8a207a70e 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/IntentCollection.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/IntentCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/IntentExport.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/IntentExport.html index e3075719b..efa900484 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/IntentExport.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/IntentExport.html @@ -170,9 +170,6 @@ - @@ -447,7 +444,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/LogCollection.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/LogCollection.html index ed320d29b..31921ffa5 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/LogCollection.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/LogCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/LogExport.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/LogExport.html index fd351f5d2..175396872 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/LogExport.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/LogExport.html @@ -170,9 +170,6 @@ - @@ -501,7 +498,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/LogMessage.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/LogMessage.html index 25893ef7b..f1b081e52 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/LogMessage.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/LogMessage.html @@ -170,9 +170,6 @@ - @@ -436,7 +433,11 @@

Declaration

Declaration

Swift

-
public init(level: String, msg: String, additionalProperties: [String: JSON] = [:])
+
public init(
+    level: String,
+    msg: String,
+    additionalProperties: [String: JSON] = [:]
+)
@@ -535,7 +536,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/LogMessage/Level.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/LogMessage/Level.html index ff2481f78..1c203e6af 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/LogMessage/Level.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/LogMessage/Level.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/LogPagination.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/LogPagination.html index 2c15ee320..247f41791 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/LogPagination.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/LogPagination.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageInput.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageInput.html index f310a375b..181267765 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageInput.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageInput.html @@ -170,9 +170,6 @@ - @@ -339,7 +336,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageRequest.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageRequest.html index c2e5afa1b..e113be139 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageRequest.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageRequest.html @@ -170,9 +170,6 @@ - @@ -374,7 +371,8 @@

Declaration

-

State information for the conversation. Continue a conversation by including the context object from the previous response.

+

State information for the conversation. Continue a conversation by including the context object from the previous +response.

@@ -401,7 +399,8 @@

Declaration

-

Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input.

+

Entities to use when evaluating the message. Include entities from the previous response to continue using those +entities rather than detecting entities in the new input.

@@ -428,7 +427,8 @@

Declaration

-

Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input.

+

Intents to use when evaluating the user input. Include intents from the previous response to continue using those +intents rather than trying to recognize intents in the new input.

@@ -455,7 +455,8 @@

Declaration

-

System output. Include the output from the previous response to maintain intermediate information over multiple requests.

+

System output. Include the output from the previous response to maintain intermediate information over multiple +requests.

@@ -489,7 +490,14 @@

Declaration

Declaration

Swift

-
public init(input: InputData? = nil, alternateIntents: Bool? = nil, context: Context? = nil, entities: [RuntimeEntity]? = nil, intents: [RuntimeIntent]? = nil, output: OutputData? = nil)
+
public init(
+    input: InputData? = nil,
+    alternateIntents: Bool? = nil,
+    context: Context? = nil,
+    entities: [RuntimeEntity]? = nil,
+    intents: [RuntimeIntent]? = nil,
+    output: OutputData? = nil
+)
@@ -529,7 +537,8 @@

Parameters

-

State information for the conversation. Continue a conversation by including the context object from the previous response.

+

State information for the conversation. Continue a conversation by including the context object from the previous +response.

@@ -541,7 +550,8 @@

Parameters

-

Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input.

+

Entities to use when evaluating the message. Include entities from the previous response to continue using those +entities rather than detecting entities in the new input.

@@ -553,7 +563,8 @@

Parameters

-

Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input.

+

Intents to use when evaluating the user input. Include intents from the previous response to continue using those +intents rather than trying to recognize intents in the new input.

@@ -565,7 +576,8 @@

Parameters

-

System output. Include the output from the previous response to maintain intermediate information over multiple requests.

+

System output. Include the output from the previous response to maintain intermediate information over multiple +requests.

@@ -584,7 +596,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageResponse.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageResponse.html index 0a38e5a1f..ead17adff 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageResponse.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageResponse.html @@ -170,9 +170,6 @@ - @@ -527,7 +524,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/OutputData.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/OutputData.html index b7a91af7f..916efdc7e 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/OutputData.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/OutputData.html @@ -170,9 +170,6 @@ - @@ -374,7 +371,8 @@

Declaration

-

An array of the nodes that were triggered to create the response, in the order in which they were visited. This information is useful for debugging and for tracing the path taken through the node tree.

+

An array of the nodes that were triggered to create the response, in the order in which they were visited. This +information is useful for debugging and for tracing the path taken through the node tree.

@@ -401,7 +399,9 @@

Declaration

-

An array of objects containing detailed diagnostic information about the nodes that were triggered during processing of the input message. Included only if nodes_visited_details is set to true in the message request.

+

An array of objects containing detailed diagnostic information about the nodes that were triggered during +processing of the input message. Included only if nodes_visited_details is set to true in the message +request.

@@ -462,7 +462,13 @@

Declaration

Declaration

Swift

-
public init(logMessages: [LogMessage], text: [String], nodesVisited: [String]? = nil, nodesVisitedDetails: [DialogNodeVisitedDetails]? = nil, additionalProperties: [String: JSON] = [:])
+
public init(
+    logMessages: [LogMessage],
+    text: [String],
+    nodesVisited: [String]? = nil,
+    nodesVisitedDetails: [DialogNodeVisitedDetails]? = nil,
+    additionalProperties: [String: JSON] = [:]
+)
@@ -502,7 +508,8 @@

Parameters

-

An array of the nodes that were triggered to create the response, in the order in which they were visited. This information is useful for debugging and for tracing the path taken through the node tree.

+

An array of the nodes that were triggered to create the response, in the order in which they were visited. This +information is useful for debugging and for tracing the path taken through the node tree.

@@ -514,7 +521,9 @@

Parameters

-

An array of objects containing detailed diagnostic information about the nodes that were triggered during processing of the input message. Included only if nodes_visited_details is set to true in the message request.

+

An array of objects containing detailed diagnostic information about the nodes that were triggered during +processing of the input message. Included only if nodes_visited_details is set to true in the message +request.

@@ -585,7 +594,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Pagination.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Pagination.html index 88a8a34a3..4c504906c 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Pagination.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Pagination.html @@ -170,9 +170,6 @@ - @@ -474,7 +471,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/RuntimeEntity.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/RuntimeEntity.html index 4ce778c6a..1aa647096 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/RuntimeEntity.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/RuntimeEntity.html @@ -170,9 +170,6 @@ - @@ -347,7 +344,8 @@

Declaration

-

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text.

+

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input +text.

@@ -516,7 +514,15 @@

Declaration

Declaration

Swift

-
public init(entity: String, location: [Int], value: String, confidence: Double? = nil, metadata: [String: JSON]? = nil, groups: [CaptureGroup]? = nil, additionalProperties: [String: JSON] = [:])
+
public init(
+    entity: String,
+    location: [Int],
+    value: String,
+    confidence: Double? = nil,
+    metadata: [String: JSON]? = nil,
+    groups: [CaptureGroup]? = nil,
+    additionalProperties: [String: JSON] = [:]
+)
@@ -544,7 +550,8 @@

Parameters

-

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text.

+

An array of zero-based character offsets that indicate where the detected entity values begin and end in the +input text.

@@ -663,7 +670,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/RuntimeIntent.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/RuntimeIntent.html index d70efb48e..82e65e97e 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/RuntimeIntent.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/RuntimeIntent.html @@ -170,9 +170,6 @@ - @@ -408,7 +405,11 @@

Declaration

Declaration

Swift

-
public init(intent: String, confidence: Double, additionalProperties: [String: JSON] = [:])
+
public init(
+    intent: String,
+    confidence: Double,
+    additionalProperties: [String: JSON] = [:]
+)
@@ -507,7 +508,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Synonym.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Synonym.html index cd150b888..58b7f9f9c 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Synonym.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Synonym.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/SynonymCollection.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/SynonymCollection.html index 79ea1376f..b9b14968c 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/SynonymCollection.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/SynonymCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/SystemResponse.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/SystemResponse.html index 728bd4881..f052244c0 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/SystemResponse.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/SystemResponse.html @@ -170,9 +170,6 @@ - @@ -354,7 +351,9 @@

Declaration

Declaration

Swift

-
public init(additionalProperties: [String: JSON] = [:])
+
public init(
+    additionalProperties: [String: JSON] = [:]
+)
@@ -422,7 +421,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateCounterexample.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateCounterexample.html index 00215d685..ceba9e354 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateCounterexample.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateCounterexample.html @@ -170,9 +170,6 @@ - @@ -354,7 +351,9 @@

Declaration

Declaration

Swift

-
public init(text: String? = nil)
+
public init(
+    text: String? = nil
+)
@@ -389,7 +388,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode.html index 725ec329d..648ebbd4b 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode.html @@ -170,9 +170,6 @@ - @@ -460,7 +457,12 @@

Declaration

-

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

+

The dialog node ID. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -487,7 +489,8 @@

Declaration

-

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -514,7 +517,8 @@

Declaration

-

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab +characters, and it must be no longer than 2048 characters.

@@ -595,7 +599,8 @@

Declaration

-

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

+

The output of the dialog node. For more information about how to specify dialog node output, see the +documentation.

@@ -703,7 +708,12 @@

Declaration

-

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

+

The alias used to identify the dialog node. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -926,7 +936,25 @@

Declaration

Declaration

Swift

-
public init(dialogNode: String? = nil, description: String? = nil, conditions: String? = nil, parent: String? = nil, previousSibling: String? = nil, output: [String: JSON]? = nil, context: [String: JSON]? = nil, metadata: [String: JSON]? = nil, nextStep: DialogNodeNextStep? = nil, title: String? = nil, nodeType: String? = nil, eventName: String? = nil, variable: String? = nil, actions: [DialogNodeAction]? = nil, digressIn: String? = nil, digressOut: String? = nil, digressOutSlots: String? = nil)
+
public init(
+    dialogNode: String? = nil,
+    description: String? = nil,
+    conditions: String? = nil,
+    parent: String? = nil,
+    previousSibling: String? = nil,
+    output: [String: JSON]? = nil,
+    context: [String: JSON]? = nil,
+    metadata: [String: JSON]? = nil,
+    nextStep: DialogNodeNextStep? = nil,
+    title: String? = nil,
+    nodeType: String? = nil,
+    eventName: String? = nil,
+    variable: String? = nil,
+    actions: [DialogNodeAction]? = nil,
+    digressIn: String? = nil,
+    digressOut: String? = nil,
+    digressOutSlots: String? = nil
+)
@@ -942,7 +970,12 @@

Parameters

-

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

+

The dialog node ID. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 1024 characters.
  • +

@@ -954,7 +987,8 @@

Parameters

-

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and +it must be no longer than 128 characters.

@@ -966,7 +1000,8 @@

Parameters

-

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab +characters, and it must be no longer than 2048 characters.

@@ -1002,7 +1037,8 @@

Parameters

-

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

+

The output of the dialog node. For more information about how to specify dialog node output, see the +documentation.

@@ -1050,7 +1086,12 @@

Parameters

-

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

+

The alias used to identify the dialog node. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -1153,7 +1194,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressIn.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressIn.html index d6c720e0e..94a96c2c5 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressIn.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressIn.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressOut.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressOut.html index 9d5df78d6..388c5c5cc 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressOut.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressOut.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressOutSlots.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressOutSlots.html index d09b582c1..1c245fe3d 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressOutSlots.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressOutSlots.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/EventName.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/EventName.html index 1d9bf574a..61dbde16c 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/EventName.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/EventName.html @@ -170,9 +170,6 @@ - @@ -555,7 +552,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/NodeType.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/NodeType.html index 02807b463..f0a767d7f 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/NodeType.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/NodeType.html @@ -170,9 +170,6 @@ - @@ -474,7 +471,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateEntity.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateEntity.html index 720892d1c..3579c9a75 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateEntity.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateEntity.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

UpdateEntity

-

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

+

The name of the entity. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, underscore, and hyphen characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -347,7 +350,8 @@

Declaration

-

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must +be no longer than 128 characters.

@@ -462,7 +466,13 @@

Declaration

Declaration

Swift

-
public init(entity: String? = nil, description: String? = nil, metadata: [String: JSON]? = nil, fuzzyMatch: Bool? = nil, values: [CreateValue]? = nil)
+
public init(
+    entity: String? = nil,
+    description: String? = nil,
+    metadata: [String: JSON]? = nil,
+    fuzzyMatch: Bool? = nil,
+    values: [CreateValue]? = nil
+)
@@ -478,7 +488,13 @@

Parameters

-

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

+

The name of the entity. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, and hyphen characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -490,7 +506,8 @@

Parameters

-

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -545,7 +562,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateExample.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateExample.html index 2ea78d9f8..8f6055c1e 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateExample.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateExample.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

UpdateExample

-

The text of the user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

+

The text of the user input example. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -354,7 +357,9 @@

Declaration

Declaration

Swift

-
public init(text: String? = nil)
+
public init(
+    text: String? = nil
+)
@@ -370,7 +375,13 @@

Parameters

-

The text of the user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

+

The text of the user input example. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -389,7 +400,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateIntent.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateIntent.html index b40880da0..c9dd45fc5 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateIntent.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateIntent.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

UpdateIntent

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +
@@ -408,7 +411,11 @@

Declaration

Declaration

Swift

-
public init(intent: String? = nil, description: String? = nil, examples: [CreateExample]? = nil)
+
public init(
+    intent: String? = nil,
+    description: String? = nil,
+    examples: [CreateExample]? = nil
+)
@@ -424,7 +431,13 @@

Parameters

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +

@@ -467,7 +480,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateSynonym.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateSynonym.html index afeae3c7c..0d6bcda8b 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateSynonym.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateSynonym.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

UpdateSynonym

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -354,7 +357,9 @@

Declaration

Declaration

Swift

-
public init(synonym: String? = nil)
+
public init(
+    synonym: String? = nil
+)
@@ -370,7 +375,13 @@

Parameters

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -389,7 +400,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateValue.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateValue.html index 1945df233..06c018611 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateValue.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateValue.html @@ -170,9 +170,6 @@ - @@ -348,7 +345,13 @@

Declaration

-

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the entity value. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -429,7 +432,14 @@

Declaration

-

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following resrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), +but not both. A synonym must conform to the following resrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -456,7 +466,10 @@

Declaration

-

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

+

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), +but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to +specify a pattern, see the +documentation.

@@ -490,7 +503,13 @@

Declaration

Declaration

Swift

-
public init(value: String? = nil, metadata: [String: JSON]? = nil, valueType: String? = nil, synonyms: [String]? = nil, patterns: [String]? = nil)
+
public init(
+    value: String? = nil,
+    metadata: [String: JSON]? = nil,
+    valueType: String? = nil,
+    synonyms: [String]? = nil,
+    patterns: [String]? = nil
+)
@@ -506,7 +525,13 @@

Parameters

-

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the entity value. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -542,7 +567,14 @@

Parameters

-

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following resrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by +type), but not both. A synonym must conform to the following resrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -554,7 +586,10 @@

Parameters

-

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

+

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by +type), but not both. A pattern is a regular expression no longer than 128 characters. For more information +about how to specify a pattern, see the +documentation.

@@ -573,7 +608,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateValue/ValueType.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateValue/ValueType.html index fb4c74bd7..38ebd1931 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateValue/ValueType.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateValue/ValueType.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateWorkspace.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateWorkspace.html index a89c8b721..936a15c79 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateWorkspace.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateWorkspace.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,8 @@

UpdateWorkspace

-

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

+

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be +no longer than 64 characters.

@@ -347,7 +345,8 @@

Declaration

-

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -536,7 +535,8 @@

Declaration

-

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that +workspace training data is not to be used.

@@ -570,7 +570,17 @@

Declaration

Declaration

Swift

-
public init(name: String? = nil, description: String? = nil, language: String? = nil, intents: [CreateIntent]? = nil, entities: [CreateEntity]? = nil, dialogNodes: [CreateDialogNode]? = nil, counterexamples: [CreateCounterexample]? = nil, metadata: [String: JSON]? = nil, learningOptOut: Bool? = nil)
+
public init(
+    name: String? = nil,
+    description: String? = nil,
+    language: String? = nil,
+    intents: [CreateIntent]? = nil,
+    entities: [CreateEntity]? = nil,
+    dialogNodes: [CreateDialogNode]? = nil,
+    counterexamples: [CreateCounterexample]? = nil,
+    metadata: [String: JSON]? = nil,
+    learningOptOut: Bool? = nil
+)
@@ -586,7 +596,8 @@

Parameters

-

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

+

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be +no longer than 64 characters.

@@ -598,7 +609,8 @@

Parameters

-

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -682,7 +694,8 @@

Parameters

-

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace can be used by IBM for general service improvements. true indicates +that workspace training data is not to be used.

@@ -701,7 +714,7 @@

Return Value

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Value.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Value.html index 28e262aba..7168d215f 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Value.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Value.html @@ -170,9 +170,6 @@ - @@ -529,7 +526,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Value/ValueType.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Value/ValueType.html index bbd439992..6adc9e484 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Value/ValueType.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Value/ValueType.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueCollection.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueCollection.html index 6df80f481..d1a9ab485 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueCollection.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueExport.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueExport.html index 313dee3d9..50a6c277a 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueExport.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueExport.html @@ -170,9 +170,6 @@ - @@ -529,7 +526,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueExport/ValueType.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueExport/ValueType.html index 2bbf301df..733b2e29c 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueExport/ValueType.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueExport/ValueType.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Workspace.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Workspace.html index 844ed406b..cc7fa593a 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Workspace.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/Workspace.html @@ -170,9 +170,6 @@ - @@ -509,7 +506,8 @@

Declaration

-

Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for +general service improvements. true indicates that workspace training data is not to be used.

@@ -528,7 +526,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceCollection.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceCollection.html index 74d3d6a18..4d4dc0eec 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceCollection.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceExport.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceExport.html index 0255073b1..54cfa797f 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceExport.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceExport.html @@ -170,9 +170,6 @@ - @@ -564,7 +561,8 @@

Declaration

-

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that +workspace training data is not to be used.

@@ -691,7 +689,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceExport/Status.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceExport/Status.html index 9057f1c48..c70d754fe 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceExport/Status.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceExport/Status.html @@ -170,9 +170,6 @@ - @@ -447,7 +444,7 @@

Declaration

diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/index.html b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/index.html index f9540bdad..46107b165 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/index.html +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/index.html @@ -169,9 +169,6 @@ - @@ -334,7 +331,8 @@

Services

  • Assistant
  • Discovery
  • -
  • Language Translator
  • +
  • Language Translator V2
  • +
  • Language Translator V3
  • Natural Language Classifier
  • Natural Language Understanding
  • Personality Insights
  • @@ -379,7 +377,7 @@

    Swift Package Manager

    Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

    dependencies: [
    -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
    +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
     ]
     

    Service Instances

    @@ -422,7 +420,7 @@

    Username and Password

    API Key

    -

    Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

    +

    Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

    let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
     

    Using IAM

    @@ -657,7 +655,12 @@

    Private Data Collections

  • IBM Discovery - Documentation
  • IBM Discovery - Demo
-

Language Translator

+

Language Translator V2

+ +

Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

@@ -668,6 +671,25 @@

Language Translator

let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} + +

Language Translator V3

+ +

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

+ +

The following example demonstrates how to use the Language Translator service:

+
import LanguageTranslatorV3
+
+let username = "your-username-here"
+let password = "your-password-here"
+let version = "yyyy-mm-dd" // use today's date for the most recent version
+let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
+
 let failure = { (error: Error) in print(error) }
 let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
 languageTranslator.translate(request: request, failure: failure) {
@@ -1058,7 +1080,7 @@ 

Visual Recognition

let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -1066,6 +1088,10 @@

Visual Recognition

print(classifiedImages) }
+ +

Note: a different initializer is used for authentication with instances created before May 23, 2018:

+
let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
+

Using Core ML

The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

@@ -1117,7 +1143,7 @@

Bundlin diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/search.json b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/search.json index fa78cc962..021137ae6 100644 --- a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/search.json +++ b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/Documents/search.json @@ -1 +1 @@ -{"Structs/WorkspaceExport/Status.html#/s:11AssistantV115WorkspaceExportV6StatusO11nonExistentA2EmF":{"name":"nonExistent","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:11AssistantV115WorkspaceExportV6StatusO8trainingA2EmF":{"name":"training","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:11AssistantV115WorkspaceExportV6StatusO6failedA2EmF":{"name":"failed","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:11AssistantV115WorkspaceExportV6StatusO9availableA2EmF":{"name":"available","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:11AssistantV115WorkspaceExportV6StatusO11unavailableA2EmF":{"name":"unavailable","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html":{"name":"Status","abstract":"

The current status of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV4nameSSvp":{"name":"name","abstract":"

The name of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV11descriptionSSvp":{"name":"description","abstract":"

The description of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV8languageSSvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV8metadatas10DictionaryVySSAA4JSONOGvp":{"name":"metadata","abstract":"

Any metadata that is required by the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The workspace ID.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV6statusSSvp":{"name":"status","abstract":"

The current status of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV14learningOptOutSbvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV7intentsSayAA06IntentD0VGSgvp":{"name":"intents","abstract":"

An array of intents.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV8entitiesSayAA06EntityD0VGSgvp":{"name":"entities","abstract":"

An array of entities.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV15counterexamplesSayAA14CounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of counterexamples.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV11dialogNodesSayAA10DialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects describing the dialog nodes in the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceCollection.html#/s:11AssistantV119WorkspaceCollectionV10workspacesSayAA0C0VGvp":{"name":"workspaces","abstract":"

An array of objects describing the workspaces associated with the service instance.

","parent_name":"WorkspaceCollection"},"Structs/WorkspaceCollection.html#/s:11AssistantV119WorkspaceCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

An object defining the pagination data for the returned objects.

","parent_name":"WorkspaceCollection"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV4nameSSvp":{"name":"name","abstract":"

The name of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV8languageSSvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The workspace ID.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

","parent_name":"Workspace"},"Structs/ValueExport/ValueType.html#/s:11AssistantV111ValueExportV0C4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/ValueExport/ValueType.html#/s:11AssistantV111ValueExportV0C4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/ValueExport/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV9valueTextSSvp":{"name":"valueText","abstract":"

The text of the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array containing any patterns for the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV9valueTypeSSvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"ValueExport"},"Structs/ValueCollection.html#/s:11AssistantV115ValueCollectionV6valuesSayAA0C6ExportVGvp":{"name":"values","abstract":"

An array of entity values.

","parent_name":"ValueCollection"},"Structs/ValueCollection.html#/s:11AssistantV115ValueCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

An object defining the pagination data for the returned objects.

","parent_name":"ValueCollection"},"Structs/Value/ValueType.html#/s:11AssistantV15ValueV0C4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/Value/ValueType.html#/s:11AssistantV15ValueV0C4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/Value/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV9valueTextSSvp":{"name":"valueText","abstract":"

The text of the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array containing any patterns for the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV9valueTypeSSvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"Value"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV4nameSSSgvp":{"name":"name","abstract":"

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV8languageSSSgvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV7intentsSayAA12CreateIntentVGSgvp":{"name":"intents","abstract":"

An array of objects defining the intents for the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV8entitiesSayAA12CreateEntityVGSgvp":{"name":"entities","abstract":"

An array of objects defining the entities for the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV11dialogNodesSayAA16CreateDialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects defining the nodes in the workspace dialog.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV15counterexamplesSayAA20CreateCounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of objects defining input examples that have been marked as irrelevant input.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceVACSSSg4name_AD11descriptionAD8languageSayAA12CreateIntentVGSg7intentsSayAA0H6EntityVGSg8entitiesSayAA0H10DialogNodeVGSg11dialogNodesSayAA0H14CounterexampleVGSg15counterexampless10DictionaryVySSAA4JSONOGSg8metadataSbSg14learningOptOuttcfc":{"name":"init(name:description:language:intents:entities:dialogNodes:counterexamples:metadata:learningOptOut:)","abstract":"

Initialize a UpdateWorkspace with member variables.

","parent_name":"UpdateWorkspace"},"Structs/UpdateValue/ValueType.html#/s:11AssistantV111UpdateValueV0D4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/UpdateValue/ValueType.html#/s:11AssistantV111UpdateValueV0D4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/UpdateValue/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueV5valueSSSgvp":{"name":"value","abstract":"

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueV9valueTypeSSSgvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following resrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueVACSSSg5value_s10DictionaryVySSAA4JSONOGSg8metadataAD0E4TypeSaySSGSg8synonymsAO8patternstcfc":{"name":"init(value:metadata:valueType:synonyms:patterns:)","abstract":"

Initialize a UpdateValue with member variables.

","parent_name":"UpdateValue"},"Structs/UpdateSynonym.html#/s:11AssistantV113UpdateSynonymV7synonymSSSgvp":{"name":"synonym","abstract":"

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"UpdateSynonym"},"Structs/UpdateSynonym.html#/s:11AssistantV113UpdateSynonymVACSSSg7synonym_tcfc":{"name":"init(synonym:)","abstract":"

Initialize a UpdateSynonym with member variables.

","parent_name":"UpdateSynonym"},"Structs/UpdateIntent.html#/s:11AssistantV112UpdateIntentV6intentSSSgvp":{"name":"intent","abstract":"

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:11AssistantV112UpdateIntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:11AssistantV112UpdateIntentV8examplesSayAA13CreateExampleVGSgvp":{"name":"examples","abstract":"

An array of user input examples for the intent.

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:11AssistantV112UpdateIntentVACSSSg6intent_AD11descriptionSayAA13CreateExampleVGSg8examplestcfc":{"name":"init(intent:description:examples:)","abstract":"

Initialize a UpdateIntent with member variables.

","parent_name":"UpdateIntent"},"Structs/UpdateExample.html#/s:11AssistantV113UpdateExampleV4textSSSgvp":{"name":"text","abstract":"

The text of the user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

","parent_name":"UpdateExample"},"Structs/UpdateExample.html#/s:11AssistantV113UpdateExampleVACSSSg4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a UpdateExample with member variables.

","parent_name":"UpdateExample"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityV6entitySSSgvp":{"name":"entity","abstract":"

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether to use fuzzy matching for the entity.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityV6valuesSayAA11CreateValueVGSgvp":{"name":"values","abstract":"

An array of entity values.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityVACSSSg6entity_AD11descriptions10DictionaryVySSAA4JSONOGSg8metadataSbSg10fuzzyMatchSayAA11CreateValueVGSg6valuestcfc":{"name":"init(entity:description:metadata:fuzzyMatch:values:)","abstract":"

Initialize a UpdateEntity with member variables.

","parent_name":"UpdateEntity"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:11AssistantV116UpdateDialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:11AssistantV116UpdateDialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:11AssistantV116UpdateDialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOut.html#/s:11AssistantV116UpdateDialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressOut.html#/s:11AssistantV116UpdateDialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressOut.html#/s:11AssistantV116UpdateDialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressIn.html#/s:11AssistantV116UpdateDialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/DigressIn.html#/s:11AssistantV116UpdateDialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/DigressIn.html#/s:11AssistantV116UpdateDialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV06dialogE0SSSgvp":{"name":"dialogNode","abstract":"

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous sibling dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context for the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

The metadata for the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV8nextStepAA0de4NextG0VSgvp":{"name":"nextStep","abstract":"

The next step to be executed in dialog processing.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV7actionsSayAA0dE6ActionVGSgvp":{"name":"actions","abstract":"

An array of objects describing any actions to be invoked by the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeVACSSSg06dialogE0_AD11descriptionAD10conditionsAD6parentAD15previousSiblings10DictionaryVySSAA4JSONOGSg6outputAO7contextAO8metadataAA0dE8NextStepVSg04nextR0AD5titleAD8nodeTypeAD9eventNameAD8variableSayAA0dE6ActionVGSg7actionsAD9digressInAD10digressOutAD15digressOutSlotstcfc":{"name":"init(dialogNode:description:conditions:parent:previousSibling:output:context:metadata:nextStep:title:nodeType:eventName:variable:actions:digressIn:digressOut:digressOutSlots:)","abstract":"

Initialize a UpdateDialogNode with member variables.

","parent_name":"UpdateDialogNode"},"Structs/UpdateCounterexample.html#/s:11AssistantV120UpdateCounterexampleV4textSSSgvp":{"name":"text","abstract":"

The text of a user input counterexample.

","parent_name":"UpdateCounterexample"},"Structs/UpdateCounterexample.html#/s:11AssistantV120UpdateCounterexampleVACSSSg4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a UpdateCounterexample with member variables.

","parent_name":"UpdateCounterexample"},"Structs/SystemResponse.html#/s:11AssistantV114SystemResponseV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:11AssistantV114SystemResponseVACs10DictionaryVySSAA4JSONOG20additionalProperties_tcfc":{"name":"init(additionalProperties:)","abstract":"

Initialize a SystemResponse.

","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"SystemResponse"},"Structs/SynonymCollection.html#/s:11AssistantV117SynonymCollectionV8synonymsSayAA0C0VGvp":{"name":"synonyms","abstract":"

An array of synonyms.

","parent_name":"SynonymCollection"},"Structs/SynonymCollection.html#/s:11AssistantV117SynonymCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"SynonymCollection"},"Structs/Synonym.html#/s:11AssistantV17SynonymV11synonymTextSSvp":{"name":"synonymText","abstract":"

The text of the synonym.

","parent_name":"Synonym"},"Structs/Synonym.html#/s:11AssistantV17SynonymV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the synonym.

","parent_name":"Synonym"},"Structs/Synonym.html#/s:11AssistantV17SynonymV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the most recent update to the synonym.

","parent_name":"Synonym"},"Structs/RuntimeIntent.html#/s:11AssistantV113RuntimeIntentV6intentSSvp":{"name":"intent","abstract":"

The name of the recognized intent.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:11AssistantV113RuntimeIntentV10confidenceSdvp":{"name":"confidence","abstract":"

A decimal percentage that represents Watson’s confidence in the intent.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:11AssistantV113RuntimeIntentV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:11AssistantV113RuntimeIntentVACSS6intent_Sd10confidences10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(intent:confidence:additionalProperties:)","abstract":"

Initialize a RuntimeIntent with member variables.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"RuntimeIntent"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV6entitySSvp":{"name":"entity","abstract":"

An entity detected in the input.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV8locationSaySiGvp":{"name":"location","abstract":"

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV5valueSSvp":{"name":"value","abstract":"

The term in the input text that was recognized as an entity value.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV10confidenceSdSgvp":{"name":"confidence","abstract":"

A decimal percentage that represents Watson’s confidence in the entity.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata for the entity.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV6groupsSayAA12CaptureGroupVGSgvp":{"name":"groups","abstract":"

The recognized capture groups for the entity, as defined by the entity pattern.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityVACSS6entity_SaySiG8locationSS5valueSdSg10confidences10DictionaryVySSAA4JSONOGSg8metadataSayAA12CaptureGroupVGSg6groupsAN20additionalPropertiestcfc":{"name":"init(entity:location:value:confidence:metadata:groups:additionalProperties:)","abstract":"

Initialize a RuntimeEntity with member variables.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"RuntimeEntity"},"Structs/Pagination.html#/s:11AssistantV110PaginationV10refreshUrlSSvp":{"name":"refreshUrl","abstract":"

The URL that will return the same page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:11AssistantV110PaginationV7nextUrlSSSgvp":{"name":"nextUrl","abstract":"

The URL that will return the next page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:11AssistantV110PaginationV5totalSiSgvp":{"name":"total","abstract":"

Reserved for future use.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:11AssistantV110PaginationV7matchedSiSgvp":{"name":"matched","abstract":"

Reserved for future use.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:11AssistantV110PaginationV13refreshCursorSSSgvp":{"name":"refreshCursor","abstract":"

A token identifying the current page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:11AssistantV110PaginationV10nextCursorSSSgvp":{"name":"nextCursor","abstract":"

A token identifying the next page of results.

","parent_name":"Pagination"},"Structs/OutputData.html#/s:11AssistantV110OutputDataV11logMessagesSayAA10LogMessageVGvp":{"name":"logMessages","abstract":"

An array of up to 50 messages logged with the request.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:11AssistantV110OutputDataV4textSaySSGvp":{"name":"text","abstract":"

An array of responses to the user.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:11AssistantV110OutputDataV12nodesVisitedSaySSGSgvp":{"name":"nodesVisited","abstract":"

An array of the nodes that were triggered to create the response, in the order in which they were visited. This information is useful for debugging and for tracing the path taken through the node tree.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:11AssistantV110OutputDataV19nodesVisitedDetailsSayAA010DialogNodefG0VGSgvp":{"name":"nodesVisitedDetails","abstract":"

An array of objects containing detailed diagnostic information about the nodes that were triggered during processing of the input message. Included only if nodes_visited_details is set to true in the message request.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:11AssistantV110OutputDataV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:11AssistantV110OutputDataVACSayAA10LogMessageVG11logMessages_SaySSG4textAHSg12nodesVisitedSayAA010DialogNodeK7DetailsVGSg0jkN0s10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(logMessages:text:nodesVisited:nodesVisitedDetails:additionalProperties:)","abstract":"

Initialize a OutputData with member variables.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"OutputData"},"Structs/OutputData.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"OutputData"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV5inputAA0C5InputVSgvp":{"name":"input","abstract":"

The user input from the request.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV7intentsSayAA13RuntimeIntentVGvp":{"name":"intents","abstract":"

An array of intents recognized in the user input, sorted in descending order of confidence.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV8entitiesSayAA13RuntimeEntityVGvp":{"name":"entities","abstract":"

An array of entities identified in the user input.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV16alternateIntentsSbSgvp":{"name":"alternateIntents","abstract":"

Whether to return more than one intent. A value of true indicates that all matching intents are returned.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV7contextAA7ContextVvp":{"name":"context","abstract":"

State information for the conversation.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV6outputAA10OutputDataVvp":{"name":"output","abstract":"

Output from the dialog, including the response to the user, the nodes that were triggered, and log messages.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"MessageResponse"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV5inputAA9InputDataVSgvp":{"name":"input","abstract":"

An input object that includes the input text.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV16alternateIntentsSbSgvp":{"name":"alternateIntents","abstract":"

Whether to return more than one intent. Set to true to return all matching intents.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV7contextAA7ContextVSgvp":{"name":"context","abstract":"

State information for the conversation. Continue a conversation by including the context object from the previous response.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV8entitiesSayAA13RuntimeEntityVGSgvp":{"name":"entities","abstract":"

Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV7intentsSayAA13RuntimeIntentVGSgvp":{"name":"intents","abstract":"

Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV6outputAA10OutputDataVSgvp":{"name":"output","abstract":"

System output. Include the output from the previous response to maintain intermediate information over multiple requests.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestVAcA9InputDataVSg5input_SbSg16alternateIntentsAA7ContextVSg7contextSayAA13RuntimeEntityVGSg8entitiesSayAA0L6IntentVGSg7intentsAA06OutputF0VSg6outputtcfc":{"name":"init(input:alternateIntents:context:entities:intents:output:)","abstract":"

Initialize a MessageRequest with member variables.

","parent_name":"MessageRequest"},"Structs/MessageInput.html#/s:11AssistantV112MessageInputV4textSSSgvp":{"name":"text","abstract":"

The user’s input.

","parent_name":"MessageInput"},"Structs/LogPagination.html#/s:11AssistantV113LogPaginationV7nextUrlSSSgvp":{"name":"nextUrl","abstract":"

The URL that will return the next page of results, if any.

","parent_name":"LogPagination"},"Structs/LogPagination.html#/s:11AssistantV113LogPaginationV7matchedSiSgvp":{"name":"matched","abstract":"

Reserved for future use.

","parent_name":"LogPagination"},"Structs/LogPagination.html#/s:11AssistantV113LogPaginationV10nextCursorSSSgvp":{"name":"nextCursor","abstract":"

A token identifying the next page of results.

","parent_name":"LogPagination"},"Structs/LogMessage/Level.html#/s:11AssistantV110LogMessageV5LevelO4infoA2EmF":{"name":"info","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html#/s:11AssistantV110LogMessageV5LevelO5errorA2EmF":{"name":"error","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html#/s:11AssistantV110LogMessageV5LevelO4warnA2EmF":{"name":"warn","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html":{"name":"Level","abstract":"

The severity of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:11AssistantV110LogMessageV5levelSSvp":{"name":"level","abstract":"

The severity of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:11AssistantV110LogMessageV3msgSSvp":{"name":"msg","abstract":"

The text of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:11AssistantV110LogMessageV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:11AssistantV110LogMessageVACSS5level_SS3msgs10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(level:msg:additionalProperties:)","abstract":"

Initialize a LogMessage with member variables.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"LogMessage"},"Structs/LogExport.html#/s:11AssistantV19LogExportV7requestAA14MessageRequestVvp":{"name":"request","abstract":"

A request received by the workspace, including the user input and context.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV8responseAA15MessageResponseVvp":{"name":"response","abstract":"

The response sent by the workspace, including the output text, detected intents and entities, and context.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV5logIDSSvp":{"name":"logID","abstract":"

A unique identifier for the logged event.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV16requestTimestampSSvp":{"name":"requestTimestamp","abstract":"

The timestamp for receipt of the message.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV17responseTimestampSSvp":{"name":"responseTimestamp","abstract":"

The timestamp for the system response to the message.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The unique identifier of the workspace where the request was made.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV8languageSSvp":{"name":"language","abstract":"

The language of the workspace where the message request was made.

","parent_name":"LogExport"},"Structs/LogCollection.html#/s:11AssistantV113LogCollectionV4logsSayAA0C6ExportVGvp":{"name":"logs","abstract":"

An array of objects describing log events.

","parent_name":"LogCollection"},"Structs/LogCollection.html#/s:11AssistantV113LogCollectionV10paginationAA0C10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"LogCollection"},"Structs/IntentExport.html#/s:11AssistantV112IntentExportV10intentNameSSvp":{"name":"intentName","abstract":"

The name of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:11AssistantV112IntentExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:11AssistantV112IntentExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:11AssistantV112IntentExportV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:11AssistantV112IntentExportV8examplesSayAA7ExampleVGSgvp":{"name":"examples","abstract":"

An array of objects describing the user input examples for the intent.

","parent_name":"IntentExport"},"Structs/IntentCollection.html#/s:11AssistantV116IntentCollectionV7intentsSayAA0C6ExportVGvp":{"name":"intents","abstract":"

An array of objects describing the intents defined for the workspace.

","parent_name":"IntentCollection"},"Structs/IntentCollection.html#/s:11AssistantV116IntentCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"IntentCollection"},"Structs/Intent.html#/s:11AssistantV16IntentV10intentNameSSvp":{"name":"intentName","abstract":"

The name of the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:11AssistantV16IntentV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:11AssistantV16IntentV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:11AssistantV16IntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"Intent"},"Structs/InputData.html#/s:11AssistantV19InputDataV4textSSvp":{"name":"text","abstract":"

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

","parent_name":"InputData"},"Structs/InputData.html#/s:11AssistantV19InputDataVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a InputData with member variables.

","parent_name":"InputData"},"Structs/ExampleCollection.html#/s:11AssistantV117ExampleCollectionV8examplesSayAA0C0VGvp":{"name":"examples","abstract":"

An array of objects describing the examples defined for the intent.

","parent_name":"ExampleCollection"},"Structs/ExampleCollection.html#/s:11AssistantV117ExampleCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"ExampleCollection"},"Structs/Example.html#/s:11AssistantV17ExampleV11exampleTextSSvp":{"name":"exampleText","abstract":"

The text of the user input example.

","parent_name":"Example"},"Structs/Example.html#/s:11AssistantV17ExampleV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the example.

","parent_name":"Example"},"Structs/Example.html#/s:11AssistantV17ExampleV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the example.

","parent_name":"Example"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV10entityNameSSvp":{"name":"entityName","abstract":"

The name of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether fuzzy matching is used for the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV6valuesSayAA05ValueD0VGSgvp":{"name":"values","abstract":"

An array objects describing the entity values.

","parent_name":"EntityExport"},"Structs/EntityCollection.html#/s:11AssistantV116EntityCollectionV8entitiesSayAA0C6ExportVGvp":{"name":"entities","abstract":"

An array of objects describing the entities defined for the workspace.

","parent_name":"EntityCollection"},"Structs/EntityCollection.html#/s:11AssistantV116EntityCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"EntityCollection"},"Structs/Entity.html#/s:11AssistantV16EntityV10entityNameSSvp":{"name":"entityName","abstract":"

The name of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:11AssistantV16EntityV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:11AssistantV16EntityV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:11AssistantV16EntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:11AssistantV16EntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:11AssistantV16EntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether fuzzy matching is used for the entity.

","parent_name":"Entity"},"Structs/DialogNodeVisitedDetails.html#/s:11AssistantV124DialogNodeVisitedDetailsV06dialogD0SSSgvp":{"name":"dialogNode","abstract":"

A dialog node that was triggered during processing of the input message.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:11AssistantV124DialogNodeVisitedDetailsV5titleSSSgvp":{"name":"title","abstract":"

The title of the dialog node.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:11AssistantV124DialogNodeVisitedDetailsV10conditionsSSSgvp":{"name":"conditions","abstract":"

The conditions that trigger the dialog node.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:11AssistantV124DialogNodeVisitedDetailsVACSSSg06dialogD0_AD5titleAD10conditionstcfc":{"name":"init(dialogNode:title:conditions:)","abstract":"

Initialize a DialogNodeVisitedDetails with member variables.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeNextStep/Selector.html#/s:11AssistantV118DialogNodeNextStepV8SelectorO9conditionA2EmF":{"name":"condition","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:11AssistantV118DialogNodeNextStepV8SelectorO6clientA2EmF":{"name":"client","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:11AssistantV118DialogNodeNextStepV8SelectorO9userInputA2EmF":{"name":"userInput","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:11AssistantV118DialogNodeNextStepV8SelectorO4bodyA2EmF":{"name":"body","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO12getUserInputA2EmF":{"name":"getUserInput","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO13skipUserInputA2EmF":{"name":"skipUserInput","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO6jumpToA2EmF":{"name":"jumpTo","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO8repromptA2EmF":{"name":"reprompt","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO8skipSlotA2EmF":{"name":"skipSlot","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO12skipAllSlotsA2EmF":{"name":"skipAllSlots","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html":{"name":"Behavior","abstract":"

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep/Selector.html":{"name":"Selector","abstract":"

Which part of the dialog node to process next.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:11AssistantV118DialogNodeNextStepV8behaviorSSvp":{"name":"behavior","abstract":"

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:11AssistantV118DialogNodeNextStepV06dialogD0SSSgvp":{"name":"dialogNode","abstract":"

The ID of the dialog node to process next. This parameter is required if behavior=jump_to.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:11AssistantV118DialogNodeNextStepV8selectorSSSgvp":{"name":"selector","abstract":"

Which part of the dialog node to process next.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:11AssistantV118DialogNodeNextStepVACSS8behavior_SSSg06dialogD0AE8selectortcfc":{"name":"init(behavior:dialogNode:selector:)","abstract":"

Initialize a DialogNodeNextStep with member variables.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeCollection.html#/s:11AssistantV120DialogNodeCollectionV11dialogNodesSayAA0cD0VGvp":{"name":"dialogNodes","abstract":"

An array of objects describing the dialog nodes defined for the workspace.

","parent_name":"DialogNodeCollection"},"Structs/DialogNodeCollection.html#/s:11AssistantV120DialogNodeCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"DialogNodeCollection"},"Structs/DialogNodeAction/ActionType.html#/s:11AssistantV116DialogNodeActionV0E4TypeO6clientA2EmF":{"name":"client","abstract":"

Undocumented

","parent_name":"ActionType"},"Structs/DialogNodeAction/ActionType.html#/s:11AssistantV116DialogNodeActionV0E4TypeO6serverA2EmF":{"name":"server","abstract":"

Undocumented

","parent_name":"ActionType"},"Structs/DialogNodeAction/ActionType.html":{"name":"ActionType","abstract":"

The type of action to invoke.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionV4nameSSvp":{"name":"name","abstract":"

The name of the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionV10actionTypeSSSgvp":{"name":"actionType","abstract":"

The type of action to invoke.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionV10parameterss10DictionaryVySSAA4JSONOGSgvp":{"name":"parameters","abstract":"

A map of key/value pairs to be provided to the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionV14resultVariableSSvp":{"name":"resultVariable","abstract":"

The location in the dialog context where the result of the action is stored.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionV11credentialsSSSgvp":{"name":"credentials","abstract":"

The name of the context variable that the client application will use to pass in credentials for the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionVACSS4name_SS14resultVariableSSSg10actionTypes10DictionaryVySSAA4JSONOGSg10parametersAF11credentialstcfc":{"name":"init(name:resultVariable:actionType:parameters:credentials:)","abstract":"

Initialize a DialogNodeAction with member variables.

","parent_name":"DialogNodeAction"},"Structs/DialogNode/DigressOutSlots.html#/s:11AssistantV110DialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOutSlots.html#/s:11AssistantV110DialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOutSlots.html#/s:11AssistantV110DialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOut.html#/s:11AssistantV110DialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressOut.html#/s:11AssistantV110DialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressOut.html#/s:11AssistantV110DialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressIn.html#/s:11AssistantV110DialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/DigressIn.html#/s:11AssistantV110DialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/DigressIn.html#/s:11AssistantV110DialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV06dialogD2IDSSvp":{"name":"dialogNodeID","abstract":"

The dialog node ID.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that triggers the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node. This property is not returned if the dialog node has no parent.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous sibling dialog node. This property is not returned if the dialog node has no previous sibling.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context (if defined) for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV8nextStepAA0cd4NextF0VSgvp":{"name":"nextStep","abstract":"

The next step to execute following this dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the most recent update to the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV7actionsSayAA0cD6ActionVGSgvp":{"name":"actions","abstract":"

The actions for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"DialogNode"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV4nameSSSgvp":{"name":"name","abstract":"

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV8languageSSSgvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV7intentsSayAA0C6IntentVGSgvp":{"name":"intents","abstract":"

An array of objects defining the intents for the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV8entitiesSayAA0C6EntityVGSgvp":{"name":"entities","abstract":"

An array of objects defining the entities for the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV11dialogNodesSayAA0C10DialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects defining the nodes in the workspace dialog.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV15counterexamplesSayAA0C14CounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of objects defining input examples that have been marked as irrelevant input.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceVACSSSg4name_AD11descriptionAD8languageSayAA0C6IntentVGSg7intentsSayAA0C6EntityVGSg8entitiesSayAA0C10DialogNodeVGSg11dialogNodesSayAA0C14CounterexampleVGSg15counterexampless10DictionaryVySSAA4JSONOGSg8metadataSbSg14learningOptOuttcfc":{"name":"init(name:description:language:intents:entities:dialogNodes:counterexamples:metadata:learningOptOut:)","abstract":"

Initialize a CreateWorkspace with member variables.

","parent_name":"CreateWorkspace"},"Structs/CreateValue/ValueType.html#/s:11AssistantV111CreateValueV0D4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/CreateValue/ValueType.html#/s:11AssistantV111CreateValueV0D4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/CreateValue/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueV5valueSSvp":{"name":"value","abstract":"

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueV9valueTypeSSSgvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueVACSS5value_s10DictionaryVySSAA4JSONOGSg8metadataSaySSGSg8synonymsAM8patternsSSSg0E4Typetcfc":{"name":"init(value:metadata:synonyms:patterns:valueType:)","abstract":"

Initialize a CreateValue with member variables.

","parent_name":"CreateValue"},"Structs/CreateSynonym.html#/s:11AssistantV113CreateSynonymV7synonymSSvp":{"name":"synonym","abstract":"

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"CreateSynonym"},"Structs/CreateSynonym.html#/s:11AssistantV113CreateSynonymVACSS7synonym_tcfc":{"name":"init(synonym:)","abstract":"

Initialize a CreateSynonym with member variables.

","parent_name":"CreateSynonym"},"Structs/CreateIntent.html#/s:11AssistantV112CreateIntentV6intentSSvp":{"name":"intent","abstract":"

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:11AssistantV112CreateIntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:11AssistantV112CreateIntentV8examplesSayAA0C7ExampleVGSgvp":{"name":"examples","abstract":"

An array of user input examples for the intent.

","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:11AssistantV112CreateIntentVACSS6intent_SSSg11descriptionSayAA0C7ExampleVGSg8examplestcfc":{"name":"init(intent:description:examples:)","abstract":"

Initialize a CreateIntent with member variables.

","parent_name":"CreateIntent"},"Structs/CreateExample.html#/s:11AssistantV113CreateExampleV4textSSvp":{"name":"text","abstract":"

The text of a user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

","parent_name":"CreateExample"},"Structs/CreateExample.html#/s:11AssistantV113CreateExampleVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a CreateExample with member variables.

","parent_name":"CreateExample"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityV6entitySSvp":{"name":"entity","abstract":"

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the value.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityV6valuesSayAA0C5ValueVGSgvp":{"name":"values","abstract":"

An array of objects describing the entity values.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether to use fuzzy matching for the entity.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityVACSS6entity_SSSg11descriptions10DictionaryVySSAA4JSONOGSg8metadataSayAA0C5ValueVGSg6valuesSbSg10fuzzyMatchtcfc":{"name":"init(entity:description:metadata:values:fuzzyMatch:)","abstract":"

Initialize a CreateEntity with member variables.

","parent_name":"CreateEntity"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:11AssistantV116CreateDialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:11AssistantV116CreateDialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:11AssistantV116CreateDialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOut.html#/s:11AssistantV116CreateDialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressOut.html#/s:11AssistantV116CreateDialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressOut.html#/s:11AssistantV116CreateDialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressIn.html#/s:11AssistantV116CreateDialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/DigressIn.html#/s:11AssistantV116CreateDialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/DigressIn.html#/s:11AssistantV116CreateDialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV06dialogE0SSvp":{"name":"dialogNode","abstract":"

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context for the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

The metadata for the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV8nextStepAA0de4NextG0VSgvp":{"name":"nextStep","abstract":"

The next step to be executed in dialog processing.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV7actionsSayAA0dE6ActionVGSgvp":{"name":"actions","abstract":"

An array of objects describing any actions to be invoked by the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeVACSS06dialogE0_SSSg11descriptionAE10conditionsAE6parentAE15previousSiblings10DictionaryVySSAA4JSONOGSg6outputAO7contextAO8metadataAA0dE8NextStepVSg04nextR0SayAA0dE6ActionVGSg7actionsAE5titleAE8nodeTypeAE9eventNameAE8variableAE9digressInAE10digressOutAE15digressOutSlotstcfc":{"name":"init(dialogNode:description:conditions:parent:previousSibling:output:context:metadata:nextStep:actions:title:nodeType:eventName:variable:digressIn:digressOut:digressOutSlots:)","abstract":"

Initialize a CreateDialogNode with member variables.

","parent_name":"CreateDialogNode"},"Structs/CreateCounterexample.html#/s:11AssistantV120CreateCounterexampleV4textSSvp":{"name":"text","abstract":"

The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It must be no longer than 1024 characters.

","parent_name":"CreateCounterexample"},"Structs/CreateCounterexample.html#/s:11AssistantV120CreateCounterexampleVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a CreateCounterexample with member variables.

","parent_name":"CreateCounterexample"},"Structs/CounterexampleCollection.html#/s:11AssistantV124CounterexampleCollectionV15counterexamplesSayAA0C0VGvp":{"name":"counterexamples","abstract":"

An array of objects describing the examples marked as irrelevant input.

","parent_name":"CounterexampleCollection"},"Structs/CounterexampleCollection.html#/s:11AssistantV124CounterexampleCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"CounterexampleCollection"},"Structs/Counterexample.html#/s:11AssistantV114CounterexampleV4textSSvp":{"name":"text","abstract":"

The text of the counterexample.

","parent_name":"Counterexample"},"Structs/Counterexample.html#/s:11AssistantV114CounterexampleV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the counterexample.

","parent_name":"Counterexample"},"Structs/Counterexample.html#/s:11AssistantV114CounterexampleV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the counterexample.

","parent_name":"Counterexample"},"Structs/Context.html#/s:11AssistantV17ContextV14conversationIDSSSgvp":{"name":"conversationID","abstract":"

The unique identifier of the conversation.

","parent_name":"Context"},"Structs/Context.html#/s:11AssistantV17ContextV6systemAA14SystemResponseVSgvp":{"name":"system","abstract":"

For internal use only.

","parent_name":"Context"},"Structs/Context.html#/s:11AssistantV17ContextV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"Context"},"Structs/Context.html#/s:11AssistantV17ContextVACSSSg14conversationID_AA14SystemResponseVSg6systems10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(conversationID:system:additionalProperties:)","abstract":"

Initialize a Context with member variables.

","parent_name":"Context"},"Structs/Context.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"Context"},"Structs/Context.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"Context"},"Structs/CaptureGroup.html#/s:11AssistantV112CaptureGroupV5groupSSvp":{"name":"group","abstract":"

A recognized capture group for the entity.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html#/s:11AssistantV112CaptureGroupV8locationSaySiGSgvp":{"name":"location","abstract":"

Zero-based character offsets that indicate where the entity value begins and ends in the input text.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html#/s:11AssistantV112CaptureGroupVACSS5group_SaySiGSg8locationtcfc":{"name":"init(group:location:)","abstract":"

Initialize a CaptureGroup with member variables.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html":{"name":"CaptureGroup","abstract":"

CaptureGroup.

"},"Structs/Context.html":{"name":"Context","abstract":"

State information for the conversation. To maintain state, include the context from the previous response.

"},"Structs/Counterexample.html":{"name":"Counterexample","abstract":"

Counterexample.

"},"Structs/CounterexampleCollection.html":{"name":"CounterexampleCollection","abstract":"

CounterexampleCollection.

"},"Structs/CreateCounterexample.html":{"name":"CreateCounterexample","abstract":"

CreateCounterexample.

"},"Structs/CreateDialogNode.html":{"name":"CreateDialogNode","abstract":"

CreateDialogNode.

"},"Structs/CreateEntity.html":{"name":"CreateEntity","abstract":"

CreateEntity.

"},"Structs/CreateExample.html":{"name":"CreateExample","abstract":"

CreateExample.

"},"Structs/CreateIntent.html":{"name":"CreateIntent","abstract":"

CreateIntent.

"},"Structs/CreateSynonym.html":{"name":"CreateSynonym","abstract":"

CreateSynonym.

"},"Structs/CreateValue.html":{"name":"CreateValue","abstract":"

CreateValue.

"},"Structs/CreateWorkspace.html":{"name":"CreateWorkspace","abstract":"

CreateWorkspace.

"},"Structs/DialogNode.html":{"name":"DialogNode","abstract":"

DialogNode.

"},"Structs/DialogNodeAction.html":{"name":"DialogNodeAction","abstract":"

DialogNodeAction.

"},"Structs/DialogNodeCollection.html":{"name":"DialogNodeCollection","abstract":"

An array of dialog nodes.

"},"Structs/DialogNodeNextStep.html":{"name":"DialogNodeNextStep","abstract":"

The next step to execute following this dialog node.

"},"Structs/DialogNodeVisitedDetails.html":{"name":"DialogNodeVisitedDetails","abstract":"

DialogNodeVisitedDetails.

"},"Structs/Entity.html":{"name":"Entity","abstract":"

Entity.

"},"Structs/EntityCollection.html":{"name":"EntityCollection","abstract":"

An array of entities.

"},"Structs/EntityExport.html":{"name":"EntityExport","abstract":"

EntityExport.

"},"Structs/Example.html":{"name":"Example","abstract":"

Example.

"},"Structs/ExampleCollection.html":{"name":"ExampleCollection","abstract":"

ExampleCollection.

"},"Structs/InputData.html":{"name":"InputData","abstract":"

The user input.

"},"Structs/Intent.html":{"name":"Intent","abstract":"

Intent.

"},"Structs/IntentCollection.html":{"name":"IntentCollection","abstract":"

IntentCollection.

"},"Structs/IntentExport.html":{"name":"IntentExport","abstract":"

IntentExport.

"},"Structs/LogCollection.html":{"name":"LogCollection","abstract":"

LogCollection.

"},"Structs/LogExport.html":{"name":"LogExport","abstract":"

LogExport.

"},"Structs/LogMessage.html":{"name":"LogMessage","abstract":"

Log message details.

"},"Structs/LogPagination.html":{"name":"LogPagination","abstract":"

The pagination data for the returned objects.

"},"Structs/MessageInput.html":{"name":"MessageInput","abstract":"

The text of the user input.

"},"Structs/MessageRequest.html":{"name":"MessageRequest","abstract":"

A request formatted for the Watson Assistant service.

"},"Structs/MessageResponse.html":{"name":"MessageResponse","abstract":"

A response from the Watson Assistant service.

"},"Structs/OutputData.html":{"name":"OutputData","abstract":"

An output object that includes the response to the user, the nodes that were hit, and messages from the log.

"},"Structs/Pagination.html":{"name":"Pagination","abstract":"

The pagination data for the returned objects.

"},"Structs/RuntimeEntity.html":{"name":"RuntimeEntity","abstract":"

A term from the request that was identified as an entity.

"},"Structs/RuntimeIntent.html":{"name":"RuntimeIntent","abstract":"

An intent identified in the user input.

"},"Structs/Synonym.html":{"name":"Synonym","abstract":"

Synonym.

"},"Structs/SynonymCollection.html":{"name":"SynonymCollection","abstract":"

SynonymCollection.

"},"Structs/SystemResponse.html":{"name":"SystemResponse","abstract":"

For internal use only.

"},"Structs/UpdateCounterexample.html":{"name":"UpdateCounterexample","abstract":"

UpdateCounterexample.

"},"Structs/UpdateDialogNode.html":{"name":"UpdateDialogNode","abstract":"

UpdateDialogNode.

"},"Structs/UpdateEntity.html":{"name":"UpdateEntity","abstract":"

UpdateEntity.

"},"Structs/UpdateExample.html":{"name":"UpdateExample","abstract":"

UpdateExample.

"},"Structs/UpdateIntent.html":{"name":"UpdateIntent","abstract":"

UpdateIntent.

"},"Structs/UpdateSynonym.html":{"name":"UpdateSynonym","abstract":"

UpdateSynonym.

"},"Structs/UpdateValue.html":{"name":"UpdateValue","abstract":"

UpdateValue.

"},"Structs/UpdateWorkspace.html":{"name":"UpdateWorkspace","abstract":"

UpdateWorkspace.

"},"Structs/Value.html":{"name":"Value","abstract":"

Value.

"},"Structs/ValueCollection.html":{"name":"ValueCollection","abstract":"

ValueCollection.

"},"Structs/ValueExport.html":{"name":"ValueExport","abstract":"

ValueExport.

"},"Structs/Workspace.html":{"name":"Workspace","abstract":"

Workspace.

"},"Structs/WorkspaceCollection.html":{"name":"WorkspaceCollection","abstract":"

WorkspaceCollection.

"},"Structs/WorkspaceExport.html":{"name":"WorkspaceExport","abstract":"

WorkspaceExport.

"},"Structs.html#/s:11AssistantV111JSONWrapperV":{"name":"JSONWrapper","abstract":"

Used internally to serialize and deserialize JSON."},"Enums/RestError.html#/s:11AssistantV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO013serializationD0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO08encodingD0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO011fileManagerD0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:11AssistantV14JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/Assistant.html#/s:11AssistantV10A0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

Create a Assistant object.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a Assistant object.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a Assistant object.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C7messageySS11workspaceID_AA14MessageRequestVSg7requestSbSg19nodesVisitedDetailss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F8ResponseVc7successtF":{"name":"message(workspaceID:request:nodesVisitedDetails:headers:failure:success:)","abstract":"

Get response to user input.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C14listWorkspacesySiSg9pageLimit_SbSg12includeCountSSSg4sortAI6cursorAG0G5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA19WorkspaceCollectionVc7successtF":{"name":"listWorkspaces(pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List workspaces.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C15createWorkspaceyAA06CreateD0VSg10properties_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createWorkspace(properties:headers:failure:success:)","abstract":"

Create workspace.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12getWorkspaceySS11workspaceID_SbSg6exportAF12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getWorkspace(workspaceID:export:includeAudit:headers:failure:success:)","abstract":"

Get information about a workspace.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C15updateWorkspaceySS11workspaceID_AA06UpdateD0VSg10propertiesSbSg6appends10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateWorkspace(workspaceID:properties:append:headers:failure:success:)","abstract":"

Update workspace.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C15deleteWorkspaceySS11workspaceID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteWorkspace(workspaceID:headers:failure:success:)","abstract":"

Delete workspace.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11listIntentsySS11workspaceID_SbSg6exportSiSg9pageLimitAF12includeCountSSSg4sortAK6cursorAF0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA16IntentCollectionVc7successtF":{"name":"listIntents(workspaceID:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List intents.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12createIntentySS11workspaceID_SS6intentSSSg11descriptionSayAA13CreateExampleVGSg8exampless10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createIntent(workspaceID:intent:description:examples:headers:failure:success:)","abstract":"

Create intent.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C9getIntentySS11workspaceID_SS6intentSbSg6exportAG12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getIntent(workspaceID:intent:export:includeAudit:headers:failure:success:)","abstract":"

Get intent.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12updateIntentySS11workspaceID_SS6intentSSSg03newD0AG0H11DescriptionSayAA13CreateExampleVGSg0H8Exampless10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateIntent(workspaceID:intent:newIntent:newDescription:newExamples:headers:failure:success:)","abstract":"

Update intent.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12deleteIntentySS11workspaceID_SS6intents10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteIntent(workspaceID:intent:headers:failure:success:)","abstract":"

Delete intent.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12listExamplesySS11workspaceID_SS6intentSiSg9pageLimitSbSg12includeCountSSSg4sortAK6cursorAI0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA17ExampleCollectionVc7successtF":{"name":"listExamples(workspaceID:intent:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List user input examples.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13createExampleySS11workspaceID_SS6intentSS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createExample(workspaceID:intent:text:headers:failure:success:)","abstract":"

Create user input example.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C10getExampleySS11workspaceID_SS6intentSS4textSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getExample(workspaceID:intent:text:includeAudit:headers:failure:success:)","abstract":"

Get user input example.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13updateExampleySS11workspaceID_SS6intentSS4textSSSg7newTexts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateExample(workspaceID:intent:text:newText:headers:failure:success:)","abstract":"

Update user input example.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13deleteExampleySS11workspaceID_SS6intentSS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteExample(workspaceID:intent:text:headers:failure:success:)","abstract":"

Delete user input example.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C19listCounterexamplesySS11workspaceID_SiSg9pageLimitSbSg12includeCountSSSg4sortAJ6cursorAH0I5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA24CounterexampleCollectionVc7successtF":{"name":"listCounterexamples(workspaceID:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List counterexamples.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C20createCounterexampleySS11workspaceID_SS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createCounterexample(workspaceID:text:headers:failure:success:)","abstract":"

Create counterexample.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C17getCounterexampleySS11workspaceID_SS4textSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getCounterexample(workspaceID:text:includeAudit:headers:failure:success:)","abstract":"

Get counterexample.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C20updateCounterexampleySS11workspaceID_SS4textSSSg7newTexts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateCounterexample(workspaceID:text:newText:headers:failure:success:)","abstract":"

Update counterexample.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C20deleteCounterexampleySS11workspaceID_SS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteCounterexample(workspaceID:text:headers:failure:success:)","abstract":"

Delete counterexample.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12listEntitiesySS11workspaceID_SbSg6exportSiSg9pageLimitAF12includeCountSSSg4sortAK6cursorAF0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA16EntityCollectionVc7successtF":{"name":"listEntities(workspaceID:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entities.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12createEntityySS11workspaceID_AA06CreateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createEntity(workspaceID:properties:headers:failure:success:)","abstract":"

Create entity.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C9getEntityySS11workspaceID_SS6entitySbSg6exportAG12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getEntity(workspaceID:entity:export:includeAudit:headers:failure:success:)","abstract":"

Get entity.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12updateEntityySS11workspaceID_SS6entityAA06UpdateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateEntity(workspaceID:entity:properties:headers:failure:success:)","abstract":"

Update entity.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12deleteEntityySS11workspaceID_SS6entitys10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteEntity(workspaceID:entity:headers:failure:success:)","abstract":"

Delete entity.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C10listValuesySS11workspaceID_SS6entitySbSg6exportSiSg9pageLimitAG12includeCountSSSg4sortAL6cursorAG0K5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA15ValueCollectionVc7successtF":{"name":"listValues(workspaceID:entity:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entity values.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11createValueySS11workspaceID_SS6entityAA06CreateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createValue(workspaceID:entity:properties:headers:failure:success:)","abstract":"

Add entity value.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C8getValueySS11workspaceID_SS6entitySS5valueSbSg6exportAH12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getValue(workspaceID:entity:value:export:includeAudit:headers:failure:success:)","abstract":"

Get entity value.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11updateValueySS11workspaceID_SS6entitySS5valueAA06UpdateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateValue(workspaceID:entity:value:properties:headers:failure:success:)","abstract":"

Update entity value.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11deleteValueySS11workspaceID_SS6entitySS5values10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteValue(workspaceID:entity:value:headers:failure:success:)","abstract":"

Delete entity value.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12listSynonymsySS11workspaceID_SS6entitySS5valueSiSg9pageLimitSbSg12includeCountSSSg4sortAL6cursorAJ0K5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA17SynonymCollectionVc7successtF":{"name":"listSynonyms(workspaceID:entity:value:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entity value synonyms.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13createSynonymySS11workspaceID_SS6entitySS5valueSS7synonyms10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createSynonym(workspaceID:entity:value:synonym:headers:failure:success:)","abstract":"

Add entity value synonym.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C10getSynonymySS11workspaceID_SS6entitySS5valueSS7synonymSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getSynonym(workspaceID:entity:value:synonym:includeAudit:headers:failure:success:)","abstract":"

Get entity value synonym.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13updateSynonymySS11workspaceID_SS6entitySS5valueSS7synonymSSSg03newD0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateSynonym(workspaceID:entity:value:synonym:newSynonym:headers:failure:success:)","abstract":"

Update entity value synonym.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13deleteSynonymySS11workspaceID_SS6entitySS5valueSS7synonyms10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteSynonym(workspaceID:entity:value:synonym:headers:failure:success:)","abstract":"

Delete entity value synonym.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C15listDialogNodesySS11workspaceID_SiSg9pageLimitSbSg12includeCountSSSg4sortAJ6cursorAH0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D14NodeCollectionVc7successtF":{"name":"listDialogNodes(workspaceID:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List dialog nodes.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C16createDialogNodeySS11workspaceID_AA06CreatedE0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"createDialogNode(workspaceID:properties:headers:failure:success:)","abstract":"

Create dialog node.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13getDialogNodeySS11workspaceID_SS06dialogE0SbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"getDialogNode(workspaceID:dialogNode:includeAudit:headers:failure:success:)","abstract":"

Get dialog node.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C16updateDialogNodeySS11workspaceID_SS06dialogE0AA06UpdatedE0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"updateDialogNode(workspaceID:dialogNode:properties:headers:failure:success:)","abstract":"

Update dialog node.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C16deleteDialogNodeySS11workspaceID_SS06dialogE0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteDialogNode(workspaceID:dialogNode:headers:failure:success:)","abstract":"

Delete dialog node.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C8listLogsySS11workspaceID_SSSg4sortAF6filterSiSg9pageLimitAF6cursors10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA13LogCollectionVc7successtF":{"name":"listLogs(workspaceID:sort:filter:pageLimit:cursor:headers:failure:success:)","abstract":"

List log events in a workspace.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11listAllLogsySS6filter_SSSg4sortSiSg9pageLimitAF6cursors10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA13LogCollectionVc7successtF":{"name":"listAllLogs(filter:sort:pageLimit:cursor:headers:failure:success:)","abstract":"

List log events in all workspaces.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

Delete labeled data.

","parent_name":"Assistant"},"Classes/Assistant.html":{"name":"Assistant","abstract":"

The IBM Watson Assistant service combines machine learning, natural language understanding, and integrated dialog tools"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file +{"Structs/WorkspaceExport/Status.html#/s:11AssistantV115WorkspaceExportV6StatusO11nonExistentA2EmF":{"name":"nonExistent","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:11AssistantV115WorkspaceExportV6StatusO8trainingA2EmF":{"name":"training","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:11AssistantV115WorkspaceExportV6StatusO6failedA2EmF":{"name":"failed","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:11AssistantV115WorkspaceExportV6StatusO9availableA2EmF":{"name":"available","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:11AssistantV115WorkspaceExportV6StatusO11unavailableA2EmF":{"name":"unavailable","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html":{"name":"Status","abstract":"

The current status of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV4nameSSvp":{"name":"name","abstract":"

The name of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV11descriptionSSvp":{"name":"description","abstract":"

The description of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV8languageSSvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV8metadatas10DictionaryVySSAA4JSONOGvp":{"name":"metadata","abstract":"

Any metadata that is required by the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The workspace ID.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV6statusSSvp":{"name":"status","abstract":"

The current status of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV14learningOptOutSbvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV7intentsSayAA06IntentD0VGSgvp":{"name":"intents","abstract":"

An array of intents.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV8entitiesSayAA06EntityD0VGSgvp":{"name":"entities","abstract":"

An array of entities.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV15counterexamplesSayAA14CounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of counterexamples.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV11dialogNodesSayAA10DialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects describing the dialog nodes in the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceCollection.html#/s:11AssistantV119WorkspaceCollectionV10workspacesSayAA0C0VGvp":{"name":"workspaces","abstract":"

An array of objects describing the workspaces associated with the service instance.

","parent_name":"WorkspaceCollection"},"Structs/WorkspaceCollection.html#/s:11AssistantV119WorkspaceCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

An object defining the pagination data for the returned objects.

","parent_name":"WorkspaceCollection"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV4nameSSvp":{"name":"name","abstract":"

The name of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV8languageSSvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The workspace ID.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for","parent_name":"Workspace"},"Structs/ValueExport/ValueType.html#/s:11AssistantV111ValueExportV0C4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/ValueExport/ValueType.html#/s:11AssistantV111ValueExportV0C4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/ValueExport/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV9valueTextSSvp":{"name":"valueText","abstract":"

The text of the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array containing any patterns for the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV9valueTypeSSvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"ValueExport"},"Structs/ValueCollection.html#/s:11AssistantV115ValueCollectionV6valuesSayAA0C6ExportVGvp":{"name":"values","abstract":"

An array of entity values.

","parent_name":"ValueCollection"},"Structs/ValueCollection.html#/s:11AssistantV115ValueCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

An object defining the pagination data for the returned objects.

","parent_name":"ValueCollection"},"Structs/Value/ValueType.html#/s:11AssistantV15ValueV0C4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/Value/ValueType.html#/s:11AssistantV15ValueV0C4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/Value/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV9valueTextSSvp":{"name":"valueText","abstract":"

The text of the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array containing any patterns for the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV9valueTypeSSvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"Value"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV4nameSSSgvp":{"name":"name","abstract":"

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV8languageSSSgvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV7intentsSayAA12CreateIntentVGSgvp":{"name":"intents","abstract":"

An array of objects defining the intents for the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV8entitiesSayAA12CreateEntityVGSgvp":{"name":"entities","abstract":"

An array of objects defining the entities for the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV11dialogNodesSayAA16CreateDialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects defining the nodes in the workspace dialog.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV15counterexamplesSayAA20CreateCounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of objects defining input examples that have been marked as irrelevant input.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceVACSSSg4name_AD11descriptionAD8languageSayAA12CreateIntentVGSg7intentsSayAA0H6EntityVGSg8entitiesSayAA0H10DialogNodeVGSg11dialogNodesSayAA0H14CounterexampleVGSg15counterexampless10DictionaryVySSAA4JSONOGSg8metadataSbSg14learningOptOuttcfc":{"name":"init(name:description:language:intents:entities:dialogNodes:counterexamples:metadata:learningOptOut:)","abstract":"

Initialize a UpdateWorkspace with member variables.

","parent_name":"UpdateWorkspace"},"Structs/UpdateValue/ValueType.html#/s:11AssistantV111UpdateValueV0D4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/UpdateValue/ValueType.html#/s:11AssistantV111UpdateValueV0D4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/UpdateValue/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueV5valueSSSgvp":{"name":"value","abstract":"

The text of the entity value. This string must conform to the following restrictions:

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueV9valueTypeSSSgvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type),","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type),","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueVACSSSg5value_s10DictionaryVySSAA4JSONOGSg8metadataAD0E4TypeSaySSGSg8synonymsAO8patternstcfc":{"name":"init(value:metadata:valueType:synonyms:patterns:)","abstract":"

Initialize a UpdateValue with member variables.

","parent_name":"UpdateValue"},"Structs/UpdateSynonym.html#/s:11AssistantV113UpdateSynonymV7synonymSSSgvp":{"name":"synonym","abstract":"

The text of the synonym. This string must conform to the following restrictions:

","parent_name":"UpdateSynonym"},"Structs/UpdateSynonym.html#/s:11AssistantV113UpdateSynonymVACSSSg7synonym_tcfc":{"name":"init(synonym:)","abstract":"

Initialize a UpdateSynonym with member variables.

","parent_name":"UpdateSynonym"},"Structs/UpdateIntent.html#/s:11AssistantV112UpdateIntentV6intentSSSgvp":{"name":"intent","abstract":"

The name of the intent. This string must conform to the following restrictions:

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:11AssistantV112UpdateIntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:11AssistantV112UpdateIntentV8examplesSayAA13CreateExampleVGSgvp":{"name":"examples","abstract":"

An array of user input examples for the intent.

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:11AssistantV112UpdateIntentVACSSSg6intent_AD11descriptionSayAA13CreateExampleVGSg8examplestcfc":{"name":"init(intent:description:examples:)","abstract":"

Initialize a UpdateIntent with member variables.

","parent_name":"UpdateIntent"},"Structs/UpdateExample.html#/s:11AssistantV113UpdateExampleV4textSSSgvp":{"name":"text","abstract":"

The text of the user input example. This string must conform to the following restrictions:

","parent_name":"UpdateExample"},"Structs/UpdateExample.html#/s:11AssistantV113UpdateExampleVACSSSg4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a UpdateExample with member variables.

","parent_name":"UpdateExample"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityV6entitySSSgvp":{"name":"entity","abstract":"

The name of the entity. This string must conform to the following restrictions:

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether to use fuzzy matching for the entity.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityV6valuesSayAA11CreateValueVGSgvp":{"name":"values","abstract":"

An array of entity values.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityVACSSSg6entity_AD11descriptions10DictionaryVySSAA4JSONOGSg8metadataSbSg10fuzzyMatchSayAA11CreateValueVGSg6valuestcfc":{"name":"init(entity:description:metadata:fuzzyMatch:values:)","abstract":"

Initialize a UpdateEntity with member variables.

","parent_name":"UpdateEntity"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:11AssistantV116UpdateDialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:11AssistantV116UpdateDialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:11AssistantV116UpdateDialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOut.html#/s:11AssistantV116UpdateDialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressOut.html#/s:11AssistantV116UpdateDialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressOut.html#/s:11AssistantV116UpdateDialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressIn.html#/s:11AssistantV116UpdateDialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/DigressIn.html#/s:11AssistantV116UpdateDialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/DigressIn.html#/s:11AssistantV116UpdateDialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV06dialogE0SSSgvp":{"name":"dialogNode","abstract":"

The dialog node ID. This string must conform to the following restrictions:

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous sibling dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node. For more information about how to specify dialog node output, see the","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context for the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

The metadata for the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV8nextStepAA0de4NextG0VSgvp":{"name":"nextStep","abstract":"

The next step to be executed in dialog processing.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node. This string must conform to the following restrictions:

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV7actionsSayAA0dE6ActionVGSgvp":{"name":"actions","abstract":"

An array of objects describing any actions to be invoked by the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeVACSSSg06dialogE0_AD11descriptionAD10conditionsAD6parentAD15previousSiblings10DictionaryVySSAA4JSONOGSg6outputAO7contextAO8metadataAA0dE8NextStepVSg04nextR0AD5titleAD8nodeTypeAD9eventNameAD8variableSayAA0dE6ActionVGSg7actionsAD9digressInAD10digressOutAD15digressOutSlotstcfc":{"name":"init(dialogNode:description:conditions:parent:previousSibling:output:context:metadata:nextStep:title:nodeType:eventName:variable:actions:digressIn:digressOut:digressOutSlots:)","abstract":"

Initialize a UpdateDialogNode with member variables.

","parent_name":"UpdateDialogNode"},"Structs/UpdateCounterexample.html#/s:11AssistantV120UpdateCounterexampleV4textSSSgvp":{"name":"text","abstract":"

The text of a user input counterexample.

","parent_name":"UpdateCounterexample"},"Structs/UpdateCounterexample.html#/s:11AssistantV120UpdateCounterexampleVACSSSg4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a UpdateCounterexample with member variables.

","parent_name":"UpdateCounterexample"},"Structs/SystemResponse.html#/s:11AssistantV114SystemResponseV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:11AssistantV114SystemResponseVACs10DictionaryVySSAA4JSONOG20additionalProperties_tcfc":{"name":"init(additionalProperties:)","abstract":"

Initialize a SystemResponse.

","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"SystemResponse"},"Structs/SynonymCollection.html#/s:11AssistantV117SynonymCollectionV8synonymsSayAA0C0VGvp":{"name":"synonyms","abstract":"

An array of synonyms.

","parent_name":"SynonymCollection"},"Structs/SynonymCollection.html#/s:11AssistantV117SynonymCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"SynonymCollection"},"Structs/Synonym.html#/s:11AssistantV17SynonymV11synonymTextSSvp":{"name":"synonymText","abstract":"

The text of the synonym.

","parent_name":"Synonym"},"Structs/Synonym.html#/s:11AssistantV17SynonymV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the synonym.

","parent_name":"Synonym"},"Structs/Synonym.html#/s:11AssistantV17SynonymV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the most recent update to the synonym.

","parent_name":"Synonym"},"Structs/RuntimeIntent.html#/s:11AssistantV113RuntimeIntentV6intentSSvp":{"name":"intent","abstract":"

The name of the recognized intent.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:11AssistantV113RuntimeIntentV10confidenceSdvp":{"name":"confidence","abstract":"

A decimal percentage that represents Watson’s confidence in the intent.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:11AssistantV113RuntimeIntentV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:11AssistantV113RuntimeIntentVACSS6intent_Sd10confidences10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(intent:confidence:additionalProperties:)","abstract":"

Initialize a RuntimeIntent with member variables.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"RuntimeIntent"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV6entitySSvp":{"name":"entity","abstract":"

An entity detected in the input.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV8locationSaySiGvp":{"name":"location","abstract":"

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV5valueSSvp":{"name":"value","abstract":"

The term in the input text that was recognized as an entity value.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV10confidenceSdSgvp":{"name":"confidence","abstract":"

A decimal percentage that represents Watson’s confidence in the entity.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata for the entity.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV6groupsSayAA12CaptureGroupVGSgvp":{"name":"groups","abstract":"

The recognized capture groups for the entity, as defined by the entity pattern.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityVACSS6entity_SaySiG8locationSS5valueSdSg10confidences10DictionaryVySSAA4JSONOGSg8metadataSayAA12CaptureGroupVGSg6groupsAN20additionalPropertiestcfc":{"name":"init(entity:location:value:confidence:metadata:groups:additionalProperties:)","abstract":"

Initialize a RuntimeEntity with member variables.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"RuntimeEntity"},"Structs/Pagination.html#/s:11AssistantV110PaginationV10refreshUrlSSvp":{"name":"refreshUrl","abstract":"

The URL that will return the same page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:11AssistantV110PaginationV7nextUrlSSSgvp":{"name":"nextUrl","abstract":"

The URL that will return the next page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:11AssistantV110PaginationV5totalSiSgvp":{"name":"total","abstract":"

Reserved for future use.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:11AssistantV110PaginationV7matchedSiSgvp":{"name":"matched","abstract":"

Reserved for future use.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:11AssistantV110PaginationV13refreshCursorSSSgvp":{"name":"refreshCursor","abstract":"

A token identifying the current page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:11AssistantV110PaginationV10nextCursorSSSgvp":{"name":"nextCursor","abstract":"

A token identifying the next page of results.

","parent_name":"Pagination"},"Structs/OutputData.html#/s:11AssistantV110OutputDataV11logMessagesSayAA10LogMessageVGvp":{"name":"logMessages","abstract":"

An array of up to 50 messages logged with the request.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:11AssistantV110OutputDataV4textSaySSGvp":{"name":"text","abstract":"

An array of responses to the user.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:11AssistantV110OutputDataV12nodesVisitedSaySSGSgvp":{"name":"nodesVisited","abstract":"

An array of the nodes that were triggered to create the response, in the order in which they were visited. This","parent_name":"OutputData"},"Structs/OutputData.html#/s:11AssistantV110OutputDataV19nodesVisitedDetailsSayAA010DialogNodefG0VGSgvp":{"name":"nodesVisitedDetails","abstract":"

An array of objects containing detailed diagnostic information about the nodes that were triggered during","parent_name":"OutputData"},"Structs/OutputData.html#/s:11AssistantV110OutputDataV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:11AssistantV110OutputDataVACSayAA10LogMessageVG11logMessages_SaySSG4textAHSg12nodesVisitedSayAA010DialogNodeK7DetailsVGSg0jkN0s10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(logMessages:text:nodesVisited:nodesVisitedDetails:additionalProperties:)","abstract":"

Initialize a OutputData with member variables.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"OutputData"},"Structs/OutputData.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"OutputData"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV5inputAA0C5InputVSgvp":{"name":"input","abstract":"

The user input from the request.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV7intentsSayAA13RuntimeIntentVGvp":{"name":"intents","abstract":"

An array of intents recognized in the user input, sorted in descending order of confidence.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV8entitiesSayAA13RuntimeEntityVGvp":{"name":"entities","abstract":"

An array of entities identified in the user input.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV16alternateIntentsSbSgvp":{"name":"alternateIntents","abstract":"

Whether to return more than one intent. A value of true indicates that all matching intents are returned.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV7contextAA7ContextVvp":{"name":"context","abstract":"

State information for the conversation.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV6outputAA10OutputDataVvp":{"name":"output","abstract":"

Output from the dialog, including the response to the user, the nodes that were triggered, and log messages.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"MessageResponse"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV5inputAA9InputDataVSgvp":{"name":"input","abstract":"

An input object that includes the input text.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV16alternateIntentsSbSgvp":{"name":"alternateIntents","abstract":"

Whether to return more than one intent. Set to true to return all matching intents.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV7contextAA7ContextVSgvp":{"name":"context","abstract":"

State information for the conversation. Continue a conversation by including the context object from the previous","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV8entitiesSayAA13RuntimeEntityVGSgvp":{"name":"entities","abstract":"

Entities to use when evaluating the message. Include entities from the previous response to continue using those","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV7intentsSayAA13RuntimeIntentVGSgvp":{"name":"intents","abstract":"

Intents to use when evaluating the user input. Include intents from the previous response to continue using those","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV6outputAA10OutputDataVSgvp":{"name":"output","abstract":"

System output. Include the output from the previous response to maintain intermediate information over multiple","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestVAcA9InputDataVSg5input_SbSg16alternateIntentsAA7ContextVSg7contextSayAA13RuntimeEntityVGSg8entitiesSayAA0L6IntentVGSg7intentsAA06OutputF0VSg6outputtcfc":{"name":"init(input:alternateIntents:context:entities:intents:output:)","abstract":"

Initialize a MessageRequest with member variables.

","parent_name":"MessageRequest"},"Structs/MessageInput.html#/s:11AssistantV112MessageInputV4textSSSgvp":{"name":"text","abstract":"

The user’s input.

","parent_name":"MessageInput"},"Structs/LogPagination.html#/s:11AssistantV113LogPaginationV7nextUrlSSSgvp":{"name":"nextUrl","abstract":"

The URL that will return the next page of results, if any.

","parent_name":"LogPagination"},"Structs/LogPagination.html#/s:11AssistantV113LogPaginationV7matchedSiSgvp":{"name":"matched","abstract":"

Reserved for future use.

","parent_name":"LogPagination"},"Structs/LogPagination.html#/s:11AssistantV113LogPaginationV10nextCursorSSSgvp":{"name":"nextCursor","abstract":"

A token identifying the next page of results.

","parent_name":"LogPagination"},"Structs/LogMessage/Level.html#/s:11AssistantV110LogMessageV5LevelO4infoA2EmF":{"name":"info","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html#/s:11AssistantV110LogMessageV5LevelO5errorA2EmF":{"name":"error","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html#/s:11AssistantV110LogMessageV5LevelO4warnA2EmF":{"name":"warn","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html":{"name":"Level","abstract":"

The severity of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:11AssistantV110LogMessageV5levelSSvp":{"name":"level","abstract":"

The severity of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:11AssistantV110LogMessageV3msgSSvp":{"name":"msg","abstract":"

The text of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:11AssistantV110LogMessageV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:11AssistantV110LogMessageVACSS5level_SS3msgs10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(level:msg:additionalProperties:)","abstract":"

Initialize a LogMessage with member variables.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"LogMessage"},"Structs/LogExport.html#/s:11AssistantV19LogExportV7requestAA14MessageRequestVvp":{"name":"request","abstract":"

A request received by the workspace, including the user input and context.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV8responseAA15MessageResponseVvp":{"name":"response","abstract":"

The response sent by the workspace, including the output text, detected intents and entities, and context.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV5logIDSSvp":{"name":"logID","abstract":"

A unique identifier for the logged event.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV16requestTimestampSSvp":{"name":"requestTimestamp","abstract":"

The timestamp for receipt of the message.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV17responseTimestampSSvp":{"name":"responseTimestamp","abstract":"

The timestamp for the system response to the message.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The unique identifier of the workspace where the request was made.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV8languageSSvp":{"name":"language","abstract":"

The language of the workspace where the message request was made.

","parent_name":"LogExport"},"Structs/LogCollection.html#/s:11AssistantV113LogCollectionV4logsSayAA0C6ExportVGvp":{"name":"logs","abstract":"

An array of objects describing log events.

","parent_name":"LogCollection"},"Structs/LogCollection.html#/s:11AssistantV113LogCollectionV10paginationAA0C10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"LogCollection"},"Structs/IntentExport.html#/s:11AssistantV112IntentExportV10intentNameSSvp":{"name":"intentName","abstract":"

The name of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:11AssistantV112IntentExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:11AssistantV112IntentExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:11AssistantV112IntentExportV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:11AssistantV112IntentExportV8examplesSayAA7ExampleVGSgvp":{"name":"examples","abstract":"

An array of objects describing the user input examples for the intent.

","parent_name":"IntentExport"},"Structs/IntentCollection.html#/s:11AssistantV116IntentCollectionV7intentsSayAA0C6ExportVGvp":{"name":"intents","abstract":"

An array of objects describing the intents defined for the workspace.

","parent_name":"IntentCollection"},"Structs/IntentCollection.html#/s:11AssistantV116IntentCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"IntentCollection"},"Structs/Intent.html#/s:11AssistantV16IntentV10intentNameSSvp":{"name":"intentName","abstract":"

The name of the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:11AssistantV16IntentV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:11AssistantV16IntentV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:11AssistantV16IntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"Intent"},"Structs/InputData.html#/s:11AssistantV19InputDataV4textSSvp":{"name":"text","abstract":"

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be","parent_name":"InputData"},"Structs/InputData.html#/s:11AssistantV19InputDataVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a InputData with member variables.

","parent_name":"InputData"},"Structs/ExampleCollection.html#/s:11AssistantV117ExampleCollectionV8examplesSayAA0C0VGvp":{"name":"examples","abstract":"

An array of objects describing the examples defined for the intent.

","parent_name":"ExampleCollection"},"Structs/ExampleCollection.html#/s:11AssistantV117ExampleCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"ExampleCollection"},"Structs/Example.html#/s:11AssistantV17ExampleV11exampleTextSSvp":{"name":"exampleText","abstract":"

The text of the user input example.

","parent_name":"Example"},"Structs/Example.html#/s:11AssistantV17ExampleV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the example.

","parent_name":"Example"},"Structs/Example.html#/s:11AssistantV17ExampleV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the example.

","parent_name":"Example"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV10entityNameSSvp":{"name":"entityName","abstract":"

The name of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether fuzzy matching is used for the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV6valuesSayAA05ValueD0VGSgvp":{"name":"values","abstract":"

An array objects describing the entity values.

","parent_name":"EntityExport"},"Structs/EntityCollection.html#/s:11AssistantV116EntityCollectionV8entitiesSayAA0C6ExportVGvp":{"name":"entities","abstract":"

An array of objects describing the entities defined for the workspace.

","parent_name":"EntityCollection"},"Structs/EntityCollection.html#/s:11AssistantV116EntityCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"EntityCollection"},"Structs/Entity.html#/s:11AssistantV16EntityV10entityNameSSvp":{"name":"entityName","abstract":"

The name of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:11AssistantV16EntityV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:11AssistantV16EntityV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:11AssistantV16EntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:11AssistantV16EntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:11AssistantV16EntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether fuzzy matching is used for the entity.

","parent_name":"Entity"},"Structs/DialogNodeVisitedDetails.html#/s:11AssistantV124DialogNodeVisitedDetailsV06dialogD0SSSgvp":{"name":"dialogNode","abstract":"

A dialog node that was triggered during processing of the input message.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:11AssistantV124DialogNodeVisitedDetailsV5titleSSSgvp":{"name":"title","abstract":"

The title of the dialog node.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:11AssistantV124DialogNodeVisitedDetailsV10conditionsSSSgvp":{"name":"conditions","abstract":"

The conditions that trigger the dialog node.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:11AssistantV124DialogNodeVisitedDetailsVACSSSg06dialogD0_AD5titleAD10conditionstcfc":{"name":"init(dialogNode:title:conditions:)","abstract":"

Initialize a DialogNodeVisitedDetails with member variables.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeNextStep/Selector.html#/s:11AssistantV118DialogNodeNextStepV8SelectorO9conditionA2EmF":{"name":"condition","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:11AssistantV118DialogNodeNextStepV8SelectorO6clientA2EmF":{"name":"client","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:11AssistantV118DialogNodeNextStepV8SelectorO9userInputA2EmF":{"name":"userInput","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:11AssistantV118DialogNodeNextStepV8SelectorO4bodyA2EmF":{"name":"body","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO12getUserInputA2EmF":{"name":"getUserInput","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO13skipUserInputA2EmF":{"name":"skipUserInput","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO6jumpToA2EmF":{"name":"jumpTo","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO8repromptA2EmF":{"name":"reprompt","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO8skipSlotA2EmF":{"name":"skipSlot","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO12skipAllSlotsA2EmF":{"name":"skipAllSlots","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html":{"name":"Behavior","abstract":"

What happens after the dialog node completes. The valid values depend on the node type:

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep/Selector.html":{"name":"Selector","abstract":"

Which part of the dialog node to process next.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:11AssistantV118DialogNodeNextStepV8behaviorSSvp":{"name":"behavior","abstract":"

What happens after the dialog node completes. The valid values depend on the node type:

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:11AssistantV118DialogNodeNextStepV06dialogD0SSSgvp":{"name":"dialogNode","abstract":"

The ID of the dialog node to process next. This parameter is required if behavior=jump_to.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:11AssistantV118DialogNodeNextStepV8selectorSSSgvp":{"name":"selector","abstract":"

Which part of the dialog node to process next.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:11AssistantV118DialogNodeNextStepVACSS8behavior_SSSg06dialogD0AE8selectortcfc":{"name":"init(behavior:dialogNode:selector:)","abstract":"

Initialize a DialogNodeNextStep with member variables.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeCollection.html#/s:11AssistantV120DialogNodeCollectionV11dialogNodesSayAA0cD0VGvp":{"name":"dialogNodes","abstract":"

An array of objects describing the dialog nodes defined for the workspace.

","parent_name":"DialogNodeCollection"},"Structs/DialogNodeCollection.html#/s:11AssistantV120DialogNodeCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"DialogNodeCollection"},"Structs/DialogNodeAction/ActionType.html#/s:11AssistantV116DialogNodeActionV0E4TypeO6clientA2EmF":{"name":"client","abstract":"

Undocumented

","parent_name":"ActionType"},"Structs/DialogNodeAction/ActionType.html#/s:11AssistantV116DialogNodeActionV0E4TypeO6serverA2EmF":{"name":"server","abstract":"

Undocumented

","parent_name":"ActionType"},"Structs/DialogNodeAction/ActionType.html":{"name":"ActionType","abstract":"

The type of action to invoke.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionV4nameSSvp":{"name":"name","abstract":"

The name of the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionV10actionTypeSSSgvp":{"name":"actionType","abstract":"

The type of action to invoke.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionV10parameterss10DictionaryVySSAA4JSONOGSgvp":{"name":"parameters","abstract":"

A map of key/value pairs to be provided to the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionV14resultVariableSSvp":{"name":"resultVariable","abstract":"

The location in the dialog context where the result of the action is stored.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionV11credentialsSSSgvp":{"name":"credentials","abstract":"

The name of the context variable that the client application will use to pass in credentials for the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionVACSS4name_SS14resultVariableSSSg10actionTypes10DictionaryVySSAA4JSONOGSg10parametersAF11credentialstcfc":{"name":"init(name:resultVariable:actionType:parameters:credentials:)","abstract":"

Initialize a DialogNodeAction with member variables.

","parent_name":"DialogNodeAction"},"Structs/DialogNode/DigressOutSlots.html#/s:11AssistantV110DialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOutSlots.html#/s:11AssistantV110DialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOutSlots.html#/s:11AssistantV110DialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOut.html#/s:11AssistantV110DialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressOut.html#/s:11AssistantV110DialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressOut.html#/s:11AssistantV110DialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressIn.html#/s:11AssistantV110DialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/DigressIn.html#/s:11AssistantV110DialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/DigressIn.html#/s:11AssistantV110DialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV06dialogD2IDSSvp":{"name":"dialogNodeID","abstract":"

The dialog node ID.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that triggers the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node. This property is not returned if the dialog node has no parent.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous sibling dialog node. This property is not returned if the dialog node has no previous","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context (if defined) for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV8nextStepAA0cd4NextF0VSgvp":{"name":"nextStep","abstract":"

The next step to execute following this dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the most recent update to the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV7actionsSayAA0cD6ActionVGSgvp":{"name":"actions","abstract":"

The actions for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"DialogNode"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV4nameSSSgvp":{"name":"name","abstract":"

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV8languageSSSgvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV7intentsSayAA0C6IntentVGSgvp":{"name":"intents","abstract":"

An array of objects defining the intents for the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV8entitiesSayAA0C6EntityVGSgvp":{"name":"entities","abstract":"

An array of objects defining the entities for the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV11dialogNodesSayAA0C10DialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects defining the nodes in the workspace dialog.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV15counterexamplesSayAA0C14CounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of objects defining input examples that have been marked as irrelevant input.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceVACSSSg4name_AD11descriptionAD8languageSayAA0C6IntentVGSg7intentsSayAA0C6EntityVGSg8entitiesSayAA0C10DialogNodeVGSg11dialogNodesSayAA0C14CounterexampleVGSg15counterexampless10DictionaryVySSAA4JSONOGSg8metadataSbSg14learningOptOuttcfc":{"name":"init(name:description:language:intents:entities:dialogNodes:counterexamples:metadata:learningOptOut:)","abstract":"

Initialize a CreateWorkspace with member variables.

","parent_name":"CreateWorkspace"},"Structs/CreateValue/ValueType.html#/s:11AssistantV111CreateValueV0D4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/CreateValue/ValueType.html#/s:11AssistantV111CreateValueV0D4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/CreateValue/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueV5valueSSvp":{"name":"value","abstract":"

The text of the entity value. This string must conform to the following restrictions:

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type),","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueV9valueTypeSSSgvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueVACSS5value_s10DictionaryVySSAA4JSONOGSg8metadataSaySSGSg8synonymsAM8patternsSSSg0E4Typetcfc":{"name":"init(value:metadata:synonyms:patterns:valueType:)","abstract":"

Initialize a CreateValue with member variables.

","parent_name":"CreateValue"},"Structs/CreateSynonym.html#/s:11AssistantV113CreateSynonymV7synonymSSvp":{"name":"synonym","abstract":"

The text of the synonym. This string must conform to the following restrictions:

","parent_name":"CreateSynonym"},"Structs/CreateSynonym.html#/s:11AssistantV113CreateSynonymVACSS7synonym_tcfc":{"name":"init(synonym:)","abstract":"

Initialize a CreateSynonym with member variables.

","parent_name":"CreateSynonym"},"Structs/CreateIntent.html#/s:11AssistantV112CreateIntentV6intentSSvp":{"name":"intent","abstract":"

The name of the intent. This string must conform to the following restrictions:

","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:11AssistantV112CreateIntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:11AssistantV112CreateIntentV8examplesSayAA0C7ExampleVGSgvp":{"name":"examples","abstract":"

An array of user input examples for the intent.

","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:11AssistantV112CreateIntentVACSS6intent_SSSg11descriptionSayAA0C7ExampleVGSg8examplestcfc":{"name":"init(intent:description:examples:)","abstract":"

Initialize a CreateIntent with member variables.

","parent_name":"CreateIntent"},"Structs/CreateExample.html#/s:11AssistantV113CreateExampleV4textSSvp":{"name":"text","abstract":"

The text of a user input example. This string must conform to the following restrictions:

","parent_name":"CreateExample"},"Structs/CreateExample.html#/s:11AssistantV113CreateExampleVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a CreateExample with member variables.

","parent_name":"CreateExample"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityV6entitySSvp":{"name":"entity","abstract":"

The name of the entity. This string must conform to the following restrictions:

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the value.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityV6valuesSayAA0C5ValueVGSgvp":{"name":"values","abstract":"

An array of objects describing the entity values.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether to use fuzzy matching for the entity.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityVACSS6entity_SSSg11descriptions10DictionaryVySSAA4JSONOGSg8metadataSayAA0C5ValueVGSg6valuesSbSg10fuzzyMatchtcfc":{"name":"init(entity:description:metadata:values:fuzzyMatch:)","abstract":"

Initialize a CreateEntity with member variables.

","parent_name":"CreateEntity"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:11AssistantV116CreateDialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:11AssistantV116CreateDialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:11AssistantV116CreateDialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOut.html#/s:11AssistantV116CreateDialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressOut.html#/s:11AssistantV116CreateDialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressOut.html#/s:11AssistantV116CreateDialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressIn.html#/s:11AssistantV116CreateDialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/DigressIn.html#/s:11AssistantV116CreateDialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/DigressIn.html#/s:11AssistantV116CreateDialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV06dialogE0SSvp":{"name":"dialogNode","abstract":"

The dialog node ID. This string must conform to the following restrictions:

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node. For more information about how to specify dialog node output, see the","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context for the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

The metadata for the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV8nextStepAA0de4NextG0VSgvp":{"name":"nextStep","abstract":"

The next step to be executed in dialog processing.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV7actionsSayAA0dE6ActionVGSgvp":{"name":"actions","abstract":"

An array of objects describing any actions to be invoked by the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node. This string must conform to the following restrictions:

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeVACSS06dialogE0_SSSg11descriptionAE10conditionsAE6parentAE15previousSiblings10DictionaryVySSAA4JSONOGSg6outputAO7contextAO8metadataAA0dE8NextStepVSg04nextR0SayAA0dE6ActionVGSg7actionsAE5titleAE8nodeTypeAE9eventNameAE8variableAE9digressInAE10digressOutAE15digressOutSlotstcfc":{"name":"init(dialogNode:description:conditions:parent:previousSibling:output:context:metadata:nextStep:actions:title:nodeType:eventName:variable:digressIn:digressOut:digressOutSlots:)","abstract":"

Initialize a CreateDialogNode with member variables.

","parent_name":"CreateDialogNode"},"Structs/CreateCounterexample.html#/s:11AssistantV120CreateCounterexampleV4textSSvp":{"name":"text","abstract":"

The text of a user input marked as irrelevant input. This string must conform to the following restrictions:

","parent_name":"CreateCounterexample"},"Structs/CreateCounterexample.html#/s:11AssistantV120CreateCounterexampleVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a CreateCounterexample with member variables.

","parent_name":"CreateCounterexample"},"Structs/CounterexampleCollection.html#/s:11AssistantV124CounterexampleCollectionV15counterexamplesSayAA0C0VGvp":{"name":"counterexamples","abstract":"

An array of objects describing the examples marked as irrelevant input.

","parent_name":"CounterexampleCollection"},"Structs/CounterexampleCollection.html#/s:11AssistantV124CounterexampleCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"CounterexampleCollection"},"Structs/Counterexample.html#/s:11AssistantV114CounterexampleV4textSSvp":{"name":"text","abstract":"

The text of the counterexample.

","parent_name":"Counterexample"},"Structs/Counterexample.html#/s:11AssistantV114CounterexampleV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the counterexample.

","parent_name":"Counterexample"},"Structs/Counterexample.html#/s:11AssistantV114CounterexampleV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the counterexample.

","parent_name":"Counterexample"},"Structs/Context.html#/s:11AssistantV17ContextV14conversationIDSSSgvp":{"name":"conversationID","abstract":"

The unique identifier of the conversation.

","parent_name":"Context"},"Structs/Context.html#/s:11AssistantV17ContextV6systemAA14SystemResponseVSgvp":{"name":"system","abstract":"

For internal use only.

","parent_name":"Context"},"Structs/Context.html#/s:11AssistantV17ContextV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"Context"},"Structs/Context.html#/s:11AssistantV17ContextVACSSSg14conversationID_AA14SystemResponseVSg6systems10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(conversationID:system:additionalProperties:)","abstract":"

Initialize a Context with member variables.

","parent_name":"Context"},"Structs/Context.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"Context"},"Structs/Context.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"Context"},"Structs/CaptureGroup.html#/s:11AssistantV112CaptureGroupV5groupSSvp":{"name":"group","abstract":"

A recognized capture group for the entity.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html#/s:11AssistantV112CaptureGroupV8locationSaySiGSgvp":{"name":"location","abstract":"

Zero-based character offsets that indicate where the entity value begins and ends in the input text.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html#/s:11AssistantV112CaptureGroupVACSS5group_SaySiGSg8locationtcfc":{"name":"init(group:location:)","abstract":"

Initialize a CaptureGroup with member variables.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html":{"name":"CaptureGroup","abstract":"

CaptureGroup.

"},"Structs/Context.html":{"name":"Context","abstract":"

State information for the conversation. To maintain state, include the context from the previous response.

"},"Structs/Counterexample.html":{"name":"Counterexample","abstract":"

Counterexample.

"},"Structs/CounterexampleCollection.html":{"name":"CounterexampleCollection","abstract":"

CounterexampleCollection.

"},"Structs/CreateCounterexample.html":{"name":"CreateCounterexample","abstract":"

CreateCounterexample.

"},"Structs/CreateDialogNode.html":{"name":"CreateDialogNode","abstract":"

CreateDialogNode.

"},"Structs/CreateEntity.html":{"name":"CreateEntity","abstract":"

CreateEntity.

"},"Structs/CreateExample.html":{"name":"CreateExample","abstract":"

CreateExample.

"},"Structs/CreateIntent.html":{"name":"CreateIntent","abstract":"

CreateIntent.

"},"Structs/CreateSynonym.html":{"name":"CreateSynonym","abstract":"

CreateSynonym.

"},"Structs/CreateValue.html":{"name":"CreateValue","abstract":"

CreateValue.

"},"Structs/CreateWorkspace.html":{"name":"CreateWorkspace","abstract":"

CreateWorkspace.

"},"Structs/DialogNode.html":{"name":"DialogNode","abstract":"

DialogNode.

"},"Structs/DialogNodeAction.html":{"name":"DialogNodeAction","abstract":"

DialogNodeAction.

"},"Structs/DialogNodeCollection.html":{"name":"DialogNodeCollection","abstract":"

An array of dialog nodes.

"},"Structs/DialogNodeNextStep.html":{"name":"DialogNodeNextStep","abstract":"

The next step to execute following this dialog node.

"},"Structs/DialogNodeVisitedDetails.html":{"name":"DialogNodeVisitedDetails","abstract":"

DialogNodeVisitedDetails.

"},"Structs/Entity.html":{"name":"Entity","abstract":"

Entity.

"},"Structs/EntityCollection.html":{"name":"EntityCollection","abstract":"

An array of entities.

"},"Structs/EntityExport.html":{"name":"EntityExport","abstract":"

EntityExport.

"},"Structs/Example.html":{"name":"Example","abstract":"

Example.

"},"Structs/ExampleCollection.html":{"name":"ExampleCollection","abstract":"

ExampleCollection.

"},"Structs/InputData.html":{"name":"InputData","abstract":"

The user input.

"},"Structs/Intent.html":{"name":"Intent","abstract":"

Intent.

"},"Structs/IntentCollection.html":{"name":"IntentCollection","abstract":"

IntentCollection.

"},"Structs/IntentExport.html":{"name":"IntentExport","abstract":"

IntentExport.

"},"Structs/LogCollection.html":{"name":"LogCollection","abstract":"

LogCollection.

"},"Structs/LogExport.html":{"name":"LogExport","abstract":"

LogExport.

"},"Structs/LogMessage.html":{"name":"LogMessage","abstract":"

Log message details.

"},"Structs/LogPagination.html":{"name":"LogPagination","abstract":"

The pagination data for the returned objects.

"},"Structs/MessageInput.html":{"name":"MessageInput","abstract":"

The text of the user input.

"},"Structs/MessageRequest.html":{"name":"MessageRequest","abstract":"

A request formatted for the Watson Assistant service.

"},"Structs/MessageResponse.html":{"name":"MessageResponse","abstract":"

A response from the Watson Assistant service.

"},"Structs/OutputData.html":{"name":"OutputData","abstract":"

An output object that includes the response to the user, the nodes that were hit, and messages from the log.

"},"Structs/Pagination.html":{"name":"Pagination","abstract":"

The pagination data for the returned objects.

"},"Structs/RuntimeEntity.html":{"name":"RuntimeEntity","abstract":"

A term from the request that was identified as an entity.

"},"Structs/RuntimeIntent.html":{"name":"RuntimeIntent","abstract":"

An intent identified in the user input.

"},"Structs/Synonym.html":{"name":"Synonym","abstract":"

Synonym.

"},"Structs/SynonymCollection.html":{"name":"SynonymCollection","abstract":"

SynonymCollection.

"},"Structs/SystemResponse.html":{"name":"SystemResponse","abstract":"

For internal use only.

"},"Structs/UpdateCounterexample.html":{"name":"UpdateCounterexample","abstract":"

UpdateCounterexample.

"},"Structs/UpdateDialogNode.html":{"name":"UpdateDialogNode","abstract":"

UpdateDialogNode.

"},"Structs/UpdateEntity.html":{"name":"UpdateEntity","abstract":"

UpdateEntity.

"},"Structs/UpdateExample.html":{"name":"UpdateExample","abstract":"

UpdateExample.

"},"Structs/UpdateIntent.html":{"name":"UpdateIntent","abstract":"

UpdateIntent.

"},"Structs/UpdateSynonym.html":{"name":"UpdateSynonym","abstract":"

UpdateSynonym.

"},"Structs/UpdateValue.html":{"name":"UpdateValue","abstract":"

UpdateValue.

"},"Structs/UpdateWorkspace.html":{"name":"UpdateWorkspace","abstract":"

UpdateWorkspace.

"},"Structs/Value.html":{"name":"Value","abstract":"

Value.

"},"Structs/ValueCollection.html":{"name":"ValueCollection","abstract":"

ValueCollection.

"},"Structs/ValueExport.html":{"name":"ValueExport","abstract":"

ValueExport.

"},"Structs/Workspace.html":{"name":"Workspace","abstract":"

Workspace.

"},"Structs/WorkspaceCollection.html":{"name":"WorkspaceCollection","abstract":"

WorkspaceCollection.

"},"Structs/WorkspaceExport.html":{"name":"WorkspaceExport","abstract":"

WorkspaceExport.

"},"Enums/RestError.html#/s:11AssistantV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO013serializationD0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO08encodingD0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO011fileManagerD0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:11AssistantV14JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/Assistant.html#/s:11AssistantV10A0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

Create a Assistant object.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a Assistant object.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a Assistant object.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C7messageySS11workspaceID_AA14MessageRequestVSg7requestSbSg19nodesVisitedDetailss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F8ResponseVc7successtF":{"name":"message(workspaceID:request:nodesVisitedDetails:headers:failure:success:)","abstract":"

Get response to user input.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C14listWorkspacesySiSg9pageLimit_SbSg12includeCountSSSg4sortAI6cursorAG0G5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA19WorkspaceCollectionVc7successtF":{"name":"listWorkspaces(pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List workspaces.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C15createWorkspaceyAA06CreateD0VSg10properties_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createWorkspace(properties:headers:failure:success:)","abstract":"

Create workspace.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12getWorkspaceySS11workspaceID_SbSg6exportAF12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getWorkspace(workspaceID:export:includeAudit:headers:failure:success:)","abstract":"

Get information about a workspace.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C15updateWorkspaceySS11workspaceID_AA06UpdateD0VSg10propertiesSbSg6appends10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateWorkspace(workspaceID:properties:append:headers:failure:success:)","abstract":"

Update workspace.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C15deleteWorkspaceySS11workspaceID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteWorkspace(workspaceID:headers:failure:success:)","abstract":"

Delete workspace.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11listIntentsySS11workspaceID_SbSg6exportSiSg9pageLimitAF12includeCountSSSg4sortAK6cursorAF0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA16IntentCollectionVc7successtF":{"name":"listIntents(workspaceID:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List intents.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12createIntentySS11workspaceID_SS6intentSSSg11descriptionSayAA13CreateExampleVGSg8exampless10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createIntent(workspaceID:intent:description:examples:headers:failure:success:)","abstract":"

Create intent.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C9getIntentySS11workspaceID_SS6intentSbSg6exportAG12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getIntent(workspaceID:intent:export:includeAudit:headers:failure:success:)","abstract":"

Get intent.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12updateIntentySS11workspaceID_SS6intentSSSg03newD0AG0H11DescriptionSayAA13CreateExampleVGSg0H8Exampless10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateIntent(workspaceID:intent:newIntent:newDescription:newExamples:headers:failure:success:)","abstract":"

Update intent.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12deleteIntentySS11workspaceID_SS6intents10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteIntent(workspaceID:intent:headers:failure:success:)","abstract":"

Delete intent.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12listExamplesySS11workspaceID_SS6intentSiSg9pageLimitSbSg12includeCountSSSg4sortAK6cursorAI0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA17ExampleCollectionVc7successtF":{"name":"listExamples(workspaceID:intent:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List user input examples.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13createExampleySS11workspaceID_SS6intentSS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createExample(workspaceID:intent:text:headers:failure:success:)","abstract":"

Create user input example.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C10getExampleySS11workspaceID_SS6intentSS4textSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getExample(workspaceID:intent:text:includeAudit:headers:failure:success:)","abstract":"

Get user input example.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13updateExampleySS11workspaceID_SS6intentSS4textSSSg7newTexts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateExample(workspaceID:intent:text:newText:headers:failure:success:)","abstract":"

Update user input example.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13deleteExampleySS11workspaceID_SS6intentSS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteExample(workspaceID:intent:text:headers:failure:success:)","abstract":"

Delete user input example.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C19listCounterexamplesySS11workspaceID_SiSg9pageLimitSbSg12includeCountSSSg4sortAJ6cursorAH0I5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA24CounterexampleCollectionVc7successtF":{"name":"listCounterexamples(workspaceID:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List counterexamples.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C20createCounterexampleySS11workspaceID_SS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createCounterexample(workspaceID:text:headers:failure:success:)","abstract":"

Create counterexample.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C17getCounterexampleySS11workspaceID_SS4textSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getCounterexample(workspaceID:text:includeAudit:headers:failure:success:)","abstract":"

Get counterexample.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C20updateCounterexampleySS11workspaceID_SS4textSSSg7newTexts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateCounterexample(workspaceID:text:newText:headers:failure:success:)","abstract":"

Update counterexample.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C20deleteCounterexampleySS11workspaceID_SS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteCounterexample(workspaceID:text:headers:failure:success:)","abstract":"

Delete counterexample.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12listEntitiesySS11workspaceID_SbSg6exportSiSg9pageLimitAF12includeCountSSSg4sortAK6cursorAF0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA16EntityCollectionVc7successtF":{"name":"listEntities(workspaceID:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entities.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12createEntityySS11workspaceID_AA06CreateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createEntity(workspaceID:properties:headers:failure:success:)","abstract":"

Create entity.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C9getEntityySS11workspaceID_SS6entitySbSg6exportAG12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getEntity(workspaceID:entity:export:includeAudit:headers:failure:success:)","abstract":"

Get entity.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12updateEntityySS11workspaceID_SS6entityAA06UpdateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateEntity(workspaceID:entity:properties:headers:failure:success:)","abstract":"

Update entity.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12deleteEntityySS11workspaceID_SS6entitys10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteEntity(workspaceID:entity:headers:failure:success:)","abstract":"

Delete entity.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C10listValuesySS11workspaceID_SS6entitySbSg6exportSiSg9pageLimitAG12includeCountSSSg4sortAL6cursorAG0K5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA15ValueCollectionVc7successtF":{"name":"listValues(workspaceID:entity:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entity values.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11createValueySS11workspaceID_SS6entityAA06CreateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createValue(workspaceID:entity:properties:headers:failure:success:)","abstract":"

Add entity value.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C8getValueySS11workspaceID_SS6entitySS5valueSbSg6exportAH12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getValue(workspaceID:entity:value:export:includeAudit:headers:failure:success:)","abstract":"

Get entity value.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11updateValueySS11workspaceID_SS6entitySS5valueAA06UpdateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateValue(workspaceID:entity:value:properties:headers:failure:success:)","abstract":"

Update entity value.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11deleteValueySS11workspaceID_SS6entitySS5values10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteValue(workspaceID:entity:value:headers:failure:success:)","abstract":"

Delete entity value.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12listSynonymsySS11workspaceID_SS6entitySS5valueSiSg9pageLimitSbSg12includeCountSSSg4sortAL6cursorAJ0K5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA17SynonymCollectionVc7successtF":{"name":"listSynonyms(workspaceID:entity:value:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entity value synonyms.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13createSynonymySS11workspaceID_SS6entitySS5valueSS7synonyms10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createSynonym(workspaceID:entity:value:synonym:headers:failure:success:)","abstract":"

Add entity value synonym.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C10getSynonymySS11workspaceID_SS6entitySS5valueSS7synonymSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getSynonym(workspaceID:entity:value:synonym:includeAudit:headers:failure:success:)","abstract":"

Get entity value synonym.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13updateSynonymySS11workspaceID_SS6entitySS5valueSS7synonymSSSg03newD0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateSynonym(workspaceID:entity:value:synonym:newSynonym:headers:failure:success:)","abstract":"

Update entity value synonym.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13deleteSynonymySS11workspaceID_SS6entitySS5valueSS7synonyms10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteSynonym(workspaceID:entity:value:synonym:headers:failure:success:)","abstract":"

Delete entity value synonym.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C15listDialogNodesySS11workspaceID_SiSg9pageLimitSbSg12includeCountSSSg4sortAJ6cursorAH0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D14NodeCollectionVc7successtF":{"name":"listDialogNodes(workspaceID:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List dialog nodes.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C16createDialogNodeySS11workspaceID_AA06CreatedE0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"createDialogNode(workspaceID:properties:headers:failure:success:)","abstract":"

Create dialog node.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13getDialogNodeySS11workspaceID_SS06dialogE0SbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"getDialogNode(workspaceID:dialogNode:includeAudit:headers:failure:success:)","abstract":"

Get dialog node.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C16updateDialogNodeySS11workspaceID_SS06dialogE0AA06UpdatedE0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"updateDialogNode(workspaceID:dialogNode:properties:headers:failure:success:)","abstract":"

Update dialog node.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C16deleteDialogNodeySS11workspaceID_SS06dialogE0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteDialogNode(workspaceID:dialogNode:headers:failure:success:)","abstract":"

Delete dialog node.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C8listLogsySS11workspaceID_SSSg4sortAF6filterSiSg9pageLimitAF6cursors10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA13LogCollectionVc7successtF":{"name":"listLogs(workspaceID:sort:filter:pageLimit:cursor:headers:failure:success:)","abstract":"

List log events in a workspace.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11listAllLogsySS6filter_SSSg4sortSiSg9pageLimitAF6cursors10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA13LogCollectionVc7successtF":{"name":"listAllLogs(filter:sort:pageLimit:cursor:headers:failure:success:)","abstract":"

List log events in all workspaces.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

Delete labeled data.

","parent_name":"Assistant"},"Classes/Assistant.html":{"name":"Assistant","abstract":"

The IBM Watson™ Assistant service combines machine learning, natural language understanding, and integrated"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file diff --git a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/docSet.dsidx b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/docSet.dsidx index 9b52e761a..e4cad083f 100644 Binary files a/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/docSet.dsidx and b/docs/swift-api/services/AssistantV1/docsets/.docset/Contents/Resources/docSet.dsidx differ diff --git a/docs/swift-api/services/AssistantV1/docsets/.tgz b/docs/swift-api/services/AssistantV1/docsets/.tgz index 4bc16305a..803ce0b22 100644 Binary files a/docs/swift-api/services/AssistantV1/docsets/.tgz and b/docs/swift-api/services/AssistantV1/docsets/.tgz differ diff --git a/docs/swift-api/services/AssistantV1/index.html b/docs/swift-api/services/AssistantV1/index.html index f9540bdad..46107b165 100644 --- a/docs/swift-api/services/AssistantV1/index.html +++ b/docs/swift-api/services/AssistantV1/index.html @@ -169,9 +169,6 @@ - @@ -334,7 +331,8 @@

Services

  • Assistant
  • Discovery
  • -
  • Language Translator
  • +
  • Language Translator V2
  • +
  • Language Translator V3
  • Natural Language Classifier
  • Natural Language Understanding
  • Personality Insights
  • @@ -379,7 +377,7 @@

    Swift Package Manager

    Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

    dependencies: [
    -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
    +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
     ]
     

    Service Instances

    @@ -422,7 +420,7 @@

    Username and Password

    API Key

    -

    Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

    +

    Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

    let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
     

    Using IAM

    @@ -657,7 +655,12 @@

    Private Data Collections

  • IBM Discovery - Documentation
  • IBM Discovery - Demo
-

Language Translator

+

Language Translator V2

+ +

Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

@@ -668,6 +671,25 @@

Language Translator

let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} + +

Language Translator V3

+ +

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

+ +

The following example demonstrates how to use the Language Translator service:

+
import LanguageTranslatorV3
+
+let username = "your-username-here"
+let password = "your-password-here"
+let version = "yyyy-mm-dd" // use today's date for the most recent version
+let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
+
 let failure = { (error: Error) in print(error) }
 let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
 languageTranslator.translate(request: request, failure: failure) {
@@ -1058,7 +1080,7 @@ 

Visual Recognition

let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -1066,6 +1088,10 @@

Visual Recognition

print(classifiedImages) }
+ +

Note: a different initializer is used for authentication with instances created before May 23, 2018:

+
let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
+

Using Core ML

The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

@@ -1117,7 +1143,7 @@

Bundlin diff --git a/docs/swift-api/services/AssistantV1/search.json b/docs/swift-api/services/AssistantV1/search.json index fa78cc962..021137ae6 100644 --- a/docs/swift-api/services/AssistantV1/search.json +++ b/docs/swift-api/services/AssistantV1/search.json @@ -1 +1 @@ -{"Structs/WorkspaceExport/Status.html#/s:11AssistantV115WorkspaceExportV6StatusO11nonExistentA2EmF":{"name":"nonExistent","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:11AssistantV115WorkspaceExportV6StatusO8trainingA2EmF":{"name":"training","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:11AssistantV115WorkspaceExportV6StatusO6failedA2EmF":{"name":"failed","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:11AssistantV115WorkspaceExportV6StatusO9availableA2EmF":{"name":"available","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:11AssistantV115WorkspaceExportV6StatusO11unavailableA2EmF":{"name":"unavailable","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html":{"name":"Status","abstract":"

The current status of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV4nameSSvp":{"name":"name","abstract":"

The name of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV11descriptionSSvp":{"name":"description","abstract":"

The description of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV8languageSSvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV8metadatas10DictionaryVySSAA4JSONOGvp":{"name":"metadata","abstract":"

Any metadata that is required by the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The workspace ID.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV6statusSSvp":{"name":"status","abstract":"

The current status of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV14learningOptOutSbvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV7intentsSayAA06IntentD0VGSgvp":{"name":"intents","abstract":"

An array of intents.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV8entitiesSayAA06EntityD0VGSgvp":{"name":"entities","abstract":"

An array of entities.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV15counterexamplesSayAA14CounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of counterexamples.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV11dialogNodesSayAA10DialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects describing the dialog nodes in the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceCollection.html#/s:11AssistantV119WorkspaceCollectionV10workspacesSayAA0C0VGvp":{"name":"workspaces","abstract":"

An array of objects describing the workspaces associated with the service instance.

","parent_name":"WorkspaceCollection"},"Structs/WorkspaceCollection.html#/s:11AssistantV119WorkspaceCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

An object defining the pagination data for the returned objects.

","parent_name":"WorkspaceCollection"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV4nameSSvp":{"name":"name","abstract":"

The name of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV8languageSSvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The workspace ID.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

","parent_name":"Workspace"},"Structs/ValueExport/ValueType.html#/s:11AssistantV111ValueExportV0C4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/ValueExport/ValueType.html#/s:11AssistantV111ValueExportV0C4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/ValueExport/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV9valueTextSSvp":{"name":"valueText","abstract":"

The text of the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array containing any patterns for the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV9valueTypeSSvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"ValueExport"},"Structs/ValueCollection.html#/s:11AssistantV115ValueCollectionV6valuesSayAA0C6ExportVGvp":{"name":"values","abstract":"

An array of entity values.

","parent_name":"ValueCollection"},"Structs/ValueCollection.html#/s:11AssistantV115ValueCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

An object defining the pagination data for the returned objects.

","parent_name":"ValueCollection"},"Structs/Value/ValueType.html#/s:11AssistantV15ValueV0C4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/Value/ValueType.html#/s:11AssistantV15ValueV0C4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/Value/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV9valueTextSSvp":{"name":"valueText","abstract":"

The text of the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array containing any patterns for the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV9valueTypeSSvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"Value"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV4nameSSSgvp":{"name":"name","abstract":"

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV8languageSSSgvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV7intentsSayAA12CreateIntentVGSgvp":{"name":"intents","abstract":"

An array of objects defining the intents for the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV8entitiesSayAA12CreateEntityVGSgvp":{"name":"entities","abstract":"

An array of objects defining the entities for the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV11dialogNodesSayAA16CreateDialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects defining the nodes in the workspace dialog.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV15counterexamplesSayAA20CreateCounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of objects defining input examples that have been marked as irrelevant input.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceVACSSSg4name_AD11descriptionAD8languageSayAA12CreateIntentVGSg7intentsSayAA0H6EntityVGSg8entitiesSayAA0H10DialogNodeVGSg11dialogNodesSayAA0H14CounterexampleVGSg15counterexampless10DictionaryVySSAA4JSONOGSg8metadataSbSg14learningOptOuttcfc":{"name":"init(name:description:language:intents:entities:dialogNodes:counterexamples:metadata:learningOptOut:)","abstract":"

Initialize a UpdateWorkspace with member variables.

","parent_name":"UpdateWorkspace"},"Structs/UpdateValue/ValueType.html#/s:11AssistantV111UpdateValueV0D4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/UpdateValue/ValueType.html#/s:11AssistantV111UpdateValueV0D4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/UpdateValue/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueV5valueSSSgvp":{"name":"value","abstract":"

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueV9valueTypeSSSgvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following resrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueVACSSSg5value_s10DictionaryVySSAA4JSONOGSg8metadataAD0E4TypeSaySSGSg8synonymsAO8patternstcfc":{"name":"init(value:metadata:valueType:synonyms:patterns:)","abstract":"

Initialize a UpdateValue with member variables.

","parent_name":"UpdateValue"},"Structs/UpdateSynonym.html#/s:11AssistantV113UpdateSynonymV7synonymSSSgvp":{"name":"synonym","abstract":"

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"UpdateSynonym"},"Structs/UpdateSynonym.html#/s:11AssistantV113UpdateSynonymVACSSSg7synonym_tcfc":{"name":"init(synonym:)","abstract":"

Initialize a UpdateSynonym with member variables.

","parent_name":"UpdateSynonym"},"Structs/UpdateIntent.html#/s:11AssistantV112UpdateIntentV6intentSSSgvp":{"name":"intent","abstract":"

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:11AssistantV112UpdateIntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:11AssistantV112UpdateIntentV8examplesSayAA13CreateExampleVGSgvp":{"name":"examples","abstract":"

An array of user input examples for the intent.

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:11AssistantV112UpdateIntentVACSSSg6intent_AD11descriptionSayAA13CreateExampleVGSg8examplestcfc":{"name":"init(intent:description:examples:)","abstract":"

Initialize a UpdateIntent with member variables.

","parent_name":"UpdateIntent"},"Structs/UpdateExample.html#/s:11AssistantV113UpdateExampleV4textSSSgvp":{"name":"text","abstract":"

The text of the user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

","parent_name":"UpdateExample"},"Structs/UpdateExample.html#/s:11AssistantV113UpdateExampleVACSSSg4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a UpdateExample with member variables.

","parent_name":"UpdateExample"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityV6entitySSSgvp":{"name":"entity","abstract":"

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether to use fuzzy matching for the entity.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityV6valuesSayAA11CreateValueVGSgvp":{"name":"values","abstract":"

An array of entity values.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityVACSSSg6entity_AD11descriptions10DictionaryVySSAA4JSONOGSg8metadataSbSg10fuzzyMatchSayAA11CreateValueVGSg6valuestcfc":{"name":"init(entity:description:metadata:fuzzyMatch:values:)","abstract":"

Initialize a UpdateEntity with member variables.

","parent_name":"UpdateEntity"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:11AssistantV116UpdateDialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:11AssistantV116UpdateDialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:11AssistantV116UpdateDialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOut.html#/s:11AssistantV116UpdateDialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressOut.html#/s:11AssistantV116UpdateDialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressOut.html#/s:11AssistantV116UpdateDialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressIn.html#/s:11AssistantV116UpdateDialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/DigressIn.html#/s:11AssistantV116UpdateDialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/DigressIn.html#/s:11AssistantV116UpdateDialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV06dialogE0SSSgvp":{"name":"dialogNode","abstract":"

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous sibling dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context for the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

The metadata for the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV8nextStepAA0de4NextG0VSgvp":{"name":"nextStep","abstract":"

The next step to be executed in dialog processing.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV7actionsSayAA0dE6ActionVGSgvp":{"name":"actions","abstract":"

An array of objects describing any actions to be invoked by the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeVACSSSg06dialogE0_AD11descriptionAD10conditionsAD6parentAD15previousSiblings10DictionaryVySSAA4JSONOGSg6outputAO7contextAO8metadataAA0dE8NextStepVSg04nextR0AD5titleAD8nodeTypeAD9eventNameAD8variableSayAA0dE6ActionVGSg7actionsAD9digressInAD10digressOutAD15digressOutSlotstcfc":{"name":"init(dialogNode:description:conditions:parent:previousSibling:output:context:metadata:nextStep:title:nodeType:eventName:variable:actions:digressIn:digressOut:digressOutSlots:)","abstract":"

Initialize a UpdateDialogNode with member variables.

","parent_name":"UpdateDialogNode"},"Structs/UpdateCounterexample.html#/s:11AssistantV120UpdateCounterexampleV4textSSSgvp":{"name":"text","abstract":"

The text of a user input counterexample.

","parent_name":"UpdateCounterexample"},"Structs/UpdateCounterexample.html#/s:11AssistantV120UpdateCounterexampleVACSSSg4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a UpdateCounterexample with member variables.

","parent_name":"UpdateCounterexample"},"Structs/SystemResponse.html#/s:11AssistantV114SystemResponseV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:11AssistantV114SystemResponseVACs10DictionaryVySSAA4JSONOG20additionalProperties_tcfc":{"name":"init(additionalProperties:)","abstract":"

Initialize a SystemResponse.

","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"SystemResponse"},"Structs/SynonymCollection.html#/s:11AssistantV117SynonymCollectionV8synonymsSayAA0C0VGvp":{"name":"synonyms","abstract":"

An array of synonyms.

","parent_name":"SynonymCollection"},"Structs/SynonymCollection.html#/s:11AssistantV117SynonymCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"SynonymCollection"},"Structs/Synonym.html#/s:11AssistantV17SynonymV11synonymTextSSvp":{"name":"synonymText","abstract":"

The text of the synonym.

","parent_name":"Synonym"},"Structs/Synonym.html#/s:11AssistantV17SynonymV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the synonym.

","parent_name":"Synonym"},"Structs/Synonym.html#/s:11AssistantV17SynonymV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the most recent update to the synonym.

","parent_name":"Synonym"},"Structs/RuntimeIntent.html#/s:11AssistantV113RuntimeIntentV6intentSSvp":{"name":"intent","abstract":"

The name of the recognized intent.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:11AssistantV113RuntimeIntentV10confidenceSdvp":{"name":"confidence","abstract":"

A decimal percentage that represents Watson’s confidence in the intent.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:11AssistantV113RuntimeIntentV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:11AssistantV113RuntimeIntentVACSS6intent_Sd10confidences10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(intent:confidence:additionalProperties:)","abstract":"

Initialize a RuntimeIntent with member variables.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"RuntimeIntent"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV6entitySSvp":{"name":"entity","abstract":"

An entity detected in the input.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV8locationSaySiGvp":{"name":"location","abstract":"

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV5valueSSvp":{"name":"value","abstract":"

The term in the input text that was recognized as an entity value.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV10confidenceSdSgvp":{"name":"confidence","abstract":"

A decimal percentage that represents Watson’s confidence in the entity.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata for the entity.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV6groupsSayAA12CaptureGroupVGSgvp":{"name":"groups","abstract":"

The recognized capture groups for the entity, as defined by the entity pattern.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityVACSS6entity_SaySiG8locationSS5valueSdSg10confidences10DictionaryVySSAA4JSONOGSg8metadataSayAA12CaptureGroupVGSg6groupsAN20additionalPropertiestcfc":{"name":"init(entity:location:value:confidence:metadata:groups:additionalProperties:)","abstract":"

Initialize a RuntimeEntity with member variables.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"RuntimeEntity"},"Structs/Pagination.html#/s:11AssistantV110PaginationV10refreshUrlSSvp":{"name":"refreshUrl","abstract":"

The URL that will return the same page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:11AssistantV110PaginationV7nextUrlSSSgvp":{"name":"nextUrl","abstract":"

The URL that will return the next page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:11AssistantV110PaginationV5totalSiSgvp":{"name":"total","abstract":"

Reserved for future use.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:11AssistantV110PaginationV7matchedSiSgvp":{"name":"matched","abstract":"

Reserved for future use.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:11AssistantV110PaginationV13refreshCursorSSSgvp":{"name":"refreshCursor","abstract":"

A token identifying the current page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:11AssistantV110PaginationV10nextCursorSSSgvp":{"name":"nextCursor","abstract":"

A token identifying the next page of results.

","parent_name":"Pagination"},"Structs/OutputData.html#/s:11AssistantV110OutputDataV11logMessagesSayAA10LogMessageVGvp":{"name":"logMessages","abstract":"

An array of up to 50 messages logged with the request.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:11AssistantV110OutputDataV4textSaySSGvp":{"name":"text","abstract":"

An array of responses to the user.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:11AssistantV110OutputDataV12nodesVisitedSaySSGSgvp":{"name":"nodesVisited","abstract":"

An array of the nodes that were triggered to create the response, in the order in which they were visited. This information is useful for debugging and for tracing the path taken through the node tree.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:11AssistantV110OutputDataV19nodesVisitedDetailsSayAA010DialogNodefG0VGSgvp":{"name":"nodesVisitedDetails","abstract":"

An array of objects containing detailed diagnostic information about the nodes that were triggered during processing of the input message. Included only if nodes_visited_details is set to true in the message request.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:11AssistantV110OutputDataV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:11AssistantV110OutputDataVACSayAA10LogMessageVG11logMessages_SaySSG4textAHSg12nodesVisitedSayAA010DialogNodeK7DetailsVGSg0jkN0s10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(logMessages:text:nodesVisited:nodesVisitedDetails:additionalProperties:)","abstract":"

Initialize a OutputData with member variables.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"OutputData"},"Structs/OutputData.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"OutputData"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV5inputAA0C5InputVSgvp":{"name":"input","abstract":"

The user input from the request.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV7intentsSayAA13RuntimeIntentVGvp":{"name":"intents","abstract":"

An array of intents recognized in the user input, sorted in descending order of confidence.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV8entitiesSayAA13RuntimeEntityVGvp":{"name":"entities","abstract":"

An array of entities identified in the user input.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV16alternateIntentsSbSgvp":{"name":"alternateIntents","abstract":"

Whether to return more than one intent. A value of true indicates that all matching intents are returned.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV7contextAA7ContextVvp":{"name":"context","abstract":"

State information for the conversation.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV6outputAA10OutputDataVvp":{"name":"output","abstract":"

Output from the dialog, including the response to the user, the nodes that were triggered, and log messages.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"MessageResponse"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV5inputAA9InputDataVSgvp":{"name":"input","abstract":"

An input object that includes the input text.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV16alternateIntentsSbSgvp":{"name":"alternateIntents","abstract":"

Whether to return more than one intent. Set to true to return all matching intents.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV7contextAA7ContextVSgvp":{"name":"context","abstract":"

State information for the conversation. Continue a conversation by including the context object from the previous response.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV8entitiesSayAA13RuntimeEntityVGSgvp":{"name":"entities","abstract":"

Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV7intentsSayAA13RuntimeIntentVGSgvp":{"name":"intents","abstract":"

Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV6outputAA10OutputDataVSgvp":{"name":"output","abstract":"

System output. Include the output from the previous response to maintain intermediate information over multiple requests.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestVAcA9InputDataVSg5input_SbSg16alternateIntentsAA7ContextVSg7contextSayAA13RuntimeEntityVGSg8entitiesSayAA0L6IntentVGSg7intentsAA06OutputF0VSg6outputtcfc":{"name":"init(input:alternateIntents:context:entities:intents:output:)","abstract":"

Initialize a MessageRequest with member variables.

","parent_name":"MessageRequest"},"Structs/MessageInput.html#/s:11AssistantV112MessageInputV4textSSSgvp":{"name":"text","abstract":"

The user’s input.

","parent_name":"MessageInput"},"Structs/LogPagination.html#/s:11AssistantV113LogPaginationV7nextUrlSSSgvp":{"name":"nextUrl","abstract":"

The URL that will return the next page of results, if any.

","parent_name":"LogPagination"},"Structs/LogPagination.html#/s:11AssistantV113LogPaginationV7matchedSiSgvp":{"name":"matched","abstract":"

Reserved for future use.

","parent_name":"LogPagination"},"Structs/LogPagination.html#/s:11AssistantV113LogPaginationV10nextCursorSSSgvp":{"name":"nextCursor","abstract":"

A token identifying the next page of results.

","parent_name":"LogPagination"},"Structs/LogMessage/Level.html#/s:11AssistantV110LogMessageV5LevelO4infoA2EmF":{"name":"info","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html#/s:11AssistantV110LogMessageV5LevelO5errorA2EmF":{"name":"error","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html#/s:11AssistantV110LogMessageV5LevelO4warnA2EmF":{"name":"warn","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html":{"name":"Level","abstract":"

The severity of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:11AssistantV110LogMessageV5levelSSvp":{"name":"level","abstract":"

The severity of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:11AssistantV110LogMessageV3msgSSvp":{"name":"msg","abstract":"

The text of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:11AssistantV110LogMessageV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:11AssistantV110LogMessageVACSS5level_SS3msgs10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(level:msg:additionalProperties:)","abstract":"

Initialize a LogMessage with member variables.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"LogMessage"},"Structs/LogExport.html#/s:11AssistantV19LogExportV7requestAA14MessageRequestVvp":{"name":"request","abstract":"

A request received by the workspace, including the user input and context.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV8responseAA15MessageResponseVvp":{"name":"response","abstract":"

The response sent by the workspace, including the output text, detected intents and entities, and context.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV5logIDSSvp":{"name":"logID","abstract":"

A unique identifier for the logged event.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV16requestTimestampSSvp":{"name":"requestTimestamp","abstract":"

The timestamp for receipt of the message.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV17responseTimestampSSvp":{"name":"responseTimestamp","abstract":"

The timestamp for the system response to the message.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The unique identifier of the workspace where the request was made.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV8languageSSvp":{"name":"language","abstract":"

The language of the workspace where the message request was made.

","parent_name":"LogExport"},"Structs/LogCollection.html#/s:11AssistantV113LogCollectionV4logsSayAA0C6ExportVGvp":{"name":"logs","abstract":"

An array of objects describing log events.

","parent_name":"LogCollection"},"Structs/LogCollection.html#/s:11AssistantV113LogCollectionV10paginationAA0C10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"LogCollection"},"Structs/IntentExport.html#/s:11AssistantV112IntentExportV10intentNameSSvp":{"name":"intentName","abstract":"

The name of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:11AssistantV112IntentExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:11AssistantV112IntentExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:11AssistantV112IntentExportV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:11AssistantV112IntentExportV8examplesSayAA7ExampleVGSgvp":{"name":"examples","abstract":"

An array of objects describing the user input examples for the intent.

","parent_name":"IntentExport"},"Structs/IntentCollection.html#/s:11AssistantV116IntentCollectionV7intentsSayAA0C6ExportVGvp":{"name":"intents","abstract":"

An array of objects describing the intents defined for the workspace.

","parent_name":"IntentCollection"},"Structs/IntentCollection.html#/s:11AssistantV116IntentCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"IntentCollection"},"Structs/Intent.html#/s:11AssistantV16IntentV10intentNameSSvp":{"name":"intentName","abstract":"

The name of the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:11AssistantV16IntentV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:11AssistantV16IntentV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:11AssistantV16IntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"Intent"},"Structs/InputData.html#/s:11AssistantV19InputDataV4textSSvp":{"name":"text","abstract":"

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

","parent_name":"InputData"},"Structs/InputData.html#/s:11AssistantV19InputDataVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a InputData with member variables.

","parent_name":"InputData"},"Structs/ExampleCollection.html#/s:11AssistantV117ExampleCollectionV8examplesSayAA0C0VGvp":{"name":"examples","abstract":"

An array of objects describing the examples defined for the intent.

","parent_name":"ExampleCollection"},"Structs/ExampleCollection.html#/s:11AssistantV117ExampleCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"ExampleCollection"},"Structs/Example.html#/s:11AssistantV17ExampleV11exampleTextSSvp":{"name":"exampleText","abstract":"

The text of the user input example.

","parent_name":"Example"},"Structs/Example.html#/s:11AssistantV17ExampleV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the example.

","parent_name":"Example"},"Structs/Example.html#/s:11AssistantV17ExampleV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the example.

","parent_name":"Example"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV10entityNameSSvp":{"name":"entityName","abstract":"

The name of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether fuzzy matching is used for the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV6valuesSayAA05ValueD0VGSgvp":{"name":"values","abstract":"

An array objects describing the entity values.

","parent_name":"EntityExport"},"Structs/EntityCollection.html#/s:11AssistantV116EntityCollectionV8entitiesSayAA0C6ExportVGvp":{"name":"entities","abstract":"

An array of objects describing the entities defined for the workspace.

","parent_name":"EntityCollection"},"Structs/EntityCollection.html#/s:11AssistantV116EntityCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"EntityCollection"},"Structs/Entity.html#/s:11AssistantV16EntityV10entityNameSSvp":{"name":"entityName","abstract":"

The name of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:11AssistantV16EntityV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:11AssistantV16EntityV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:11AssistantV16EntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:11AssistantV16EntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:11AssistantV16EntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether fuzzy matching is used for the entity.

","parent_name":"Entity"},"Structs/DialogNodeVisitedDetails.html#/s:11AssistantV124DialogNodeVisitedDetailsV06dialogD0SSSgvp":{"name":"dialogNode","abstract":"

A dialog node that was triggered during processing of the input message.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:11AssistantV124DialogNodeVisitedDetailsV5titleSSSgvp":{"name":"title","abstract":"

The title of the dialog node.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:11AssistantV124DialogNodeVisitedDetailsV10conditionsSSSgvp":{"name":"conditions","abstract":"

The conditions that trigger the dialog node.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:11AssistantV124DialogNodeVisitedDetailsVACSSSg06dialogD0_AD5titleAD10conditionstcfc":{"name":"init(dialogNode:title:conditions:)","abstract":"

Initialize a DialogNodeVisitedDetails with member variables.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeNextStep/Selector.html#/s:11AssistantV118DialogNodeNextStepV8SelectorO9conditionA2EmF":{"name":"condition","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:11AssistantV118DialogNodeNextStepV8SelectorO6clientA2EmF":{"name":"client","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:11AssistantV118DialogNodeNextStepV8SelectorO9userInputA2EmF":{"name":"userInput","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:11AssistantV118DialogNodeNextStepV8SelectorO4bodyA2EmF":{"name":"body","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO12getUserInputA2EmF":{"name":"getUserInput","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO13skipUserInputA2EmF":{"name":"skipUserInput","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO6jumpToA2EmF":{"name":"jumpTo","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO8repromptA2EmF":{"name":"reprompt","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO8skipSlotA2EmF":{"name":"skipSlot","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO12skipAllSlotsA2EmF":{"name":"skipAllSlots","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html":{"name":"Behavior","abstract":"

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep/Selector.html":{"name":"Selector","abstract":"

Which part of the dialog node to process next.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:11AssistantV118DialogNodeNextStepV8behaviorSSvp":{"name":"behavior","abstract":"

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:11AssistantV118DialogNodeNextStepV06dialogD0SSSgvp":{"name":"dialogNode","abstract":"

The ID of the dialog node to process next. This parameter is required if behavior=jump_to.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:11AssistantV118DialogNodeNextStepV8selectorSSSgvp":{"name":"selector","abstract":"

Which part of the dialog node to process next.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:11AssistantV118DialogNodeNextStepVACSS8behavior_SSSg06dialogD0AE8selectortcfc":{"name":"init(behavior:dialogNode:selector:)","abstract":"

Initialize a DialogNodeNextStep with member variables.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeCollection.html#/s:11AssistantV120DialogNodeCollectionV11dialogNodesSayAA0cD0VGvp":{"name":"dialogNodes","abstract":"

An array of objects describing the dialog nodes defined for the workspace.

","parent_name":"DialogNodeCollection"},"Structs/DialogNodeCollection.html#/s:11AssistantV120DialogNodeCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"DialogNodeCollection"},"Structs/DialogNodeAction/ActionType.html#/s:11AssistantV116DialogNodeActionV0E4TypeO6clientA2EmF":{"name":"client","abstract":"

Undocumented

","parent_name":"ActionType"},"Structs/DialogNodeAction/ActionType.html#/s:11AssistantV116DialogNodeActionV0E4TypeO6serverA2EmF":{"name":"server","abstract":"

Undocumented

","parent_name":"ActionType"},"Structs/DialogNodeAction/ActionType.html":{"name":"ActionType","abstract":"

The type of action to invoke.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionV4nameSSvp":{"name":"name","abstract":"

The name of the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionV10actionTypeSSSgvp":{"name":"actionType","abstract":"

The type of action to invoke.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionV10parameterss10DictionaryVySSAA4JSONOGSgvp":{"name":"parameters","abstract":"

A map of key/value pairs to be provided to the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionV14resultVariableSSvp":{"name":"resultVariable","abstract":"

The location in the dialog context where the result of the action is stored.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionV11credentialsSSSgvp":{"name":"credentials","abstract":"

The name of the context variable that the client application will use to pass in credentials for the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionVACSS4name_SS14resultVariableSSSg10actionTypes10DictionaryVySSAA4JSONOGSg10parametersAF11credentialstcfc":{"name":"init(name:resultVariable:actionType:parameters:credentials:)","abstract":"

Initialize a DialogNodeAction with member variables.

","parent_name":"DialogNodeAction"},"Structs/DialogNode/DigressOutSlots.html#/s:11AssistantV110DialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOutSlots.html#/s:11AssistantV110DialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOutSlots.html#/s:11AssistantV110DialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOut.html#/s:11AssistantV110DialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressOut.html#/s:11AssistantV110DialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressOut.html#/s:11AssistantV110DialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressIn.html#/s:11AssistantV110DialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/DigressIn.html#/s:11AssistantV110DialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/DigressIn.html#/s:11AssistantV110DialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV06dialogD2IDSSvp":{"name":"dialogNodeID","abstract":"

The dialog node ID.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that triggers the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node. This property is not returned if the dialog node has no parent.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous sibling dialog node. This property is not returned if the dialog node has no previous sibling.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context (if defined) for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV8nextStepAA0cd4NextF0VSgvp":{"name":"nextStep","abstract":"

The next step to execute following this dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the most recent update to the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV7actionsSayAA0cD6ActionVGSgvp":{"name":"actions","abstract":"

The actions for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"DialogNode"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV4nameSSSgvp":{"name":"name","abstract":"

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV8languageSSSgvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV7intentsSayAA0C6IntentVGSgvp":{"name":"intents","abstract":"

An array of objects defining the intents for the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV8entitiesSayAA0C6EntityVGSgvp":{"name":"entities","abstract":"

An array of objects defining the entities for the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV11dialogNodesSayAA0C10DialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects defining the nodes in the workspace dialog.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV15counterexamplesSayAA0C14CounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of objects defining input examples that have been marked as irrelevant input.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceVACSSSg4name_AD11descriptionAD8languageSayAA0C6IntentVGSg7intentsSayAA0C6EntityVGSg8entitiesSayAA0C10DialogNodeVGSg11dialogNodesSayAA0C14CounterexampleVGSg15counterexampless10DictionaryVySSAA4JSONOGSg8metadataSbSg14learningOptOuttcfc":{"name":"init(name:description:language:intents:entities:dialogNodes:counterexamples:metadata:learningOptOut:)","abstract":"

Initialize a CreateWorkspace with member variables.

","parent_name":"CreateWorkspace"},"Structs/CreateValue/ValueType.html#/s:11AssistantV111CreateValueV0D4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/CreateValue/ValueType.html#/s:11AssistantV111CreateValueV0D4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/CreateValue/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueV5valueSSvp":{"name":"value","abstract":"

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueV9valueTypeSSSgvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueVACSS5value_s10DictionaryVySSAA4JSONOGSg8metadataSaySSGSg8synonymsAM8patternsSSSg0E4Typetcfc":{"name":"init(value:metadata:synonyms:patterns:valueType:)","abstract":"

Initialize a CreateValue with member variables.

","parent_name":"CreateValue"},"Structs/CreateSynonym.html#/s:11AssistantV113CreateSynonymV7synonymSSvp":{"name":"synonym","abstract":"

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"CreateSynonym"},"Structs/CreateSynonym.html#/s:11AssistantV113CreateSynonymVACSS7synonym_tcfc":{"name":"init(synonym:)","abstract":"

Initialize a CreateSynonym with member variables.

","parent_name":"CreateSynonym"},"Structs/CreateIntent.html#/s:11AssistantV112CreateIntentV6intentSSvp":{"name":"intent","abstract":"

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:11AssistantV112CreateIntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:11AssistantV112CreateIntentV8examplesSayAA0C7ExampleVGSgvp":{"name":"examples","abstract":"

An array of user input examples for the intent.

","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:11AssistantV112CreateIntentVACSS6intent_SSSg11descriptionSayAA0C7ExampleVGSg8examplestcfc":{"name":"init(intent:description:examples:)","abstract":"

Initialize a CreateIntent with member variables.

","parent_name":"CreateIntent"},"Structs/CreateExample.html#/s:11AssistantV113CreateExampleV4textSSvp":{"name":"text","abstract":"

The text of a user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

","parent_name":"CreateExample"},"Structs/CreateExample.html#/s:11AssistantV113CreateExampleVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a CreateExample with member variables.

","parent_name":"CreateExample"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityV6entitySSvp":{"name":"entity","abstract":"

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the value.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityV6valuesSayAA0C5ValueVGSgvp":{"name":"values","abstract":"

An array of objects describing the entity values.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether to use fuzzy matching for the entity.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityVACSS6entity_SSSg11descriptions10DictionaryVySSAA4JSONOGSg8metadataSayAA0C5ValueVGSg6valuesSbSg10fuzzyMatchtcfc":{"name":"init(entity:description:metadata:values:fuzzyMatch:)","abstract":"

Initialize a CreateEntity with member variables.

","parent_name":"CreateEntity"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:11AssistantV116CreateDialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:11AssistantV116CreateDialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:11AssistantV116CreateDialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOut.html#/s:11AssistantV116CreateDialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressOut.html#/s:11AssistantV116CreateDialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressOut.html#/s:11AssistantV116CreateDialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressIn.html#/s:11AssistantV116CreateDialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/DigressIn.html#/s:11AssistantV116CreateDialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/DigressIn.html#/s:11AssistantV116CreateDialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV06dialogE0SSvp":{"name":"dialogNode","abstract":"

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context for the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

The metadata for the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV8nextStepAA0de4NextG0VSgvp":{"name":"nextStep","abstract":"

The next step to be executed in dialog processing.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV7actionsSayAA0dE6ActionVGSgvp":{"name":"actions","abstract":"

An array of objects describing any actions to be invoked by the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeVACSS06dialogE0_SSSg11descriptionAE10conditionsAE6parentAE15previousSiblings10DictionaryVySSAA4JSONOGSg6outputAO7contextAO8metadataAA0dE8NextStepVSg04nextR0SayAA0dE6ActionVGSg7actionsAE5titleAE8nodeTypeAE9eventNameAE8variableAE9digressInAE10digressOutAE15digressOutSlotstcfc":{"name":"init(dialogNode:description:conditions:parent:previousSibling:output:context:metadata:nextStep:actions:title:nodeType:eventName:variable:digressIn:digressOut:digressOutSlots:)","abstract":"

Initialize a CreateDialogNode with member variables.

","parent_name":"CreateDialogNode"},"Structs/CreateCounterexample.html#/s:11AssistantV120CreateCounterexampleV4textSSvp":{"name":"text","abstract":"

The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It must be no longer than 1024 characters.

","parent_name":"CreateCounterexample"},"Structs/CreateCounterexample.html#/s:11AssistantV120CreateCounterexampleVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a CreateCounterexample with member variables.

","parent_name":"CreateCounterexample"},"Structs/CounterexampleCollection.html#/s:11AssistantV124CounterexampleCollectionV15counterexamplesSayAA0C0VGvp":{"name":"counterexamples","abstract":"

An array of objects describing the examples marked as irrelevant input.

","parent_name":"CounterexampleCollection"},"Structs/CounterexampleCollection.html#/s:11AssistantV124CounterexampleCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"CounterexampleCollection"},"Structs/Counterexample.html#/s:11AssistantV114CounterexampleV4textSSvp":{"name":"text","abstract":"

The text of the counterexample.

","parent_name":"Counterexample"},"Structs/Counterexample.html#/s:11AssistantV114CounterexampleV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the counterexample.

","parent_name":"Counterexample"},"Structs/Counterexample.html#/s:11AssistantV114CounterexampleV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the counterexample.

","parent_name":"Counterexample"},"Structs/Context.html#/s:11AssistantV17ContextV14conversationIDSSSgvp":{"name":"conversationID","abstract":"

The unique identifier of the conversation.

","parent_name":"Context"},"Structs/Context.html#/s:11AssistantV17ContextV6systemAA14SystemResponseVSgvp":{"name":"system","abstract":"

For internal use only.

","parent_name":"Context"},"Structs/Context.html#/s:11AssistantV17ContextV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"Context"},"Structs/Context.html#/s:11AssistantV17ContextVACSSSg14conversationID_AA14SystemResponseVSg6systems10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(conversationID:system:additionalProperties:)","abstract":"

Initialize a Context with member variables.

","parent_name":"Context"},"Structs/Context.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"Context"},"Structs/Context.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"Context"},"Structs/CaptureGroup.html#/s:11AssistantV112CaptureGroupV5groupSSvp":{"name":"group","abstract":"

A recognized capture group for the entity.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html#/s:11AssistantV112CaptureGroupV8locationSaySiGSgvp":{"name":"location","abstract":"

Zero-based character offsets that indicate where the entity value begins and ends in the input text.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html#/s:11AssistantV112CaptureGroupVACSS5group_SaySiGSg8locationtcfc":{"name":"init(group:location:)","abstract":"

Initialize a CaptureGroup with member variables.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html":{"name":"CaptureGroup","abstract":"

CaptureGroup.

"},"Structs/Context.html":{"name":"Context","abstract":"

State information for the conversation. To maintain state, include the context from the previous response.

"},"Structs/Counterexample.html":{"name":"Counterexample","abstract":"

Counterexample.

"},"Structs/CounterexampleCollection.html":{"name":"CounterexampleCollection","abstract":"

CounterexampleCollection.

"},"Structs/CreateCounterexample.html":{"name":"CreateCounterexample","abstract":"

CreateCounterexample.

"},"Structs/CreateDialogNode.html":{"name":"CreateDialogNode","abstract":"

CreateDialogNode.

"},"Structs/CreateEntity.html":{"name":"CreateEntity","abstract":"

CreateEntity.

"},"Structs/CreateExample.html":{"name":"CreateExample","abstract":"

CreateExample.

"},"Structs/CreateIntent.html":{"name":"CreateIntent","abstract":"

CreateIntent.

"},"Structs/CreateSynonym.html":{"name":"CreateSynonym","abstract":"

CreateSynonym.

"},"Structs/CreateValue.html":{"name":"CreateValue","abstract":"

CreateValue.

"},"Structs/CreateWorkspace.html":{"name":"CreateWorkspace","abstract":"

CreateWorkspace.

"},"Structs/DialogNode.html":{"name":"DialogNode","abstract":"

DialogNode.

"},"Structs/DialogNodeAction.html":{"name":"DialogNodeAction","abstract":"

DialogNodeAction.

"},"Structs/DialogNodeCollection.html":{"name":"DialogNodeCollection","abstract":"

An array of dialog nodes.

"},"Structs/DialogNodeNextStep.html":{"name":"DialogNodeNextStep","abstract":"

The next step to execute following this dialog node.

"},"Structs/DialogNodeVisitedDetails.html":{"name":"DialogNodeVisitedDetails","abstract":"

DialogNodeVisitedDetails.

"},"Structs/Entity.html":{"name":"Entity","abstract":"

Entity.

"},"Structs/EntityCollection.html":{"name":"EntityCollection","abstract":"

An array of entities.

"},"Structs/EntityExport.html":{"name":"EntityExport","abstract":"

EntityExport.

"},"Structs/Example.html":{"name":"Example","abstract":"

Example.

"},"Structs/ExampleCollection.html":{"name":"ExampleCollection","abstract":"

ExampleCollection.

"},"Structs/InputData.html":{"name":"InputData","abstract":"

The user input.

"},"Structs/Intent.html":{"name":"Intent","abstract":"

Intent.

"},"Structs/IntentCollection.html":{"name":"IntentCollection","abstract":"

IntentCollection.

"},"Structs/IntentExport.html":{"name":"IntentExport","abstract":"

IntentExport.

"},"Structs/LogCollection.html":{"name":"LogCollection","abstract":"

LogCollection.

"},"Structs/LogExport.html":{"name":"LogExport","abstract":"

LogExport.

"},"Structs/LogMessage.html":{"name":"LogMessage","abstract":"

Log message details.

"},"Structs/LogPagination.html":{"name":"LogPagination","abstract":"

The pagination data for the returned objects.

"},"Structs/MessageInput.html":{"name":"MessageInput","abstract":"

The text of the user input.

"},"Structs/MessageRequest.html":{"name":"MessageRequest","abstract":"

A request formatted for the Watson Assistant service.

"},"Structs/MessageResponse.html":{"name":"MessageResponse","abstract":"

A response from the Watson Assistant service.

"},"Structs/OutputData.html":{"name":"OutputData","abstract":"

An output object that includes the response to the user, the nodes that were hit, and messages from the log.

"},"Structs/Pagination.html":{"name":"Pagination","abstract":"

The pagination data for the returned objects.

"},"Structs/RuntimeEntity.html":{"name":"RuntimeEntity","abstract":"

A term from the request that was identified as an entity.

"},"Structs/RuntimeIntent.html":{"name":"RuntimeIntent","abstract":"

An intent identified in the user input.

"},"Structs/Synonym.html":{"name":"Synonym","abstract":"

Synonym.

"},"Structs/SynonymCollection.html":{"name":"SynonymCollection","abstract":"

SynonymCollection.

"},"Structs/SystemResponse.html":{"name":"SystemResponse","abstract":"

For internal use only.

"},"Structs/UpdateCounterexample.html":{"name":"UpdateCounterexample","abstract":"

UpdateCounterexample.

"},"Structs/UpdateDialogNode.html":{"name":"UpdateDialogNode","abstract":"

UpdateDialogNode.

"},"Structs/UpdateEntity.html":{"name":"UpdateEntity","abstract":"

UpdateEntity.

"},"Structs/UpdateExample.html":{"name":"UpdateExample","abstract":"

UpdateExample.

"},"Structs/UpdateIntent.html":{"name":"UpdateIntent","abstract":"

UpdateIntent.

"},"Structs/UpdateSynonym.html":{"name":"UpdateSynonym","abstract":"

UpdateSynonym.

"},"Structs/UpdateValue.html":{"name":"UpdateValue","abstract":"

UpdateValue.

"},"Structs/UpdateWorkspace.html":{"name":"UpdateWorkspace","abstract":"

UpdateWorkspace.

"},"Structs/Value.html":{"name":"Value","abstract":"

Value.

"},"Structs/ValueCollection.html":{"name":"ValueCollection","abstract":"

ValueCollection.

"},"Structs/ValueExport.html":{"name":"ValueExport","abstract":"

ValueExport.

"},"Structs/Workspace.html":{"name":"Workspace","abstract":"

Workspace.

"},"Structs/WorkspaceCollection.html":{"name":"WorkspaceCollection","abstract":"

WorkspaceCollection.

"},"Structs/WorkspaceExport.html":{"name":"WorkspaceExport","abstract":"

WorkspaceExport.

"},"Structs.html#/s:11AssistantV111JSONWrapperV":{"name":"JSONWrapper","abstract":"

Used internally to serialize and deserialize JSON."},"Enums/RestError.html#/s:11AssistantV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO013serializationD0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO08encodingD0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO011fileManagerD0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:11AssistantV14JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/Assistant.html#/s:11AssistantV10A0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

Create a Assistant object.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a Assistant object.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a Assistant object.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C7messageySS11workspaceID_AA14MessageRequestVSg7requestSbSg19nodesVisitedDetailss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F8ResponseVc7successtF":{"name":"message(workspaceID:request:nodesVisitedDetails:headers:failure:success:)","abstract":"

Get response to user input.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C14listWorkspacesySiSg9pageLimit_SbSg12includeCountSSSg4sortAI6cursorAG0G5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA19WorkspaceCollectionVc7successtF":{"name":"listWorkspaces(pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List workspaces.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C15createWorkspaceyAA06CreateD0VSg10properties_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createWorkspace(properties:headers:failure:success:)","abstract":"

Create workspace.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12getWorkspaceySS11workspaceID_SbSg6exportAF12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getWorkspace(workspaceID:export:includeAudit:headers:failure:success:)","abstract":"

Get information about a workspace.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C15updateWorkspaceySS11workspaceID_AA06UpdateD0VSg10propertiesSbSg6appends10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateWorkspace(workspaceID:properties:append:headers:failure:success:)","abstract":"

Update workspace.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C15deleteWorkspaceySS11workspaceID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteWorkspace(workspaceID:headers:failure:success:)","abstract":"

Delete workspace.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11listIntentsySS11workspaceID_SbSg6exportSiSg9pageLimitAF12includeCountSSSg4sortAK6cursorAF0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA16IntentCollectionVc7successtF":{"name":"listIntents(workspaceID:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List intents.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12createIntentySS11workspaceID_SS6intentSSSg11descriptionSayAA13CreateExampleVGSg8exampless10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createIntent(workspaceID:intent:description:examples:headers:failure:success:)","abstract":"

Create intent.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C9getIntentySS11workspaceID_SS6intentSbSg6exportAG12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getIntent(workspaceID:intent:export:includeAudit:headers:failure:success:)","abstract":"

Get intent.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12updateIntentySS11workspaceID_SS6intentSSSg03newD0AG0H11DescriptionSayAA13CreateExampleVGSg0H8Exampless10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateIntent(workspaceID:intent:newIntent:newDescription:newExamples:headers:failure:success:)","abstract":"

Update intent.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12deleteIntentySS11workspaceID_SS6intents10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteIntent(workspaceID:intent:headers:failure:success:)","abstract":"

Delete intent.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12listExamplesySS11workspaceID_SS6intentSiSg9pageLimitSbSg12includeCountSSSg4sortAK6cursorAI0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA17ExampleCollectionVc7successtF":{"name":"listExamples(workspaceID:intent:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List user input examples.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13createExampleySS11workspaceID_SS6intentSS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createExample(workspaceID:intent:text:headers:failure:success:)","abstract":"

Create user input example.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C10getExampleySS11workspaceID_SS6intentSS4textSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getExample(workspaceID:intent:text:includeAudit:headers:failure:success:)","abstract":"

Get user input example.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13updateExampleySS11workspaceID_SS6intentSS4textSSSg7newTexts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateExample(workspaceID:intent:text:newText:headers:failure:success:)","abstract":"

Update user input example.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13deleteExampleySS11workspaceID_SS6intentSS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteExample(workspaceID:intent:text:headers:failure:success:)","abstract":"

Delete user input example.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C19listCounterexamplesySS11workspaceID_SiSg9pageLimitSbSg12includeCountSSSg4sortAJ6cursorAH0I5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA24CounterexampleCollectionVc7successtF":{"name":"listCounterexamples(workspaceID:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List counterexamples.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C20createCounterexampleySS11workspaceID_SS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createCounterexample(workspaceID:text:headers:failure:success:)","abstract":"

Create counterexample.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C17getCounterexampleySS11workspaceID_SS4textSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getCounterexample(workspaceID:text:includeAudit:headers:failure:success:)","abstract":"

Get counterexample.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C20updateCounterexampleySS11workspaceID_SS4textSSSg7newTexts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateCounterexample(workspaceID:text:newText:headers:failure:success:)","abstract":"

Update counterexample.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C20deleteCounterexampleySS11workspaceID_SS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteCounterexample(workspaceID:text:headers:failure:success:)","abstract":"

Delete counterexample.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12listEntitiesySS11workspaceID_SbSg6exportSiSg9pageLimitAF12includeCountSSSg4sortAK6cursorAF0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA16EntityCollectionVc7successtF":{"name":"listEntities(workspaceID:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entities.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12createEntityySS11workspaceID_AA06CreateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createEntity(workspaceID:properties:headers:failure:success:)","abstract":"

Create entity.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C9getEntityySS11workspaceID_SS6entitySbSg6exportAG12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getEntity(workspaceID:entity:export:includeAudit:headers:failure:success:)","abstract":"

Get entity.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12updateEntityySS11workspaceID_SS6entityAA06UpdateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateEntity(workspaceID:entity:properties:headers:failure:success:)","abstract":"

Update entity.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12deleteEntityySS11workspaceID_SS6entitys10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteEntity(workspaceID:entity:headers:failure:success:)","abstract":"

Delete entity.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C10listValuesySS11workspaceID_SS6entitySbSg6exportSiSg9pageLimitAG12includeCountSSSg4sortAL6cursorAG0K5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA15ValueCollectionVc7successtF":{"name":"listValues(workspaceID:entity:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entity values.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11createValueySS11workspaceID_SS6entityAA06CreateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createValue(workspaceID:entity:properties:headers:failure:success:)","abstract":"

Add entity value.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C8getValueySS11workspaceID_SS6entitySS5valueSbSg6exportAH12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getValue(workspaceID:entity:value:export:includeAudit:headers:failure:success:)","abstract":"

Get entity value.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11updateValueySS11workspaceID_SS6entitySS5valueAA06UpdateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateValue(workspaceID:entity:value:properties:headers:failure:success:)","abstract":"

Update entity value.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11deleteValueySS11workspaceID_SS6entitySS5values10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteValue(workspaceID:entity:value:headers:failure:success:)","abstract":"

Delete entity value.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12listSynonymsySS11workspaceID_SS6entitySS5valueSiSg9pageLimitSbSg12includeCountSSSg4sortAL6cursorAJ0K5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA17SynonymCollectionVc7successtF":{"name":"listSynonyms(workspaceID:entity:value:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entity value synonyms.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13createSynonymySS11workspaceID_SS6entitySS5valueSS7synonyms10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createSynonym(workspaceID:entity:value:synonym:headers:failure:success:)","abstract":"

Add entity value synonym.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C10getSynonymySS11workspaceID_SS6entitySS5valueSS7synonymSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getSynonym(workspaceID:entity:value:synonym:includeAudit:headers:failure:success:)","abstract":"

Get entity value synonym.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13updateSynonymySS11workspaceID_SS6entitySS5valueSS7synonymSSSg03newD0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateSynonym(workspaceID:entity:value:synonym:newSynonym:headers:failure:success:)","abstract":"

Update entity value synonym.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13deleteSynonymySS11workspaceID_SS6entitySS5valueSS7synonyms10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteSynonym(workspaceID:entity:value:synonym:headers:failure:success:)","abstract":"

Delete entity value synonym.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C15listDialogNodesySS11workspaceID_SiSg9pageLimitSbSg12includeCountSSSg4sortAJ6cursorAH0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D14NodeCollectionVc7successtF":{"name":"listDialogNodes(workspaceID:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List dialog nodes.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C16createDialogNodeySS11workspaceID_AA06CreatedE0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"createDialogNode(workspaceID:properties:headers:failure:success:)","abstract":"

Create dialog node.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13getDialogNodeySS11workspaceID_SS06dialogE0SbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"getDialogNode(workspaceID:dialogNode:includeAudit:headers:failure:success:)","abstract":"

Get dialog node.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C16updateDialogNodeySS11workspaceID_SS06dialogE0AA06UpdatedE0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"updateDialogNode(workspaceID:dialogNode:properties:headers:failure:success:)","abstract":"

Update dialog node.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C16deleteDialogNodeySS11workspaceID_SS06dialogE0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteDialogNode(workspaceID:dialogNode:headers:failure:success:)","abstract":"

Delete dialog node.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C8listLogsySS11workspaceID_SSSg4sortAF6filterSiSg9pageLimitAF6cursors10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA13LogCollectionVc7successtF":{"name":"listLogs(workspaceID:sort:filter:pageLimit:cursor:headers:failure:success:)","abstract":"

List log events in a workspace.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11listAllLogsySS6filter_SSSg4sortSiSg9pageLimitAF6cursors10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA13LogCollectionVc7successtF":{"name":"listAllLogs(filter:sort:pageLimit:cursor:headers:failure:success:)","abstract":"

List log events in all workspaces.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

Delete labeled data.

","parent_name":"Assistant"},"Classes/Assistant.html":{"name":"Assistant","abstract":"

The IBM Watson Assistant service combines machine learning, natural language understanding, and integrated dialog tools"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file +{"Structs/WorkspaceExport/Status.html#/s:11AssistantV115WorkspaceExportV6StatusO11nonExistentA2EmF":{"name":"nonExistent","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:11AssistantV115WorkspaceExportV6StatusO8trainingA2EmF":{"name":"training","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:11AssistantV115WorkspaceExportV6StatusO6failedA2EmF":{"name":"failed","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:11AssistantV115WorkspaceExportV6StatusO9availableA2EmF":{"name":"available","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:11AssistantV115WorkspaceExportV6StatusO11unavailableA2EmF":{"name":"unavailable","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html":{"name":"Status","abstract":"

The current status of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV4nameSSvp":{"name":"name","abstract":"

The name of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV11descriptionSSvp":{"name":"description","abstract":"

The description of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV8languageSSvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV8metadatas10DictionaryVySSAA4JSONOGvp":{"name":"metadata","abstract":"

Any metadata that is required by the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The workspace ID.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV6statusSSvp":{"name":"status","abstract":"

The current status of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV14learningOptOutSbvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV7intentsSayAA06IntentD0VGSgvp":{"name":"intents","abstract":"

An array of intents.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV8entitiesSayAA06EntityD0VGSgvp":{"name":"entities","abstract":"

An array of entities.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV15counterexamplesSayAA14CounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of counterexamples.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:11AssistantV115WorkspaceExportV11dialogNodesSayAA10DialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects describing the dialog nodes in the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceCollection.html#/s:11AssistantV119WorkspaceCollectionV10workspacesSayAA0C0VGvp":{"name":"workspaces","abstract":"

An array of objects describing the workspaces associated with the service instance.

","parent_name":"WorkspaceCollection"},"Structs/WorkspaceCollection.html#/s:11AssistantV119WorkspaceCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

An object defining the pagination data for the returned objects.

","parent_name":"WorkspaceCollection"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV4nameSSvp":{"name":"name","abstract":"

The name of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV8languageSSvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The workspace ID.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:11AssistantV19WorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for","parent_name":"Workspace"},"Structs/ValueExport/ValueType.html#/s:11AssistantV111ValueExportV0C4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/ValueExport/ValueType.html#/s:11AssistantV111ValueExportV0C4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/ValueExport/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV9valueTextSSvp":{"name":"valueText","abstract":"

The text of the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array containing any patterns for the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:11AssistantV111ValueExportV9valueTypeSSvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"ValueExport"},"Structs/ValueCollection.html#/s:11AssistantV115ValueCollectionV6valuesSayAA0C6ExportVGvp":{"name":"values","abstract":"

An array of entity values.

","parent_name":"ValueCollection"},"Structs/ValueCollection.html#/s:11AssistantV115ValueCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

An object defining the pagination data for the returned objects.

","parent_name":"ValueCollection"},"Structs/Value/ValueType.html#/s:11AssistantV15ValueV0C4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/Value/ValueType.html#/s:11AssistantV15ValueV0C4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/Value/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV9valueTextSSvp":{"name":"valueText","abstract":"

The text of the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array containing any patterns for the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:11AssistantV15ValueV9valueTypeSSvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"Value"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV4nameSSSgvp":{"name":"name","abstract":"

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV8languageSSSgvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV7intentsSayAA12CreateIntentVGSgvp":{"name":"intents","abstract":"

An array of objects defining the intents for the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV8entitiesSayAA12CreateEntityVGSgvp":{"name":"entities","abstract":"

An array of objects defining the entities for the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV11dialogNodesSayAA16CreateDialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects defining the nodes in the workspace dialog.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV15counterexamplesSayAA20CreateCounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of objects defining input examples that have been marked as irrelevant input.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:11AssistantV115UpdateWorkspaceVACSSSg4name_AD11descriptionAD8languageSayAA12CreateIntentVGSg7intentsSayAA0H6EntityVGSg8entitiesSayAA0H10DialogNodeVGSg11dialogNodesSayAA0H14CounterexampleVGSg15counterexampless10DictionaryVySSAA4JSONOGSg8metadataSbSg14learningOptOuttcfc":{"name":"init(name:description:language:intents:entities:dialogNodes:counterexamples:metadata:learningOptOut:)","abstract":"

Initialize a UpdateWorkspace with member variables.

","parent_name":"UpdateWorkspace"},"Structs/UpdateValue/ValueType.html#/s:11AssistantV111UpdateValueV0D4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/UpdateValue/ValueType.html#/s:11AssistantV111UpdateValueV0D4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/UpdateValue/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueV5valueSSSgvp":{"name":"value","abstract":"

The text of the entity value. This string must conform to the following restrictions:

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueV9valueTypeSSSgvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type),","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type),","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:11AssistantV111UpdateValueVACSSSg5value_s10DictionaryVySSAA4JSONOGSg8metadataAD0E4TypeSaySSGSg8synonymsAO8patternstcfc":{"name":"init(value:metadata:valueType:synonyms:patterns:)","abstract":"

Initialize a UpdateValue with member variables.

","parent_name":"UpdateValue"},"Structs/UpdateSynonym.html#/s:11AssistantV113UpdateSynonymV7synonymSSSgvp":{"name":"synonym","abstract":"

The text of the synonym. This string must conform to the following restrictions:

","parent_name":"UpdateSynonym"},"Structs/UpdateSynonym.html#/s:11AssistantV113UpdateSynonymVACSSSg7synonym_tcfc":{"name":"init(synonym:)","abstract":"

Initialize a UpdateSynonym with member variables.

","parent_name":"UpdateSynonym"},"Structs/UpdateIntent.html#/s:11AssistantV112UpdateIntentV6intentSSSgvp":{"name":"intent","abstract":"

The name of the intent. This string must conform to the following restrictions:

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:11AssistantV112UpdateIntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:11AssistantV112UpdateIntentV8examplesSayAA13CreateExampleVGSgvp":{"name":"examples","abstract":"

An array of user input examples for the intent.

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:11AssistantV112UpdateIntentVACSSSg6intent_AD11descriptionSayAA13CreateExampleVGSg8examplestcfc":{"name":"init(intent:description:examples:)","abstract":"

Initialize a UpdateIntent with member variables.

","parent_name":"UpdateIntent"},"Structs/UpdateExample.html#/s:11AssistantV113UpdateExampleV4textSSSgvp":{"name":"text","abstract":"

The text of the user input example. This string must conform to the following restrictions:

","parent_name":"UpdateExample"},"Structs/UpdateExample.html#/s:11AssistantV113UpdateExampleVACSSSg4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a UpdateExample with member variables.

","parent_name":"UpdateExample"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityV6entitySSSgvp":{"name":"entity","abstract":"

The name of the entity. This string must conform to the following restrictions:

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether to use fuzzy matching for the entity.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityV6valuesSayAA11CreateValueVGSgvp":{"name":"values","abstract":"

An array of entity values.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:11AssistantV112UpdateEntityVACSSSg6entity_AD11descriptions10DictionaryVySSAA4JSONOGSg8metadataSbSg10fuzzyMatchSayAA11CreateValueVGSg6valuestcfc":{"name":"init(entity:description:metadata:fuzzyMatch:values:)","abstract":"

Initialize a UpdateEntity with member variables.

","parent_name":"UpdateEntity"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:11AssistantV116UpdateDialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:11AssistantV116UpdateDialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:11AssistantV116UpdateDialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOut.html#/s:11AssistantV116UpdateDialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressOut.html#/s:11AssistantV116UpdateDialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressOut.html#/s:11AssistantV116UpdateDialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressIn.html#/s:11AssistantV116UpdateDialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/DigressIn.html#/s:11AssistantV116UpdateDialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/DigressIn.html#/s:11AssistantV116UpdateDialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:11AssistantV116UpdateDialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:11AssistantV116UpdateDialogNodeV0E4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV06dialogE0SSSgvp":{"name":"dialogNode","abstract":"

The dialog node ID. This string must conform to the following restrictions:

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous sibling dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node. For more information about how to specify dialog node output, see the","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context for the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

The metadata for the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV8nextStepAA0de4NextG0VSgvp":{"name":"nextStep","abstract":"

The next step to be executed in dialog processing.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node. This string must conform to the following restrictions:

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV7actionsSayAA0dE6ActionVGSgvp":{"name":"actions","abstract":"

An array of objects describing any actions to be invoked by the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:11AssistantV116UpdateDialogNodeVACSSSg06dialogE0_AD11descriptionAD10conditionsAD6parentAD15previousSiblings10DictionaryVySSAA4JSONOGSg6outputAO7contextAO8metadataAA0dE8NextStepVSg04nextR0AD5titleAD8nodeTypeAD9eventNameAD8variableSayAA0dE6ActionVGSg7actionsAD9digressInAD10digressOutAD15digressOutSlotstcfc":{"name":"init(dialogNode:description:conditions:parent:previousSibling:output:context:metadata:nextStep:title:nodeType:eventName:variable:actions:digressIn:digressOut:digressOutSlots:)","abstract":"

Initialize a UpdateDialogNode with member variables.

","parent_name":"UpdateDialogNode"},"Structs/UpdateCounterexample.html#/s:11AssistantV120UpdateCounterexampleV4textSSSgvp":{"name":"text","abstract":"

The text of a user input counterexample.

","parent_name":"UpdateCounterexample"},"Structs/UpdateCounterexample.html#/s:11AssistantV120UpdateCounterexampleVACSSSg4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a UpdateCounterexample with member variables.

","parent_name":"UpdateCounterexample"},"Structs/SystemResponse.html#/s:11AssistantV114SystemResponseV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:11AssistantV114SystemResponseVACs10DictionaryVySSAA4JSONOG20additionalProperties_tcfc":{"name":"init(additionalProperties:)","abstract":"

Initialize a SystemResponse.

","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"SystemResponse"},"Structs/SynonymCollection.html#/s:11AssistantV117SynonymCollectionV8synonymsSayAA0C0VGvp":{"name":"synonyms","abstract":"

An array of synonyms.

","parent_name":"SynonymCollection"},"Structs/SynonymCollection.html#/s:11AssistantV117SynonymCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"SynonymCollection"},"Structs/Synonym.html#/s:11AssistantV17SynonymV11synonymTextSSvp":{"name":"synonymText","abstract":"

The text of the synonym.

","parent_name":"Synonym"},"Structs/Synonym.html#/s:11AssistantV17SynonymV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the synonym.

","parent_name":"Synonym"},"Structs/Synonym.html#/s:11AssistantV17SynonymV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the most recent update to the synonym.

","parent_name":"Synonym"},"Structs/RuntimeIntent.html#/s:11AssistantV113RuntimeIntentV6intentSSvp":{"name":"intent","abstract":"

The name of the recognized intent.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:11AssistantV113RuntimeIntentV10confidenceSdvp":{"name":"confidence","abstract":"

A decimal percentage that represents Watson’s confidence in the intent.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:11AssistantV113RuntimeIntentV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:11AssistantV113RuntimeIntentVACSS6intent_Sd10confidences10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(intent:confidence:additionalProperties:)","abstract":"

Initialize a RuntimeIntent with member variables.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"RuntimeIntent"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV6entitySSvp":{"name":"entity","abstract":"

An entity detected in the input.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV8locationSaySiGvp":{"name":"location","abstract":"

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV5valueSSvp":{"name":"value","abstract":"

The term in the input text that was recognized as an entity value.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV10confidenceSdSgvp":{"name":"confidence","abstract":"

A decimal percentage that represents Watson’s confidence in the entity.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata for the entity.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV6groupsSayAA12CaptureGroupVGSgvp":{"name":"groups","abstract":"

The recognized capture groups for the entity, as defined by the entity pattern.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:11AssistantV113RuntimeEntityVACSS6entity_SaySiG8locationSS5valueSdSg10confidences10DictionaryVySSAA4JSONOGSg8metadataSayAA12CaptureGroupVGSg6groupsAN20additionalPropertiestcfc":{"name":"init(entity:location:value:confidence:metadata:groups:additionalProperties:)","abstract":"

Initialize a RuntimeEntity with member variables.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"RuntimeEntity"},"Structs/Pagination.html#/s:11AssistantV110PaginationV10refreshUrlSSvp":{"name":"refreshUrl","abstract":"

The URL that will return the same page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:11AssistantV110PaginationV7nextUrlSSSgvp":{"name":"nextUrl","abstract":"

The URL that will return the next page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:11AssistantV110PaginationV5totalSiSgvp":{"name":"total","abstract":"

Reserved for future use.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:11AssistantV110PaginationV7matchedSiSgvp":{"name":"matched","abstract":"

Reserved for future use.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:11AssistantV110PaginationV13refreshCursorSSSgvp":{"name":"refreshCursor","abstract":"

A token identifying the current page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:11AssistantV110PaginationV10nextCursorSSSgvp":{"name":"nextCursor","abstract":"

A token identifying the next page of results.

","parent_name":"Pagination"},"Structs/OutputData.html#/s:11AssistantV110OutputDataV11logMessagesSayAA10LogMessageVGvp":{"name":"logMessages","abstract":"

An array of up to 50 messages logged with the request.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:11AssistantV110OutputDataV4textSaySSGvp":{"name":"text","abstract":"

An array of responses to the user.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:11AssistantV110OutputDataV12nodesVisitedSaySSGSgvp":{"name":"nodesVisited","abstract":"

An array of the nodes that were triggered to create the response, in the order in which they were visited. This","parent_name":"OutputData"},"Structs/OutputData.html#/s:11AssistantV110OutputDataV19nodesVisitedDetailsSayAA010DialogNodefG0VGSgvp":{"name":"nodesVisitedDetails","abstract":"

An array of objects containing detailed diagnostic information about the nodes that were triggered during","parent_name":"OutputData"},"Structs/OutputData.html#/s:11AssistantV110OutputDataV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:11AssistantV110OutputDataVACSayAA10LogMessageVG11logMessages_SaySSG4textAHSg12nodesVisitedSayAA010DialogNodeK7DetailsVGSg0jkN0s10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(logMessages:text:nodesVisited:nodesVisitedDetails:additionalProperties:)","abstract":"

Initialize a OutputData with member variables.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"OutputData"},"Structs/OutputData.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"OutputData"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV5inputAA0C5InputVSgvp":{"name":"input","abstract":"

The user input from the request.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV7intentsSayAA13RuntimeIntentVGvp":{"name":"intents","abstract":"

An array of intents recognized in the user input, sorted in descending order of confidence.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV8entitiesSayAA13RuntimeEntityVGvp":{"name":"entities","abstract":"

An array of entities identified in the user input.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV16alternateIntentsSbSgvp":{"name":"alternateIntents","abstract":"

Whether to return more than one intent. A value of true indicates that all matching intents are returned.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV7contextAA7ContextVvp":{"name":"context","abstract":"

State information for the conversation.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV6outputAA10OutputDataVvp":{"name":"output","abstract":"

Output from the dialog, including the response to the user, the nodes that were triggered, and log messages.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:11AssistantV115MessageResponseV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"MessageResponse"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV5inputAA9InputDataVSgvp":{"name":"input","abstract":"

An input object that includes the input text.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV16alternateIntentsSbSgvp":{"name":"alternateIntents","abstract":"

Whether to return more than one intent. Set to true to return all matching intents.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV7contextAA7ContextVSgvp":{"name":"context","abstract":"

State information for the conversation. Continue a conversation by including the context object from the previous","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV8entitiesSayAA13RuntimeEntityVGSgvp":{"name":"entities","abstract":"

Entities to use when evaluating the message. Include entities from the previous response to continue using those","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV7intentsSayAA13RuntimeIntentVGSgvp":{"name":"intents","abstract":"

Intents to use when evaluating the user input. Include intents from the previous response to continue using those","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestV6outputAA10OutputDataVSgvp":{"name":"output","abstract":"

System output. Include the output from the previous response to maintain intermediate information over multiple","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:11AssistantV114MessageRequestVAcA9InputDataVSg5input_SbSg16alternateIntentsAA7ContextVSg7contextSayAA13RuntimeEntityVGSg8entitiesSayAA0L6IntentVGSg7intentsAA06OutputF0VSg6outputtcfc":{"name":"init(input:alternateIntents:context:entities:intents:output:)","abstract":"

Initialize a MessageRequest with member variables.

","parent_name":"MessageRequest"},"Structs/MessageInput.html#/s:11AssistantV112MessageInputV4textSSSgvp":{"name":"text","abstract":"

The user’s input.

","parent_name":"MessageInput"},"Structs/LogPagination.html#/s:11AssistantV113LogPaginationV7nextUrlSSSgvp":{"name":"nextUrl","abstract":"

The URL that will return the next page of results, if any.

","parent_name":"LogPagination"},"Structs/LogPagination.html#/s:11AssistantV113LogPaginationV7matchedSiSgvp":{"name":"matched","abstract":"

Reserved for future use.

","parent_name":"LogPagination"},"Structs/LogPagination.html#/s:11AssistantV113LogPaginationV10nextCursorSSSgvp":{"name":"nextCursor","abstract":"

A token identifying the next page of results.

","parent_name":"LogPagination"},"Structs/LogMessage/Level.html#/s:11AssistantV110LogMessageV5LevelO4infoA2EmF":{"name":"info","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html#/s:11AssistantV110LogMessageV5LevelO5errorA2EmF":{"name":"error","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html#/s:11AssistantV110LogMessageV5LevelO4warnA2EmF":{"name":"warn","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html":{"name":"Level","abstract":"

The severity of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:11AssistantV110LogMessageV5levelSSvp":{"name":"level","abstract":"

The severity of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:11AssistantV110LogMessageV3msgSSvp":{"name":"msg","abstract":"

The text of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:11AssistantV110LogMessageV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:11AssistantV110LogMessageVACSS5level_SS3msgs10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(level:msg:additionalProperties:)","abstract":"

Initialize a LogMessage with member variables.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"LogMessage"},"Structs/LogExport.html#/s:11AssistantV19LogExportV7requestAA14MessageRequestVvp":{"name":"request","abstract":"

A request received by the workspace, including the user input and context.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV8responseAA15MessageResponseVvp":{"name":"response","abstract":"

The response sent by the workspace, including the output text, detected intents and entities, and context.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV5logIDSSvp":{"name":"logID","abstract":"

A unique identifier for the logged event.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV16requestTimestampSSvp":{"name":"requestTimestamp","abstract":"

The timestamp for receipt of the message.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV17responseTimestampSSvp":{"name":"responseTimestamp","abstract":"

The timestamp for the system response to the message.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The unique identifier of the workspace where the request was made.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:11AssistantV19LogExportV8languageSSvp":{"name":"language","abstract":"

The language of the workspace where the message request was made.

","parent_name":"LogExport"},"Structs/LogCollection.html#/s:11AssistantV113LogCollectionV4logsSayAA0C6ExportVGvp":{"name":"logs","abstract":"

An array of objects describing log events.

","parent_name":"LogCollection"},"Structs/LogCollection.html#/s:11AssistantV113LogCollectionV10paginationAA0C10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"LogCollection"},"Structs/IntentExport.html#/s:11AssistantV112IntentExportV10intentNameSSvp":{"name":"intentName","abstract":"

The name of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:11AssistantV112IntentExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:11AssistantV112IntentExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:11AssistantV112IntentExportV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:11AssistantV112IntentExportV8examplesSayAA7ExampleVGSgvp":{"name":"examples","abstract":"

An array of objects describing the user input examples for the intent.

","parent_name":"IntentExport"},"Structs/IntentCollection.html#/s:11AssistantV116IntentCollectionV7intentsSayAA0C6ExportVGvp":{"name":"intents","abstract":"

An array of objects describing the intents defined for the workspace.

","parent_name":"IntentCollection"},"Structs/IntentCollection.html#/s:11AssistantV116IntentCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"IntentCollection"},"Structs/Intent.html#/s:11AssistantV16IntentV10intentNameSSvp":{"name":"intentName","abstract":"

The name of the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:11AssistantV16IntentV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:11AssistantV16IntentV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:11AssistantV16IntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"Intent"},"Structs/InputData.html#/s:11AssistantV19InputDataV4textSSvp":{"name":"text","abstract":"

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be","parent_name":"InputData"},"Structs/InputData.html#/s:11AssistantV19InputDataVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a InputData with member variables.

","parent_name":"InputData"},"Structs/ExampleCollection.html#/s:11AssistantV117ExampleCollectionV8examplesSayAA0C0VGvp":{"name":"examples","abstract":"

An array of objects describing the examples defined for the intent.

","parent_name":"ExampleCollection"},"Structs/ExampleCollection.html#/s:11AssistantV117ExampleCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"ExampleCollection"},"Structs/Example.html#/s:11AssistantV17ExampleV11exampleTextSSvp":{"name":"exampleText","abstract":"

The text of the user input example.

","parent_name":"Example"},"Structs/Example.html#/s:11AssistantV17ExampleV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the example.

","parent_name":"Example"},"Structs/Example.html#/s:11AssistantV17ExampleV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the example.

","parent_name":"Example"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV10entityNameSSvp":{"name":"entityName","abstract":"

The name of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether fuzzy matching is used for the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:11AssistantV112EntityExportV6valuesSayAA05ValueD0VGSgvp":{"name":"values","abstract":"

An array objects describing the entity values.

","parent_name":"EntityExport"},"Structs/EntityCollection.html#/s:11AssistantV116EntityCollectionV8entitiesSayAA0C6ExportVGvp":{"name":"entities","abstract":"

An array of objects describing the entities defined for the workspace.

","parent_name":"EntityCollection"},"Structs/EntityCollection.html#/s:11AssistantV116EntityCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"EntityCollection"},"Structs/Entity.html#/s:11AssistantV16EntityV10entityNameSSvp":{"name":"entityName","abstract":"

The name of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:11AssistantV16EntityV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:11AssistantV16EntityV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:11AssistantV16EntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:11AssistantV16EntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:11AssistantV16EntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether fuzzy matching is used for the entity.

","parent_name":"Entity"},"Structs/DialogNodeVisitedDetails.html#/s:11AssistantV124DialogNodeVisitedDetailsV06dialogD0SSSgvp":{"name":"dialogNode","abstract":"

A dialog node that was triggered during processing of the input message.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:11AssistantV124DialogNodeVisitedDetailsV5titleSSSgvp":{"name":"title","abstract":"

The title of the dialog node.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:11AssistantV124DialogNodeVisitedDetailsV10conditionsSSSgvp":{"name":"conditions","abstract":"

The conditions that trigger the dialog node.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:11AssistantV124DialogNodeVisitedDetailsVACSSSg06dialogD0_AD5titleAD10conditionstcfc":{"name":"init(dialogNode:title:conditions:)","abstract":"

Initialize a DialogNodeVisitedDetails with member variables.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeNextStep/Selector.html#/s:11AssistantV118DialogNodeNextStepV8SelectorO9conditionA2EmF":{"name":"condition","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:11AssistantV118DialogNodeNextStepV8SelectorO6clientA2EmF":{"name":"client","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:11AssistantV118DialogNodeNextStepV8SelectorO9userInputA2EmF":{"name":"userInput","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:11AssistantV118DialogNodeNextStepV8SelectorO4bodyA2EmF":{"name":"body","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO12getUserInputA2EmF":{"name":"getUserInput","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO13skipUserInputA2EmF":{"name":"skipUserInput","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO6jumpToA2EmF":{"name":"jumpTo","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO8repromptA2EmF":{"name":"reprompt","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO8skipSlotA2EmF":{"name":"skipSlot","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:11AssistantV118DialogNodeNextStepV8BehaviorO12skipAllSlotsA2EmF":{"name":"skipAllSlots","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html":{"name":"Behavior","abstract":"

What happens after the dialog node completes. The valid values depend on the node type:

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep/Selector.html":{"name":"Selector","abstract":"

Which part of the dialog node to process next.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:11AssistantV118DialogNodeNextStepV8behaviorSSvp":{"name":"behavior","abstract":"

What happens after the dialog node completes. The valid values depend on the node type:

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:11AssistantV118DialogNodeNextStepV06dialogD0SSSgvp":{"name":"dialogNode","abstract":"

The ID of the dialog node to process next. This parameter is required if behavior=jump_to.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:11AssistantV118DialogNodeNextStepV8selectorSSSgvp":{"name":"selector","abstract":"

Which part of the dialog node to process next.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:11AssistantV118DialogNodeNextStepVACSS8behavior_SSSg06dialogD0AE8selectortcfc":{"name":"init(behavior:dialogNode:selector:)","abstract":"

Initialize a DialogNodeNextStep with member variables.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeCollection.html#/s:11AssistantV120DialogNodeCollectionV11dialogNodesSayAA0cD0VGvp":{"name":"dialogNodes","abstract":"

An array of objects describing the dialog nodes defined for the workspace.

","parent_name":"DialogNodeCollection"},"Structs/DialogNodeCollection.html#/s:11AssistantV120DialogNodeCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"DialogNodeCollection"},"Structs/DialogNodeAction/ActionType.html#/s:11AssistantV116DialogNodeActionV0E4TypeO6clientA2EmF":{"name":"client","abstract":"

Undocumented

","parent_name":"ActionType"},"Structs/DialogNodeAction/ActionType.html#/s:11AssistantV116DialogNodeActionV0E4TypeO6serverA2EmF":{"name":"server","abstract":"

Undocumented

","parent_name":"ActionType"},"Structs/DialogNodeAction/ActionType.html":{"name":"ActionType","abstract":"

The type of action to invoke.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionV4nameSSvp":{"name":"name","abstract":"

The name of the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionV10actionTypeSSSgvp":{"name":"actionType","abstract":"

The type of action to invoke.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionV10parameterss10DictionaryVySSAA4JSONOGSgvp":{"name":"parameters","abstract":"

A map of key/value pairs to be provided to the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionV14resultVariableSSvp":{"name":"resultVariable","abstract":"

The location in the dialog context where the result of the action is stored.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionV11credentialsSSSgvp":{"name":"credentials","abstract":"

The name of the context variable that the client application will use to pass in credentials for the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:11AssistantV116DialogNodeActionVACSS4name_SS14resultVariableSSSg10actionTypes10DictionaryVySSAA4JSONOGSg10parametersAF11credentialstcfc":{"name":"init(name:resultVariable:actionType:parameters:credentials:)","abstract":"

Initialize a DialogNodeAction with member variables.

","parent_name":"DialogNodeAction"},"Structs/DialogNode/DigressOutSlots.html#/s:11AssistantV110DialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOutSlots.html#/s:11AssistantV110DialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOutSlots.html#/s:11AssistantV110DialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOut.html#/s:11AssistantV110DialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressOut.html#/s:11AssistantV110DialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressOut.html#/s:11AssistantV110DialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressIn.html#/s:11AssistantV110DialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/DigressIn.html#/s:11AssistantV110DialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/DigressIn.html#/s:11AssistantV110DialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:11AssistantV110DialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:11AssistantV110DialogNodeV0D4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV06dialogD2IDSSvp":{"name":"dialogNodeID","abstract":"

The dialog node ID.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that triggers the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node. This property is not returned if the dialog node has no parent.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous sibling dialog node. This property is not returned if the dialog node has no previous","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context (if defined) for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV8nextStepAA0cd4NextF0VSgvp":{"name":"nextStep","abstract":"

The next step to execute following this dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the most recent update to the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV7actionsSayAA0cD6ActionVGSgvp":{"name":"actions","abstract":"

The actions for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:11AssistantV110DialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"DialogNode"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV4nameSSSgvp":{"name":"name","abstract":"

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV8languageSSSgvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV7intentsSayAA0C6IntentVGSgvp":{"name":"intents","abstract":"

An array of objects defining the intents for the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV8entitiesSayAA0C6EntityVGSgvp":{"name":"entities","abstract":"

An array of objects defining the entities for the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV11dialogNodesSayAA0C10DialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects defining the nodes in the workspace dialog.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV15counterexamplesSayAA0C14CounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of objects defining input examples that have been marked as irrelevant input.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:11AssistantV115CreateWorkspaceVACSSSg4name_AD11descriptionAD8languageSayAA0C6IntentVGSg7intentsSayAA0C6EntityVGSg8entitiesSayAA0C10DialogNodeVGSg11dialogNodesSayAA0C14CounterexampleVGSg15counterexampless10DictionaryVySSAA4JSONOGSg8metadataSbSg14learningOptOuttcfc":{"name":"init(name:description:language:intents:entities:dialogNodes:counterexamples:metadata:learningOptOut:)","abstract":"

Initialize a CreateWorkspace with member variables.

","parent_name":"CreateWorkspace"},"Structs/CreateValue/ValueType.html#/s:11AssistantV111CreateValueV0D4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/CreateValue/ValueType.html#/s:11AssistantV111CreateValueV0D4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/CreateValue/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueV5valueSSvp":{"name":"value","abstract":"

The text of the entity value. This string must conform to the following restrictions:

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type),","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueV9valueTypeSSSgvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:11AssistantV111CreateValueVACSS5value_s10DictionaryVySSAA4JSONOGSg8metadataSaySSGSg8synonymsAM8patternsSSSg0E4Typetcfc":{"name":"init(value:metadata:synonyms:patterns:valueType:)","abstract":"

Initialize a CreateValue with member variables.

","parent_name":"CreateValue"},"Structs/CreateSynonym.html#/s:11AssistantV113CreateSynonymV7synonymSSvp":{"name":"synonym","abstract":"

The text of the synonym. This string must conform to the following restrictions:

","parent_name":"CreateSynonym"},"Structs/CreateSynonym.html#/s:11AssistantV113CreateSynonymVACSS7synonym_tcfc":{"name":"init(synonym:)","abstract":"

Initialize a CreateSynonym with member variables.

","parent_name":"CreateSynonym"},"Structs/CreateIntent.html#/s:11AssistantV112CreateIntentV6intentSSvp":{"name":"intent","abstract":"

The name of the intent. This string must conform to the following restrictions:

","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:11AssistantV112CreateIntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:11AssistantV112CreateIntentV8examplesSayAA0C7ExampleVGSgvp":{"name":"examples","abstract":"

An array of user input examples for the intent.

","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:11AssistantV112CreateIntentVACSS6intent_SSSg11descriptionSayAA0C7ExampleVGSg8examplestcfc":{"name":"init(intent:description:examples:)","abstract":"

Initialize a CreateIntent with member variables.

","parent_name":"CreateIntent"},"Structs/CreateExample.html#/s:11AssistantV113CreateExampleV4textSSvp":{"name":"text","abstract":"

The text of a user input example. This string must conform to the following restrictions:

","parent_name":"CreateExample"},"Structs/CreateExample.html#/s:11AssistantV113CreateExampleVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a CreateExample with member variables.

","parent_name":"CreateExample"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityV6entitySSvp":{"name":"entity","abstract":"

The name of the entity. This string must conform to the following restrictions:

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the value.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityV6valuesSayAA0C5ValueVGSgvp":{"name":"values","abstract":"

An array of objects describing the entity values.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether to use fuzzy matching for the entity.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:11AssistantV112CreateEntityVACSS6entity_SSSg11descriptions10DictionaryVySSAA4JSONOGSg8metadataSayAA0C5ValueVGSg6valuesSbSg10fuzzyMatchtcfc":{"name":"init(entity:description:metadata:values:fuzzyMatch:)","abstract":"

Initialize a CreateEntity with member variables.

","parent_name":"CreateEntity"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:11AssistantV116CreateDialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:11AssistantV116CreateDialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:11AssistantV116CreateDialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOut.html#/s:11AssistantV116CreateDialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressOut.html#/s:11AssistantV116CreateDialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressOut.html#/s:11AssistantV116CreateDialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressIn.html#/s:11AssistantV116CreateDialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/DigressIn.html#/s:11AssistantV116CreateDialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/DigressIn.html#/s:11AssistantV116CreateDialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:11AssistantV116CreateDialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:11AssistantV116CreateDialogNodeV0E4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV06dialogE0SSvp":{"name":"dialogNode","abstract":"

The dialog node ID. This string must conform to the following restrictions:

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node. For more information about how to specify dialog node output, see the","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context for the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

The metadata for the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV8nextStepAA0de4NextG0VSgvp":{"name":"nextStep","abstract":"

The next step to be executed in dialog processing.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV7actionsSayAA0dE6ActionVGSgvp":{"name":"actions","abstract":"

An array of objects describing any actions to be invoked by the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node. This string must conform to the following restrictions:

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:11AssistantV116CreateDialogNodeVACSS06dialogE0_SSSg11descriptionAE10conditionsAE6parentAE15previousSiblings10DictionaryVySSAA4JSONOGSg6outputAO7contextAO8metadataAA0dE8NextStepVSg04nextR0SayAA0dE6ActionVGSg7actionsAE5titleAE8nodeTypeAE9eventNameAE8variableAE9digressInAE10digressOutAE15digressOutSlotstcfc":{"name":"init(dialogNode:description:conditions:parent:previousSibling:output:context:metadata:nextStep:actions:title:nodeType:eventName:variable:digressIn:digressOut:digressOutSlots:)","abstract":"

Initialize a CreateDialogNode with member variables.

","parent_name":"CreateDialogNode"},"Structs/CreateCounterexample.html#/s:11AssistantV120CreateCounterexampleV4textSSvp":{"name":"text","abstract":"

The text of a user input marked as irrelevant input. This string must conform to the following restrictions:

","parent_name":"CreateCounterexample"},"Structs/CreateCounterexample.html#/s:11AssistantV120CreateCounterexampleVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a CreateCounterexample with member variables.

","parent_name":"CreateCounterexample"},"Structs/CounterexampleCollection.html#/s:11AssistantV124CounterexampleCollectionV15counterexamplesSayAA0C0VGvp":{"name":"counterexamples","abstract":"

An array of objects describing the examples marked as irrelevant input.

","parent_name":"CounterexampleCollection"},"Structs/CounterexampleCollection.html#/s:11AssistantV124CounterexampleCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"CounterexampleCollection"},"Structs/Counterexample.html#/s:11AssistantV114CounterexampleV4textSSvp":{"name":"text","abstract":"

The text of the counterexample.

","parent_name":"Counterexample"},"Structs/Counterexample.html#/s:11AssistantV114CounterexampleV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the counterexample.

","parent_name":"Counterexample"},"Structs/Counterexample.html#/s:11AssistantV114CounterexampleV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the counterexample.

","parent_name":"Counterexample"},"Structs/Context.html#/s:11AssistantV17ContextV14conversationIDSSSgvp":{"name":"conversationID","abstract":"

The unique identifier of the conversation.

","parent_name":"Context"},"Structs/Context.html#/s:11AssistantV17ContextV6systemAA14SystemResponseVSgvp":{"name":"system","abstract":"

For internal use only.

","parent_name":"Context"},"Structs/Context.html#/s:11AssistantV17ContextV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"Context"},"Structs/Context.html#/s:11AssistantV17ContextVACSSSg14conversationID_AA14SystemResponseVSg6systems10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(conversationID:system:additionalProperties:)","abstract":"

Initialize a Context with member variables.

","parent_name":"Context"},"Structs/Context.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"Context"},"Structs/Context.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"Context"},"Structs/CaptureGroup.html#/s:11AssistantV112CaptureGroupV5groupSSvp":{"name":"group","abstract":"

A recognized capture group for the entity.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html#/s:11AssistantV112CaptureGroupV8locationSaySiGSgvp":{"name":"location","abstract":"

Zero-based character offsets that indicate where the entity value begins and ends in the input text.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html#/s:11AssistantV112CaptureGroupVACSS5group_SaySiGSg8locationtcfc":{"name":"init(group:location:)","abstract":"

Initialize a CaptureGroup with member variables.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html":{"name":"CaptureGroup","abstract":"

CaptureGroup.

"},"Structs/Context.html":{"name":"Context","abstract":"

State information for the conversation. To maintain state, include the context from the previous response.

"},"Structs/Counterexample.html":{"name":"Counterexample","abstract":"

Counterexample.

"},"Structs/CounterexampleCollection.html":{"name":"CounterexampleCollection","abstract":"

CounterexampleCollection.

"},"Structs/CreateCounterexample.html":{"name":"CreateCounterexample","abstract":"

CreateCounterexample.

"},"Structs/CreateDialogNode.html":{"name":"CreateDialogNode","abstract":"

CreateDialogNode.

"},"Structs/CreateEntity.html":{"name":"CreateEntity","abstract":"

CreateEntity.

"},"Structs/CreateExample.html":{"name":"CreateExample","abstract":"

CreateExample.

"},"Structs/CreateIntent.html":{"name":"CreateIntent","abstract":"

CreateIntent.

"},"Structs/CreateSynonym.html":{"name":"CreateSynonym","abstract":"

CreateSynonym.

"},"Structs/CreateValue.html":{"name":"CreateValue","abstract":"

CreateValue.

"},"Structs/CreateWorkspace.html":{"name":"CreateWorkspace","abstract":"

CreateWorkspace.

"},"Structs/DialogNode.html":{"name":"DialogNode","abstract":"

DialogNode.

"},"Structs/DialogNodeAction.html":{"name":"DialogNodeAction","abstract":"

DialogNodeAction.

"},"Structs/DialogNodeCollection.html":{"name":"DialogNodeCollection","abstract":"

An array of dialog nodes.

"},"Structs/DialogNodeNextStep.html":{"name":"DialogNodeNextStep","abstract":"

The next step to execute following this dialog node.

"},"Structs/DialogNodeVisitedDetails.html":{"name":"DialogNodeVisitedDetails","abstract":"

DialogNodeVisitedDetails.

"},"Structs/Entity.html":{"name":"Entity","abstract":"

Entity.

"},"Structs/EntityCollection.html":{"name":"EntityCollection","abstract":"

An array of entities.

"},"Structs/EntityExport.html":{"name":"EntityExport","abstract":"

EntityExport.

"},"Structs/Example.html":{"name":"Example","abstract":"

Example.

"},"Structs/ExampleCollection.html":{"name":"ExampleCollection","abstract":"

ExampleCollection.

"},"Structs/InputData.html":{"name":"InputData","abstract":"

The user input.

"},"Structs/Intent.html":{"name":"Intent","abstract":"

Intent.

"},"Structs/IntentCollection.html":{"name":"IntentCollection","abstract":"

IntentCollection.

"},"Structs/IntentExport.html":{"name":"IntentExport","abstract":"

IntentExport.

"},"Structs/LogCollection.html":{"name":"LogCollection","abstract":"

LogCollection.

"},"Structs/LogExport.html":{"name":"LogExport","abstract":"

LogExport.

"},"Structs/LogMessage.html":{"name":"LogMessage","abstract":"

Log message details.

"},"Structs/LogPagination.html":{"name":"LogPagination","abstract":"

The pagination data for the returned objects.

"},"Structs/MessageInput.html":{"name":"MessageInput","abstract":"

The text of the user input.

"},"Structs/MessageRequest.html":{"name":"MessageRequest","abstract":"

A request formatted for the Watson Assistant service.

"},"Structs/MessageResponse.html":{"name":"MessageResponse","abstract":"

A response from the Watson Assistant service.

"},"Structs/OutputData.html":{"name":"OutputData","abstract":"

An output object that includes the response to the user, the nodes that were hit, and messages from the log.

"},"Structs/Pagination.html":{"name":"Pagination","abstract":"

The pagination data for the returned objects.

"},"Structs/RuntimeEntity.html":{"name":"RuntimeEntity","abstract":"

A term from the request that was identified as an entity.

"},"Structs/RuntimeIntent.html":{"name":"RuntimeIntent","abstract":"

An intent identified in the user input.

"},"Structs/Synonym.html":{"name":"Synonym","abstract":"

Synonym.

"},"Structs/SynonymCollection.html":{"name":"SynonymCollection","abstract":"

SynonymCollection.

"},"Structs/SystemResponse.html":{"name":"SystemResponse","abstract":"

For internal use only.

"},"Structs/UpdateCounterexample.html":{"name":"UpdateCounterexample","abstract":"

UpdateCounterexample.

"},"Structs/UpdateDialogNode.html":{"name":"UpdateDialogNode","abstract":"

UpdateDialogNode.

"},"Structs/UpdateEntity.html":{"name":"UpdateEntity","abstract":"

UpdateEntity.

"},"Structs/UpdateExample.html":{"name":"UpdateExample","abstract":"

UpdateExample.

"},"Structs/UpdateIntent.html":{"name":"UpdateIntent","abstract":"

UpdateIntent.

"},"Structs/UpdateSynonym.html":{"name":"UpdateSynonym","abstract":"

UpdateSynonym.

"},"Structs/UpdateValue.html":{"name":"UpdateValue","abstract":"

UpdateValue.

"},"Structs/UpdateWorkspace.html":{"name":"UpdateWorkspace","abstract":"

UpdateWorkspace.

"},"Structs/Value.html":{"name":"Value","abstract":"

Value.

"},"Structs/ValueCollection.html":{"name":"ValueCollection","abstract":"

ValueCollection.

"},"Structs/ValueExport.html":{"name":"ValueExport","abstract":"

ValueExport.

"},"Structs/Workspace.html":{"name":"Workspace","abstract":"

Workspace.

"},"Structs/WorkspaceCollection.html":{"name":"WorkspaceCollection","abstract":"

WorkspaceCollection.

"},"Structs/WorkspaceExport.html":{"name":"WorkspaceExport","abstract":"

WorkspaceExport.

"},"Enums/RestError.html#/s:11AssistantV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO013serializationD0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO08encodingD0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO011fileManagerD0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:11AssistantV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:11AssistantV14JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11AssistantV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/Assistant.html#/s:11AssistantV10A0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

Create a Assistant object.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a Assistant object.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a Assistant object.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C7messageySS11workspaceID_AA14MessageRequestVSg7requestSbSg19nodesVisitedDetailss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F8ResponseVc7successtF":{"name":"message(workspaceID:request:nodesVisitedDetails:headers:failure:success:)","abstract":"

Get response to user input.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C14listWorkspacesySiSg9pageLimit_SbSg12includeCountSSSg4sortAI6cursorAG0G5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA19WorkspaceCollectionVc7successtF":{"name":"listWorkspaces(pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List workspaces.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C15createWorkspaceyAA06CreateD0VSg10properties_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createWorkspace(properties:headers:failure:success:)","abstract":"

Create workspace.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12getWorkspaceySS11workspaceID_SbSg6exportAF12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getWorkspace(workspaceID:export:includeAudit:headers:failure:success:)","abstract":"

Get information about a workspace.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C15updateWorkspaceySS11workspaceID_AA06UpdateD0VSg10propertiesSbSg6appends10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateWorkspace(workspaceID:properties:append:headers:failure:success:)","abstract":"

Update workspace.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C15deleteWorkspaceySS11workspaceID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteWorkspace(workspaceID:headers:failure:success:)","abstract":"

Delete workspace.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11listIntentsySS11workspaceID_SbSg6exportSiSg9pageLimitAF12includeCountSSSg4sortAK6cursorAF0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA16IntentCollectionVc7successtF":{"name":"listIntents(workspaceID:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List intents.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12createIntentySS11workspaceID_SS6intentSSSg11descriptionSayAA13CreateExampleVGSg8exampless10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createIntent(workspaceID:intent:description:examples:headers:failure:success:)","abstract":"

Create intent.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C9getIntentySS11workspaceID_SS6intentSbSg6exportAG12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getIntent(workspaceID:intent:export:includeAudit:headers:failure:success:)","abstract":"

Get intent.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12updateIntentySS11workspaceID_SS6intentSSSg03newD0AG0H11DescriptionSayAA13CreateExampleVGSg0H8Exampless10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateIntent(workspaceID:intent:newIntent:newDescription:newExamples:headers:failure:success:)","abstract":"

Update intent.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12deleteIntentySS11workspaceID_SS6intents10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteIntent(workspaceID:intent:headers:failure:success:)","abstract":"

Delete intent.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12listExamplesySS11workspaceID_SS6intentSiSg9pageLimitSbSg12includeCountSSSg4sortAK6cursorAI0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA17ExampleCollectionVc7successtF":{"name":"listExamples(workspaceID:intent:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List user input examples.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13createExampleySS11workspaceID_SS6intentSS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createExample(workspaceID:intent:text:headers:failure:success:)","abstract":"

Create user input example.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C10getExampleySS11workspaceID_SS6intentSS4textSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getExample(workspaceID:intent:text:includeAudit:headers:failure:success:)","abstract":"

Get user input example.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13updateExampleySS11workspaceID_SS6intentSS4textSSSg7newTexts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateExample(workspaceID:intent:text:newText:headers:failure:success:)","abstract":"

Update user input example.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13deleteExampleySS11workspaceID_SS6intentSS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteExample(workspaceID:intent:text:headers:failure:success:)","abstract":"

Delete user input example.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C19listCounterexamplesySS11workspaceID_SiSg9pageLimitSbSg12includeCountSSSg4sortAJ6cursorAH0I5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA24CounterexampleCollectionVc7successtF":{"name":"listCounterexamples(workspaceID:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List counterexamples.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C20createCounterexampleySS11workspaceID_SS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createCounterexample(workspaceID:text:headers:failure:success:)","abstract":"

Create counterexample.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C17getCounterexampleySS11workspaceID_SS4textSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getCounterexample(workspaceID:text:includeAudit:headers:failure:success:)","abstract":"

Get counterexample.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C20updateCounterexampleySS11workspaceID_SS4textSSSg7newTexts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateCounterexample(workspaceID:text:newText:headers:failure:success:)","abstract":"

Update counterexample.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C20deleteCounterexampleySS11workspaceID_SS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteCounterexample(workspaceID:text:headers:failure:success:)","abstract":"

Delete counterexample.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12listEntitiesySS11workspaceID_SbSg6exportSiSg9pageLimitAF12includeCountSSSg4sortAK6cursorAF0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA16EntityCollectionVc7successtF":{"name":"listEntities(workspaceID:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entities.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12createEntityySS11workspaceID_AA06CreateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createEntity(workspaceID:properties:headers:failure:success:)","abstract":"

Create entity.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C9getEntityySS11workspaceID_SS6entitySbSg6exportAG12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getEntity(workspaceID:entity:export:includeAudit:headers:failure:success:)","abstract":"

Get entity.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12updateEntityySS11workspaceID_SS6entityAA06UpdateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateEntity(workspaceID:entity:properties:headers:failure:success:)","abstract":"

Update entity.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12deleteEntityySS11workspaceID_SS6entitys10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteEntity(workspaceID:entity:headers:failure:success:)","abstract":"

Delete entity.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C10listValuesySS11workspaceID_SS6entitySbSg6exportSiSg9pageLimitAG12includeCountSSSg4sortAL6cursorAG0K5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA15ValueCollectionVc7successtF":{"name":"listValues(workspaceID:entity:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entity values.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11createValueySS11workspaceID_SS6entityAA06CreateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createValue(workspaceID:entity:properties:headers:failure:success:)","abstract":"

Add entity value.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C8getValueySS11workspaceID_SS6entitySS5valueSbSg6exportAH12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getValue(workspaceID:entity:value:export:includeAudit:headers:failure:success:)","abstract":"

Get entity value.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11updateValueySS11workspaceID_SS6entitySS5valueAA06UpdateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateValue(workspaceID:entity:value:properties:headers:failure:success:)","abstract":"

Update entity value.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11deleteValueySS11workspaceID_SS6entitySS5values10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteValue(workspaceID:entity:value:headers:failure:success:)","abstract":"

Delete entity value.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C12listSynonymsySS11workspaceID_SS6entitySS5valueSiSg9pageLimitSbSg12includeCountSSSg4sortAL6cursorAJ0K5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA17SynonymCollectionVc7successtF":{"name":"listSynonyms(workspaceID:entity:value:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entity value synonyms.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13createSynonymySS11workspaceID_SS6entitySS5valueSS7synonyms10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createSynonym(workspaceID:entity:value:synonym:headers:failure:success:)","abstract":"

Add entity value synonym.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C10getSynonymySS11workspaceID_SS6entitySS5valueSS7synonymSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getSynonym(workspaceID:entity:value:synonym:includeAudit:headers:failure:success:)","abstract":"

Get entity value synonym.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13updateSynonymySS11workspaceID_SS6entitySS5valueSS7synonymSSSg03newD0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateSynonym(workspaceID:entity:value:synonym:newSynonym:headers:failure:success:)","abstract":"

Update entity value synonym.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13deleteSynonymySS11workspaceID_SS6entitySS5valueSS7synonyms10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteSynonym(workspaceID:entity:value:synonym:headers:failure:success:)","abstract":"

Delete entity value synonym.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C15listDialogNodesySS11workspaceID_SiSg9pageLimitSbSg12includeCountSSSg4sortAJ6cursorAH0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D14NodeCollectionVc7successtF":{"name":"listDialogNodes(workspaceID:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List dialog nodes.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C16createDialogNodeySS11workspaceID_AA06CreatedE0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"createDialogNode(workspaceID:properties:headers:failure:success:)","abstract":"

Create dialog node.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C13getDialogNodeySS11workspaceID_SS06dialogE0SbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"getDialogNode(workspaceID:dialogNode:includeAudit:headers:failure:success:)","abstract":"

Get dialog node.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C16updateDialogNodeySS11workspaceID_SS06dialogE0AA06UpdatedE0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"updateDialogNode(workspaceID:dialogNode:properties:headers:failure:success:)","abstract":"

Update dialog node.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C16deleteDialogNodeySS11workspaceID_SS06dialogE0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteDialogNode(workspaceID:dialogNode:headers:failure:success:)","abstract":"

Delete dialog node.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C8listLogsySS11workspaceID_SSSg4sortAF6filterSiSg9pageLimitAF6cursors10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA13LogCollectionVc7successtF":{"name":"listLogs(workspaceID:sort:filter:pageLimit:cursor:headers:failure:success:)","abstract":"

List log events in a workspace.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C11listAllLogsySS6filter_SSSg4sortSiSg9pageLimitAF6cursors10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA13LogCollectionVc7successtF":{"name":"listAllLogs(filter:sort:pageLimit:cursor:headers:failure:success:)","abstract":"

List log events in all workspaces.

","parent_name":"Assistant"},"Classes/Assistant.html#/s:11AssistantV10A0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

Delete labeled data.

","parent_name":"Assistant"},"Classes/Assistant.html":{"name":"Assistant","abstract":"

The IBM Watson™ Assistant service combines machine learning, natural language understanding, and integrated"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file diff --git a/docs/swift-api/services/AssistantV1/undocumented.json b/docs/swift-api/services/AssistantV1/undocumented.json index 71e57190d..e1793c6e9 100644 --- a/docs/swift-api/services/AssistantV1/undocumented.json +++ b/docs/swift-api/services/AssistantV1/undocumented.json @@ -9,700 +9,700 @@ }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 24, + "line": 26, "symbol": "CreateDialogNode.NodeType.standard", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 25, + "line": 27, "symbol": "CreateDialogNode.NodeType.eventHandler", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 26, + "line": 28, "symbol": "CreateDialogNode.NodeType.frame", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 27, + "line": 29, "symbol": "CreateDialogNode.NodeType.slot", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 28, + "line": 30, "symbol": "CreateDialogNode.NodeType.responseCondition", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 29, + "line": 31, "symbol": "CreateDialogNode.NodeType.folder", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 34, + "line": 38, "symbol": "CreateDialogNode.EventName.focus", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 35, + "line": 39, "symbol": "CreateDialogNode.EventName.input", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 36, + "line": 40, "symbol": "CreateDialogNode.EventName.filled", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 37, + "line": 41, "symbol": "CreateDialogNode.EventName.validate", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 38, + "line": 42, "symbol": "CreateDialogNode.EventName.filledMultiple", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 39, + "line": 43, "symbol": "CreateDialogNode.EventName.generic", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 40, + "line": 44, "symbol": "CreateDialogNode.EventName.nomatch", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 41, + "line": 45, "symbol": "CreateDialogNode.EventName.nomatchResponsesDepleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 42, + "line": 46, "symbol": "CreateDialogNode.EventName.digressionReturnPrompt", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 47, + "line": 53, "symbol": "CreateDialogNode.DigressIn.notAvailable", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 48, + "line": 54, "symbol": "CreateDialogNode.DigressIn.returns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 49, + "line": 55, "symbol": "CreateDialogNode.DigressIn.doesNotReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 54, + "line": 62, "symbol": "CreateDialogNode.DigressOut.returning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 55, + "line": 63, "symbol": "CreateDialogNode.DigressOut.all", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 56, + "line": 64, "symbol": "CreateDialogNode.DigressOut.allNeverReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 61, + "line": 71, "symbol": "CreateDialogNode.DigressOutSlots.notAllowed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 62, + "line": 72, "symbol": "CreateDialogNode.DigressOutSlots.allowReturning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 63, + "line": 73, "symbol": "CreateDialogNode.DigressOutSlots.allowAll", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateValue.swift", - "line": 24, + "line": 26, "symbol": "CreateValue.ValueType.synonyms", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateValue.swift", - "line": 25, + "line": 27, "symbol": "CreateValue.ValueType.patterns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 24, + "line": 26, "symbol": "DialogNode.NodeType.standard", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 25, + "line": 27, "symbol": "DialogNode.NodeType.eventHandler", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 26, + "line": 28, "symbol": "DialogNode.NodeType.frame", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 27, + "line": 29, "symbol": "DialogNode.NodeType.slot", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 28, + "line": 30, "symbol": "DialogNode.NodeType.responseCondition", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 29, + "line": 31, "symbol": "DialogNode.NodeType.folder", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 34, + "line": 38, "symbol": "DialogNode.EventName.focus", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 35, + "line": 39, "symbol": "DialogNode.EventName.input", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 36, + "line": 40, "symbol": "DialogNode.EventName.filled", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 37, + "line": 41, "symbol": "DialogNode.EventName.validate", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 38, + "line": 42, "symbol": "DialogNode.EventName.filledMultiple", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 39, + "line": 43, "symbol": "DialogNode.EventName.generic", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 40, + "line": 44, "symbol": "DialogNode.EventName.nomatch", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 41, + "line": 45, "symbol": "DialogNode.EventName.nomatchResponsesDepleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 42, + "line": 46, "symbol": "DialogNode.EventName.digressionReturnPrompt", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 47, + "line": 53, "symbol": "DialogNode.DigressIn.notAvailable", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 48, + "line": 54, "symbol": "DialogNode.DigressIn.returns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 49, + "line": 55, "symbol": "DialogNode.DigressIn.doesNotReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 54, + "line": 62, "symbol": "DialogNode.DigressOut.returning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 55, + "line": 63, "symbol": "DialogNode.DigressOut.all", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 56, + "line": 64, "symbol": "DialogNode.DigressOut.allNeverReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 61, + "line": 71, "symbol": "DialogNode.DigressOutSlots.notAllowed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 62, + "line": 72, "symbol": "DialogNode.DigressOutSlots.allowReturning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 63, + "line": 73, "symbol": "DialogNode.DigressOutSlots.allowAll", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeAction.swift", - "line": 24, + "line": 26, "symbol": "DialogNodeAction.ActionType.client", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeAction.swift", - "line": 25, + "line": 27, "symbol": "DialogNodeAction.ActionType.server", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeNextStep.swift", - "line": 24, + "line": 44, "symbol": "DialogNodeNextStep.Behavior.getUserInput", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeNextStep.swift", - "line": 25, + "line": 45, "symbol": "DialogNodeNextStep.Behavior.skipUserInput", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeNextStep.swift", - "line": 26, + "line": 46, "symbol": "DialogNodeNextStep.Behavior.jumpTo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeNextStep.swift", - "line": 27, + "line": 47, "symbol": "DialogNodeNextStep.Behavior.reprompt", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeNextStep.swift", - "line": 28, + "line": 48, "symbol": "DialogNodeNextStep.Behavior.skipSlot", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeNextStep.swift", - "line": 29, + "line": 49, "symbol": "DialogNodeNextStep.Behavior.skipAllSlots", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeNextStep.swift", - "line": 34, + "line": 56, "symbol": "DialogNodeNextStep.Selector.condition", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeNextStep.swift", - "line": 35, + "line": 57, "symbol": "DialogNodeNextStep.Selector.client", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeNextStep.swift", - "line": 36, + "line": 58, "symbol": "DialogNodeNextStep.Selector.userInput", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeNextStep.swift", - "line": 37, + "line": 59, "symbol": "DialogNodeNextStep.Selector.body", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/LogMessage.swift", - "line": 24, + "line": 26, "symbol": "LogMessage.Level.info", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/LogMessage.swift", - "line": 25, + "line": 27, "symbol": "LogMessage.Level.error", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/LogMessage.swift", - "line": 26, + "line": 28, "symbol": "LogMessage.Level.warn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 24, + "line": 26, "symbol": "UpdateDialogNode.NodeType.standard", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 25, + "line": 27, "symbol": "UpdateDialogNode.NodeType.eventHandler", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 26, + "line": 28, "symbol": "UpdateDialogNode.NodeType.frame", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 27, + "line": 29, "symbol": "UpdateDialogNode.NodeType.slot", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 28, + "line": 30, "symbol": "UpdateDialogNode.NodeType.responseCondition", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 29, + "line": 31, "symbol": "UpdateDialogNode.NodeType.folder", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 34, + "line": 38, "symbol": "UpdateDialogNode.EventName.focus", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 35, + "line": 39, "symbol": "UpdateDialogNode.EventName.input", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 36, + "line": 40, "symbol": "UpdateDialogNode.EventName.filled", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 37, + "line": 41, "symbol": "UpdateDialogNode.EventName.validate", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 38, + "line": 42, "symbol": "UpdateDialogNode.EventName.filledMultiple", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 39, + "line": 43, "symbol": "UpdateDialogNode.EventName.generic", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 40, + "line": 44, "symbol": "UpdateDialogNode.EventName.nomatch", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 41, + "line": 45, "symbol": "UpdateDialogNode.EventName.nomatchResponsesDepleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 42, + "line": 46, "symbol": "UpdateDialogNode.EventName.digressionReturnPrompt", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 47, + "line": 53, "symbol": "UpdateDialogNode.DigressIn.notAvailable", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 48, + "line": 54, "symbol": "UpdateDialogNode.DigressIn.returns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 49, + "line": 55, "symbol": "UpdateDialogNode.DigressIn.doesNotReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 54, + "line": 62, "symbol": "UpdateDialogNode.DigressOut.returning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 55, + "line": 63, "symbol": "UpdateDialogNode.DigressOut.all", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 56, + "line": 64, "symbol": "UpdateDialogNode.DigressOut.allNeverReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 61, + "line": 71, "symbol": "UpdateDialogNode.DigressOutSlots.notAllowed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 62, + "line": 72, "symbol": "UpdateDialogNode.DigressOutSlots.allowReturning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 63, + "line": 73, "symbol": "UpdateDialogNode.DigressOutSlots.allowAll", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateValue.swift", - "line": 24, + "line": 26, "symbol": "UpdateValue.ValueType.synonyms", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateValue.swift", - "line": 25, + "line": 27, "symbol": "UpdateValue.ValueType.patterns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/Value.swift", - "line": 24, + "line": 26, "symbol": "Value.ValueType.synonyms", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/Value.swift", - "line": 25, + "line": 27, "symbol": "Value.ValueType.patterns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/ValueExport.swift", - "line": 24, + "line": 26, "symbol": "ValueExport.ValueType.synonyms", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/ValueExport.swift", - "line": 25, + "line": 27, "symbol": "ValueExport.ValueType.patterns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/WorkspaceExport.swift", - "line": 24, + "line": 26, "symbol": "WorkspaceExport.Status.nonExistent", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/WorkspaceExport.swift", - "line": 25, + "line": 27, "symbol": "WorkspaceExport.Status.training", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/WorkspaceExport.swift", - "line": 26, + "line": 28, "symbol": "WorkspaceExport.Status.failed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/WorkspaceExport.swift", - "line": 27, + "line": 29, "symbol": "WorkspaceExport.Status.available", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/WorkspaceExport.swift", - "line": 28, + "line": 30, "symbol": "WorkspaceExport.Status.unavailable", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" diff --git a/docs/swift-api/services/ConversationV1/Classes.html b/docs/swift-api/services/ConversationV1/Classes.html index ffecc4358..d1f243138 100644 --- a/docs/swift-api/services/ConversationV1/Classes.html +++ b/docs/swift-api/services/ConversationV1/Classes.html @@ -170,9 +170,6 @@ - @@ -314,8 +311,8 @@

Classes

-

The IBM Watson Conversation service combines machine learning, natural language understanding, and integrated dialog -tools to create conversation flows between your apps and your users.

+

The IBM Watson™ Conversation service combines machine learning, natural language understanding, and integrated +dialog tools to create conversation flows between your apps and your users.

See more
@@ -336,7 +333,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Classes/Conversation.html b/docs/swift-api/services/ConversationV1/Classes/Conversation.html index fdec3a834..02f6c1a9f 100644 --- a/docs/swift-api/services/ConversationV1/Classes/Conversation.html +++ b/docs/swift-api/services/ConversationV1/Classes/Conversation.html @@ -170,9 +170,6 @@ - @@ -302,8 +299,8 @@

Conversation

-

The IBM Watson Conversation service combines machine learning, natural language understanding, and integrated dialog -tools to create conversation flows between your apps and your users.

+

The IBM Watson™ Conversation service combines machine learning, natural language understanding, and integrated +dialog tools to create conversation flows between your apps and your users.

@@ -606,7 +603,8 @@

Declaration

Get response to user input.

-

Get a response to a user’s input. There is no rate limit for this operation.

+

Get a response to a user’s input. +There is no rate limit for this operation.

@@ -647,8 +645,8 @@

Parameters

-

The message to be sent. This includes the user’s input, along with optional intents, entities, and context from the -last response.

+

The message to be sent. This includes the user’s input, along with optional intents, entities, and context from +the last response.

@@ -660,8 +658,8 @@

Parameters

-

Whether to include additional diagnostic information about the dialog nodes that were visited during processing of -the message.

+

Whether to include additional diagnostic information about the dialog nodes that were visited during processing +of the message.

@@ -722,8 +720,8 @@

Parameters

List workspaces.

-

List the workspaces associated with a Conversation service instance. This operation is limited to 500 requests -per 30 minutes. For more information, see Rate limiting.

+

List the workspaces associated with a Conversation service instance. +This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

@@ -865,8 +863,8 @@

Parameters

Create workspace.

Create a workspace based on component objects. You must provide workspace components defining the content of the -new workspace. This operation is limited to 30 requests per 30 minutes. For more information, see Rate -limiting.

+new workspace. +This operation is limited to 30 requests per 30 minutes. For more information, see Rate limiting.

@@ -893,8 +891,9 @@

Parameters

-

The content of the new workspace. The maximum size for this data is 50MB. If you need to import a larger -workspace, consider importing the workspace without intents and entities and then adding them separately.

+

The content of the new workspace. +The maximum size for this data is 50MB. If you need to import a larger workspace, consider importing the +workspace without intents and entities and then adding them separately.

@@ -955,9 +954,9 @@

Parameters

Get information about a workspace.

-

Get information about a workspace, optionally including all workspace content. With export=false, this -operation is limited to 6000 requests per 5 minutes. With export=true, the limit is 20 requests per 30 -minutes. For more information, see Rate limiting.

+

Get information about a workspace, optionally including all workspace content. +With export=false, this operation is limited to 6000 requests per 5 minutes. With export=true, the +limit is 20 requests per 30 minutes. For more information, see Rate limiting.

@@ -998,8 +997,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -1073,8 +1072,8 @@

Parameters

Update workspace.

Update an existing workspace with new or modified data. You must provide component objects defining the content of -the updated workspace. This operation is limited to 30 request per 30 minutes. For more information, see Rate -limiting.

+the updated workspace. +This operation is limited to 30 request per 30 minutes. For more information, see Rate limiting.

@@ -1115,9 +1114,9 @@

Parameters

-

Valid data defining the new and updated workspace content. The maximum size for this data is 50MB. If you need -to import a larger amount of workspace data, consider importing components such as intents and entities using -separate operations.

+

Valid data defining the new and updated workspace content. +The maximum size for this data is 50MB. If you need to import a larger amount of workspace data, consider +importing components such as intents and entities using separate operations.

@@ -1132,8 +1131,9 @@

Parameters

Whether the new data is to be appended to the existing data in the workspace. If append=false, elements included in the new data completely replace the corresponding existing elements, including all subelements. For example, if the new data includes entities and append=false, all existing entities in the workspace are -discarded and replaced with the new entities. If append=true, existing elements are preserved, and the new -elements are added. If any elements in the new data collide with existing elements, the update request fails.

+discarded and replaced with the new entities. +If append=true, existing elements are preserved, and the new elements are added. If any elements in the new +data collide with existing elements, the update request fails.

@@ -1194,8 +1194,8 @@

Parameters

Delete workspace.

-

Delete a workspace from the service instance. This operation is limited to 30 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete a workspace from the service instance. +This operation is limited to 30 requests per 30 minutes. For more information, see Rate limiting.

@@ -1283,9 +1283,9 @@

Parameters

List intents.

-

List the intents for a workspace. With export=false, this operation is limited to 2000 requests per 30 -minutes. With export=true, the limit is 400 requests per 30 minutes. For more information, see Rate -limiting.

+

List the intents for a workspace. +With export=false, this operation is limited to 2000 requests per 30 minutes. With export=true, the +limit is 400 requests per 30 minutes. For more information, see Rate limiting.

@@ -1330,8 +1330,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -1453,8 +1453,8 @@

Parameters

Create intent.

-

Create a new intent. This operation is limited to 2000 requests per 30 minutes. For more information, see Rate -limiting.

+

Create a new intent. +This operation is limited to 2000 requests per 30 minutes. For more information, see Rate limiting.

@@ -1496,9 +1496,13 @@

Parameters

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode -alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It -must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +

@@ -1510,8 +1514,8 @@

Parameters

-

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must -be no longer than 128 characters.

+

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -1584,9 +1588,9 @@

Parameters

Get intent.

-

Get information about an intent, optionally including all intent content. With export=false, this -operation is limited to 6000 requests per 5 minutes. With export=true, the limit is 400 requests per 30 -minutes. For more information, see Rate limiting.

+

Get information about an intent, optionally including all intent content. +With export=false, this operation is limited to 6000 requests per 5 minutes. With export=true, the +limit is 400 requests per 30 minutes. For more information, see Rate limiting.

@@ -1640,8 +1644,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -1715,8 +1719,8 @@

Parameters

Update intent.

Update an existing intent with new or modified data. You must provide component objects defining the content of the -updated intent. This operation is limited to 2000 requests per 30 minutes. For more information, see Rate -limiting.

+updated intent. +This operation is limited to 2000 requests per 30 minutes. For more information, see Rate limiting.

@@ -1771,9 +1775,13 @@

Parameters

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode -alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It -must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +

@@ -1858,8 +1866,8 @@

Parameters

Delete intent.

-

Delete an intent from a workspace. This operation is limited to 2000 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete an intent from a workspace. +This operation is limited to 2000 requests per 30 minutes. For more information, see Rate limiting.

@@ -1960,8 +1968,8 @@

Parameters

List user input examples.

-

List the user input examples for an intent. This operation is limited to 2500 requests per 30 minutes. For more -information, see Rate limiting.

+

List the user input examples for an intent. +This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

@@ -2128,8 +2136,8 @@

Parameters

Create user input example.

-

Add a new user input example to an intent. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Add a new user input example to an intent. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -2182,9 +2190,13 @@

Parameters

-

The text of a user input example. This string must conform to the following restrictions: - It cannot contain -carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no -longer than 1024 characters.

+

The text of a user input example. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +

@@ -2245,8 +2257,8 @@

Parameters

Get user input example.

-

Get information about a user input example. This operation is limited to 6000 requests per 5 minutes. For more -information, see Rate limiting.

+

Get information about a user input example. +This operation is limited to 6000 requests per 5 minutes. For more information, see Rate limiting.

@@ -2373,8 +2385,8 @@

Parameters

Update user input example.

-

Update the text of a user input example. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Update the text of a user input example. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -2440,9 +2452,13 @@

Parameters

-

The text of the user input example. This string must conform to the following restrictions: - It cannot contain -carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no -longer than 1024 characters.

+

The text of the user input example. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +

@@ -2503,8 +2519,8 @@

Parameters

Delete user input example.

-

Delete a user input example from an intent. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete a user input example from an intent. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -2619,7 +2635,7 @@

Parameters

List counterexamples.

List the counterexamples for a workspace. Counterexamples are examples that have been marked as irrelevant input. - This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

+This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

@@ -2814,9 +2830,13 @@

Parameters

-

The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It -cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It -must be no longer than 1024 characters.

+

The text of a user input marked as irrelevant input. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters
  • +
  • It cannot consist of only whitespace characters
  • +
  • It must be no longer than 1024 characters.
  • +

@@ -3108,7 +3128,7 @@

Parameters

Delete counterexample.

Delete a counterexample from a workspace. Counterexamples are examples that have been marked as irrelevant input. - This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

+This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -3209,9 +3229,9 @@

Parameters

List entities.

-

List the entities for a workspace. With export=false, this operation is limited to 1000 requests per 30 -minutes. With export=true, the limit is 200 requests per 30 minutes. For more information, see Rate -limiting.

+

List the entities for a workspace. +With export=false, this operation is limited to 1000 requests per 30 minutes. With export=true, the +limit is 200 requests per 30 minutes. For more information, see Rate limiting.

@@ -3256,8 +3276,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -3379,8 +3399,8 @@

Parameters

Create entity.

-

Create a new entity. This operation is limited to 1000 requests per 30 minutes. For more information, see Rate -limiting.

+

Create a new entity. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -3481,9 +3501,9 @@

Parameters

Get entity.

-

Get information about an entity, optionally including all entity content. With export=false, this -operation is limited to 6000 requests per 5 minutes. With export=true, the limit is 200 requests per 30 -minutes. For more information, see Rate limiting.

+

Get information about an entity, optionally including all entity content. +With export=false, this operation is limited to 6000 requests per 5 minutes. With export=true, the +limit is 200 requests per 30 minutes. For more information, see Rate limiting.

@@ -3537,8 +3557,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -3612,8 +3632,8 @@

Parameters

Update entity.

Update an existing entity with new or modified data. You must provide component objects defining the content of the -updated entity. This operation is limited to 1000 requests per 30 minutes. For more information, see Rate -limiting.

+updated entity. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -3668,8 +3688,8 @@

Parameters

The updated content of the entity. Any elements included in the new data will completely replace the equivalent existing elements, including all subelements. (Previously existing subelements are not retained unless they are -also included in the new data.) For example, if you update the values for an entity, the previously existing values -are discarded and replaced with the new values specified in the update.

+also included in the new data.) For example, if you update the values for an entity, the previously existing +values are discarded and replaced with the new values specified in the update.

@@ -3730,8 +3750,8 @@

Parameters

Delete entity.

-

Delete an entity from a workspace. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete an entity from a workspace. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -3832,8 +3852,8 @@

Parameters

List entity values.

-

List the values for an entity. This operation is limited to 2500 requests per 30 minutes. For more information, -see Rate limiting.

+

List the values for an entity. +This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

@@ -3891,8 +3911,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -4014,8 +4034,8 @@

Parameters

Add entity value.

-

Create a new value for an entity. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Create a new value for an entity. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -4129,8 +4149,8 @@

Parameters

Get entity value.

-

Get information about an entity value. This operation is limited to 6000 requests per 5 minutes. For more -information, see Rate limiting.

+

Get information about an entity value. +This operation is limited to 6000 requests per 5 minutes. For more information, see Rate limiting.

@@ -4197,8 +4217,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -4272,8 +4292,8 @@

Parameters

Update entity value.

Update an existing entity value with new or modified data. You must provide component objects defining the content -of the updated entity value. This operation is limited to 1000 requests per 30 minutes. For more information, -see Rate limiting.

+of the updated entity value. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -4339,10 +4359,11 @@

Parameters

-

The updated content of the entity value. Any elements included in the new data will completely replace the -equivalent existing elements, including all subelements. (Previously existing subelements are not retained unless -they are also included in the new data.) For example, if you update the synonyms for an entity value, the -previously existing synonyms are discarded and replaced with the new synonyms specified in the update.

+

The updated content of the entity value. +Any elements included in the new data will completely replace the equivalent existing elements, including all +subelements. (Previously existing subelements are not retained unless they are also included in the new data.) +For example, if you update the synonyms for an entity value, the previously existing synonyms are discarded and +replaced with the new synonyms specified in the update.

@@ -4403,8 +4424,8 @@

Parameters

Delete entity value.

-

Delete a value from an entity. This operation is limited to 1000 requests per 30 minutes. For more information, -see Rate limiting.

+

Delete a value from an entity. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -4518,8 +4539,8 @@

Parameters

List entity value synonyms.

-

List the synonyms for an entity value. This operation is limited to 2500 requests per 30 minutes. For more -information, see Rate limiting.

+

List the synonyms for an entity value. +This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

@@ -4699,8 +4720,8 @@

Parameters

Add entity value synonym.

-

Add a new synonym to an entity value. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Add a new synonym to an entity value. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -4766,9 +4787,13 @@

Parameters

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage -return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer -than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -4829,8 +4854,8 @@

Parameters

Get entity value synonym.

-

Get information about a synonym of an entity value. This operation is limited to 6000 requests per 5 minutes. -For more information, see Rate limiting.

+

Get information about a synonym of an entity value. +This operation is limited to 6000 requests per 5 minutes. For more information, see Rate limiting.

@@ -4970,8 +4995,8 @@

Parameters

Update entity value synonym.

-

Update an existing entity value synonym with new text. This operation is limited to 1000 requests per 30 -minutes. For more information, see Rate limiting.

+

Update an existing entity value synonym with new text. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -5050,9 +5075,13 @@

Parameters

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage -return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer -than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -5113,8 +5142,8 @@

Parameters

Delete entity value synonym.

-

Delete a synonym from an entity value. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete a synonym from an entity value. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -5241,8 +5270,8 @@

Parameters

List dialog nodes.

-

List the dialog nodes for a workspace. This operation is limited to 2500 requests per 30 minutes. For more -information, see Rate limiting.

+

List the dialog nodes for a workspace. +This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

@@ -5396,8 +5425,8 @@

Parameters

Create dialog node.

-

Create a new dialog node. This operation is limited to 500 requests per 30 minutes. For more information, see -Rate limiting.

+

Create a new dialog node. +This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

@@ -5498,8 +5527,8 @@

Parameters

Get dialog node.

-

Get information about a dialog node. This operation is limited to 6000 requests per 5 minutes. For more -information, see Rate limiting.

+

Get information about a dialog node. +This operation is limited to 6000 requests per 5 minutes. For more information, see Rate limiting.

@@ -5613,8 +5642,8 @@

Parameters

Update dialog node.

-

Update an existing dialog node with new or modified data. This operation is limited to 500 requests per 30 -minutes. For more information, see Rate limiting.

+

Update an existing dialog node with new or modified data. +This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

@@ -5667,10 +5696,11 @@

Parameters

-

The updated content of the dialog node. Any elements included in the new data will completely replace the -equivalent existing elements, including all subelements. (Previously existing subelements are not retained unless -they are also included in the new data.) For example, if you update the actions for a dialog node, the previously -existing actions are discarded and replaced with the new actions specified in the update.

+

The updated content of the dialog node. +Any elements included in the new data will completely replace the equivalent existing elements, including all +subelements. (Previously existing subelements are not retained unless they are also included in the new data.) +For example, if you update the actions for a dialog node, the previously existing actions are discarded and +replaced with the new actions specified in the update.

@@ -5731,8 +5761,8 @@

Parameters

Delete dialog node.

-

Delete a dialog node from a workspace. This operation is limited to 500 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete a dialog node from a workspace. +This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

@@ -5833,9 +5863,9 @@

Parameters

List log events in a workspace.

-

List the events from the log of a specific workspace. If cursor is not specified, this operation is limited -to 40 requests per 30 minutes. If cursor is specified, the limit is 120 requests per minute. For more -information, see Rate limiting.

+

List the events from the log of a specific workspace. +If cursor is not specified, this operation is limited to 40 requests per 30 minutes. If cursor is +specified, the limit is 120 requests per minute. For more information, see Rate limiting.

@@ -5891,7 +5921,8 @@

Parameters

-

A cacheable parameter that limits the results to those matching the specified filter. For more information, see the +

A cacheable parameter that limits the results to those matching the specified filter. For more information, see +the documentation.

@@ -5977,9 +6008,9 @@

Parameters

List log events in all workspaces.

-

List the events from the logs of all workspaces in the service instance. If cursor is not specified, this -operation is limited to 40 requests per 30 minutes. If cursor is specified, the limit is 120 requests per -minute. For more information, see Rate limiting.

+

List the events from the logs of all workspaces in the service instance. +If cursor is not specified, this operation is limited to 40 requests per 30 minutes. If cursor is +specified, the limit is 120 requests per minute. For more information, see Rate limiting.

@@ -6111,8 +6142,9 @@

Parameters

Delete labeled data.

Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with -the customer ID. You associate a customer ID with data by passing the X-Watson-Metadata header with a request -that passes data. For more information about personal data and customer IDs, see Information +the customer ID. +You associate a customer ID with data by passing the X-Watson-Metadata header with a request that passes data. +For more information about personal data and customer IDs, see Information security.

@@ -6191,7 +6223,7 @@

Parameters

diff --git a/docs/swift-api/services/ConversationV1/Enums.html b/docs/swift-api/services/ConversationV1/Enums.html index 7b5a5d7f6..057564c76 100644 --- a/docs/swift-api/services/ConversationV1/Enums.html +++ b/docs/swift-api/services/ConversationV1/Enums.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Enums/JSON.html b/docs/swift-api/services/ConversationV1/Enums/JSON.html index 99fe80c57..768b343cd 100644 --- a/docs/swift-api/services/ConversationV1/Enums/JSON.html +++ b/docs/swift-api/services/ConversationV1/Enums/JSON.html @@ -170,9 +170,6 @@ - @@ -636,7 +633,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Enums/RestError.html b/docs/swift-api/services/ConversationV1/Enums/RestError.html index 33c3fc03b..bce3d5ef8 100644 --- a/docs/swift-api/services/ConversationV1/Enums/RestError.html +++ b/docs/swift-api/services/ConversationV1/Enums/RestError.html @@ -170,9 +170,6 @@ - @@ -503,7 +500,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs.html b/docs/swift-api/services/ConversationV1/Structs.html index beb0bbd41..2fdb60370 100644 --- a/docs/swift-api/services/ConversationV1/Structs.html +++ b/docs/swift-api/services/ConversationV1/Structs.html @@ -170,9 +170,6 @@ - @@ -2027,49 +2024,10 @@

Declaration

-
-
- - - -

JSON

-
-
-
    -
  • -
    - - - - JSONWrapper - -
    -
    -
    -
    -
    -
    -

    Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct JSONWrapper
    - -
    -
    -
    -
    -
  • -
-
diff --git a/docs/swift-api/services/ConversationV1/Structs/CaptureGroup.html b/docs/swift-api/services/ConversationV1/Structs/CaptureGroup.html index 8869d7306..c5d177be4 100644 --- a/docs/swift-api/services/ConversationV1/Structs/CaptureGroup.html +++ b/docs/swift-api/services/ConversationV1/Structs/CaptureGroup.html @@ -170,9 +170,6 @@ - @@ -381,7 +378,10 @@

Declaration

Declaration

Swift

-
public init(group: String, location: [Int]? = nil)
+
public init(
+    group: String,
+    location: [Int]? = nil
+)
@@ -428,7 +428,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/Context.html b/docs/swift-api/services/ConversationV1/Structs/Context.html index dd06e423f..8d9186581 100644 --- a/docs/swift-api/services/ConversationV1/Structs/Context.html +++ b/docs/swift-api/services/ConversationV1/Structs/Context.html @@ -170,9 +170,6 @@ - @@ -408,7 +405,11 @@

Declaration

Declaration

Swift

-
public init(conversationID: String? = nil, system: SystemResponse? = nil, additionalProperties: [String: JSON] = [:])
+
public init(
+    conversationID: String? = nil,
+    system: SystemResponse? = nil,
+    additionalProperties: [String: JSON] = [:]
+)
@@ -507,7 +508,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/Counterexample.html b/docs/swift-api/services/ConversationV1/Structs/Counterexample.html index 8341abefd..8a17d1e73 100644 --- a/docs/swift-api/services/ConversationV1/Structs/Counterexample.html +++ b/docs/swift-api/services/ConversationV1/Structs/Counterexample.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/CounterexampleCollection.html b/docs/swift-api/services/ConversationV1/Structs/CounterexampleCollection.html index c30e511de..9abdf0b8c 100644 --- a/docs/swift-api/services/ConversationV1/Structs/CounterexampleCollection.html +++ b/docs/swift-api/services/ConversationV1/Structs/CounterexampleCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/CreateCounterexample.html b/docs/swift-api/services/ConversationV1/Structs/CreateCounterexample.html index 15a280847..e7a5d965c 100644 --- a/docs/swift-api/services/ConversationV1/Structs/CreateCounterexample.html +++ b/docs/swift-api/services/ConversationV1/Structs/CreateCounterexample.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

CreateCounterexample

-

The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It must be no longer than 1024 characters.

+

The text of a user input marked as irrelevant input. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters
  • +
  • It cannot consist of only whitespace characters
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -354,7 +357,9 @@

Declaration

Declaration

Swift

-
public init(text: String)
+
public init(
+    text: String
+)
@@ -370,7 +375,13 @@

Parameters

-

The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It must be no longer than 1024 characters.

+

The text of a user input marked as irrelevant input. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters
  • +
  • It cannot consist of only whitespace characters
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -389,7 +400,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode.html b/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode.html index cb396edf5..89b2d0f30 100644 --- a/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode.html +++ b/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode.html @@ -170,9 +170,6 @@ - @@ -460,7 +457,12 @@

Declaration

-

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

+

The dialog node ID. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -487,7 +489,8 @@

Declaration

-

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -514,7 +517,8 @@

Declaration

-

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab +characters, and it must be no longer than 2048 characters.

@@ -595,7 +599,8 @@

Declaration

-

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

+

The output of the dialog node. For more information about how to specify dialog node output, see the +documentation.

@@ -730,7 +735,12 @@

Declaration

-

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

+

The alias used to identify the dialog node. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -926,7 +936,25 @@

Declaration

Declaration

Swift

-
public init(dialogNode: String, description: String? = nil, conditions: String? = nil, parent: String? = nil, previousSibling: String? = nil, output: [String: JSON]? = nil, context: [String: JSON]? = nil, metadata: [String: JSON]? = nil, nextStep: DialogNodeNextStep? = nil, actions: [DialogNodeAction]? = nil, title: String? = nil, nodeType: String? = nil, eventName: String? = nil, variable: String? = nil, digressIn: String? = nil, digressOut: String? = nil, digressOutSlots: String? = nil)
+
public init(
+    dialogNode: String,
+    description: String? = nil,
+    conditions: String? = nil,
+    parent: String? = nil,
+    previousSibling: String? = nil,
+    output: [String: JSON]? = nil,
+    context: [String: JSON]? = nil,
+    metadata: [String: JSON]? = nil,
+    nextStep: DialogNodeNextStep? = nil,
+    actions: [DialogNodeAction]? = nil,
+    title: String? = nil,
+    nodeType: String? = nil,
+    eventName: String? = nil,
+    variable: String? = nil,
+    digressIn: String? = nil,
+    digressOut: String? = nil,
+    digressOutSlots: String? = nil
+)
@@ -942,7 +970,12 @@

Parameters

-

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

+

The dialog node ID. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 1024 characters.
  • +

@@ -954,7 +987,8 @@

Parameters

-

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and +it must be no longer than 128 characters.

@@ -966,7 +1000,8 @@

Parameters

-

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab +characters, and it must be no longer than 2048 characters.

@@ -1002,7 +1037,8 @@

Parameters

-

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

+

The output of the dialog node. For more information about how to specify dialog node output, see the +documentation.

@@ -1062,7 +1098,12 @@

Parameters

-

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

+

The alias used to identify the dialog node. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -1153,7 +1194,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode/DigressIn.html b/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode/DigressIn.html index 6c9926e30..e0424cba0 100644 --- a/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode/DigressIn.html +++ b/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode/DigressIn.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode/DigressOut.html b/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode/DigressOut.html index 938f924b8..f0586a98e 100644 --- a/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode/DigressOut.html +++ b/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode/DigressOut.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode/DigressOutSlots.html b/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode/DigressOutSlots.html index 25ab4ba1d..9366dc06a 100644 --- a/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode/DigressOutSlots.html +++ b/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode/DigressOutSlots.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode/EventName.html b/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode/EventName.html index b997af2bb..ff26e5bee 100644 --- a/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode/EventName.html +++ b/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode/EventName.html @@ -170,9 +170,6 @@ - @@ -555,7 +552,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode/NodeType.html b/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode/NodeType.html index b1d445fcf..cadd333d7 100644 --- a/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode/NodeType.html +++ b/docs/swift-api/services/ConversationV1/Structs/CreateDialogNode/NodeType.html @@ -170,9 +170,6 @@ - @@ -474,7 +471,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/CreateEntity.html b/docs/swift-api/services/ConversationV1/Structs/CreateEntity.html index 2138ec29c..44e00df3d 100644 --- a/docs/swift-api/services/ConversationV1/Structs/CreateEntity.html +++ b/docs/swift-api/services/ConversationV1/Structs/CreateEntity.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

CreateEntity

-

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

+

The name of the entity. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, underscore, and hyphen characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -347,7 +350,8 @@

Declaration

-

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must +be no longer than 128 characters.

@@ -462,7 +466,13 @@

Declaration

Declaration

Swift

-
public init(entity: String, description: String? = nil, metadata: [String: JSON]? = nil, values: [CreateValue]? = nil, fuzzyMatch: Bool? = nil)
+
public init(
+    entity: String,
+    description: String? = nil,
+    metadata: [String: JSON]? = nil,
+    values: [CreateValue]? = nil,
+    fuzzyMatch: Bool? = nil
+)
@@ -478,7 +488,13 @@

Parameters

-

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

+

The name of the entity. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, and hyphen characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -490,7 +506,8 @@

Parameters

-

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -545,7 +562,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/CreateExample.html b/docs/swift-api/services/ConversationV1/Structs/CreateExample.html index 5381a0643..50d261e6e 100644 --- a/docs/swift-api/services/ConversationV1/Structs/CreateExample.html +++ b/docs/swift-api/services/ConversationV1/Structs/CreateExample.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

CreateExample

-

The text of a user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

+

The text of a user input example. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -354,7 +357,9 @@

Declaration

Declaration

Swift

-
public init(text: String)
+
public init(
+    text: String
+)
@@ -370,7 +375,13 @@

Parameters

-

The text of a user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

+

The text of a user input example. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -389,7 +400,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/CreateIntent.html b/docs/swift-api/services/ConversationV1/Structs/CreateIntent.html index f09c322ae..7adf91b15 100644 --- a/docs/swift-api/services/ConversationV1/Structs/CreateIntent.html +++ b/docs/swift-api/services/ConversationV1/Structs/CreateIntent.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

CreateIntent

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +
@@ -347,7 +350,8 @@

Declaration

-

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must +be no longer than 128 characters.

@@ -408,7 +412,11 @@

Declaration

Declaration

Swift

-
public init(intent: String, description: String? = nil, examples: [CreateExample]? = nil)
+
public init(
+    intent: String,
+    description: String? = nil,
+    examples: [CreateExample]? = nil
+)
@@ -424,7 +432,13 @@

Parameters

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +

@@ -436,7 +450,8 @@

Parameters

-

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -467,7 +482,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/CreateSynonym.html b/docs/swift-api/services/ConversationV1/Structs/CreateSynonym.html index eace9051d..23d8026eb 100644 --- a/docs/swift-api/services/ConversationV1/Structs/CreateSynonym.html +++ b/docs/swift-api/services/ConversationV1/Structs/CreateSynonym.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

CreateSynonym

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -354,7 +357,9 @@

Declaration

Declaration

Swift

-
public init(synonym: String)
+
public init(
+    synonym: String
+)
@@ -370,7 +375,13 @@

Parameters

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -389,7 +400,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/CreateValue.html b/docs/swift-api/services/ConversationV1/Structs/CreateValue.html index e20b8e908..8bb07abfc 100644 --- a/docs/swift-api/services/ConversationV1/Structs/CreateValue.html +++ b/docs/swift-api/services/ConversationV1/Structs/CreateValue.html @@ -170,9 +170,6 @@ - @@ -348,7 +345,13 @@

Declaration

-

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the entity value. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -402,7 +405,14 @@

Declaration

-

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by +type), but not both. A synonym must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -429,7 +439,10 @@

Declaration

-

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

+

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), +but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to +specify a pattern, see the +documentation.

@@ -490,7 +503,13 @@

Declaration

Declaration

Swift

-
public init(value: String, metadata: [String: JSON]? = nil, synonyms: [String]? = nil, patterns: [String]? = nil, valueType: String? = nil)
+
public init(
+    value: String,
+    metadata: [String: JSON]? = nil,
+    synonyms: [String]? = nil,
+    patterns: [String]? = nil,
+    valueType: String? = nil
+)
@@ -506,7 +525,13 @@

Parameters

-

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the entity value. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -530,7 +555,14 @@

Parameters

-

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated +by type), but not both. A synonym must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -542,7 +574,10 @@

Parameters

-

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

+

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by +type), but not both. A pattern is a regular expression no longer than 128 characters. For more information +about how to specify a pattern, see the +documentation.

@@ -573,7 +608,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/CreateValue/ValueType.html b/docs/swift-api/services/ConversationV1/Structs/CreateValue/ValueType.html index 598570b8f..d475f9fc4 100644 --- a/docs/swift-api/services/ConversationV1/Structs/CreateValue/ValueType.html +++ b/docs/swift-api/services/ConversationV1/Structs/CreateValue/ValueType.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/CreateWorkspace.html b/docs/swift-api/services/ConversationV1/Structs/CreateWorkspace.html index 41a103170..38576f30e 100644 --- a/docs/swift-api/services/ConversationV1/Structs/CreateWorkspace.html +++ b/docs/swift-api/services/ConversationV1/Structs/CreateWorkspace.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,8 @@

CreateWorkspace

-

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

+

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be +no longer than 64 characters.

@@ -347,7 +345,8 @@

Declaration

-

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -536,7 +535,8 @@

Declaration

-

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that +workspace training data is not to be used.

@@ -570,7 +570,17 @@

Declaration

Declaration

Swift

-
public init(name: String? = nil, description: String? = nil, language: String? = nil, intents: [CreateIntent]? = nil, entities: [CreateEntity]? = nil, dialogNodes: [CreateDialogNode]? = nil, counterexamples: [CreateCounterexample]? = nil, metadata: [String: JSON]? = nil, learningOptOut: Bool? = nil)
+
public init(
+    name: String? = nil,
+    description: String? = nil,
+    language: String? = nil,
+    intents: [CreateIntent]? = nil,
+    entities: [CreateEntity]? = nil,
+    dialogNodes: [CreateDialogNode]? = nil,
+    counterexamples: [CreateCounterexample]? = nil,
+    metadata: [String: JSON]? = nil,
+    learningOptOut: Bool? = nil
+)
@@ -586,7 +596,8 @@

Parameters

-

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

+

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be +no longer than 64 characters.

@@ -598,7 +609,8 @@

Parameters

-

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -682,7 +694,8 @@

Parameters

-

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace can be used by IBM for general service improvements. true indicates +that workspace training data is not to be used.

@@ -701,7 +714,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/DialogNode.html b/docs/swift-api/services/ConversationV1/Structs/DialogNode.html index 1edb38424..360cdde57 100644 --- a/docs/swift-api/services/ConversationV1/Structs/DialogNode.html +++ b/docs/swift-api/services/ConversationV1/Structs/DialogNode.html @@ -170,9 +170,6 @@ - @@ -568,7 +565,8 @@

Declaration

-

The ID of the previous sibling dialog node. This property is not returned if the dialog node has no previous sibling.

+

The ID of the previous sibling dialog node. This property is not returned if the dialog node has no previous +sibling.

@@ -965,7 +963,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/DialogNode/DigressIn.html b/docs/swift-api/services/ConversationV1/Structs/DialogNode/DigressIn.html index fe8d86dad..db05038bb 100644 --- a/docs/swift-api/services/ConversationV1/Structs/DialogNode/DigressIn.html +++ b/docs/swift-api/services/ConversationV1/Structs/DialogNode/DigressIn.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/DialogNode/DigressOut.html b/docs/swift-api/services/ConversationV1/Structs/DialogNode/DigressOut.html index 9a629982c..feba14e6e 100644 --- a/docs/swift-api/services/ConversationV1/Structs/DialogNode/DigressOut.html +++ b/docs/swift-api/services/ConversationV1/Structs/DialogNode/DigressOut.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/DialogNode/DigressOutSlots.html b/docs/swift-api/services/ConversationV1/Structs/DialogNode/DigressOutSlots.html index 2dcc28528..fccb1ff6d 100644 --- a/docs/swift-api/services/ConversationV1/Structs/DialogNode/DigressOutSlots.html +++ b/docs/swift-api/services/ConversationV1/Structs/DialogNode/DigressOutSlots.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/DialogNode/EventName.html b/docs/swift-api/services/ConversationV1/Structs/DialogNode/EventName.html index 22f4e3ac6..88eae6c8b 100644 --- a/docs/swift-api/services/ConversationV1/Structs/DialogNode/EventName.html +++ b/docs/swift-api/services/ConversationV1/Structs/DialogNode/EventName.html @@ -170,9 +170,6 @@ - @@ -555,7 +552,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/DialogNode/NodeType.html b/docs/swift-api/services/ConversationV1/Structs/DialogNode/NodeType.html index 44b76d634..d5c0a3c5e 100644 --- a/docs/swift-api/services/ConversationV1/Structs/DialogNode/NodeType.html +++ b/docs/swift-api/services/ConversationV1/Structs/DialogNode/NodeType.html @@ -170,9 +170,6 @@ - @@ -474,7 +471,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/DialogNodeAction.html b/docs/swift-api/services/ConversationV1/Structs/DialogNodeAction.html index f65590d75..07a79e3dc 100644 --- a/docs/swift-api/services/ConversationV1/Structs/DialogNodeAction.html +++ b/docs/swift-api/services/ConversationV1/Structs/DialogNodeAction.html @@ -170,9 +170,6 @@ - @@ -490,7 +487,13 @@

Declaration

Declaration

Swift

-
public init(name: String, resultVariable: String, actionType: String? = nil, parameters: [String: JSON]? = nil, credentials: String? = nil)
+
public init(
+    name: String,
+    resultVariable: String,
+    actionType: String? = nil,
+    parameters: [String: JSON]? = nil,
+    credentials: String? = nil
+)
@@ -573,7 +576,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/DialogNodeAction/ActionType.html b/docs/swift-api/services/ConversationV1/Structs/DialogNodeAction/ActionType.html index 2e91c384e..8d74c8893 100644 --- a/docs/swift-api/services/ConversationV1/Structs/DialogNodeAction/ActionType.html +++ b/docs/swift-api/services/ConversationV1/Structs/DialogNodeAction/ActionType.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/DialogNodeCollection.html b/docs/swift-api/services/ConversationV1/Structs/DialogNodeCollection.html index ff02b036f..045b3a2e6 100644 --- a/docs/swift-api/services/ConversationV1/Structs/DialogNodeCollection.html +++ b/docs/swift-api/services/ConversationV1/Structs/DialogNodeCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/DialogNodeNextStep.html b/docs/swift-api/services/ConversationV1/Structs/DialogNodeNextStep.html index 53db04213..28926a82a 100644 --- a/docs/swift-api/services/ConversationV1/Structs/DialogNodeNextStep.html +++ b/docs/swift-api/services/ConversationV1/Structs/DialogNodeNextStep.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,40 @@

DialogNodeNextStep

-

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

+

What happens after the dialog node completes. The valid values depend on the node type:

+ +
    +
  • The following values are valid for any node: + +
      +
    • get_user_input
    • +
    • skip_user_input
    • +
    • jump_to
    • +
  • +
  • If the node is of type event_handler and its parent node is of type slot or frame, additional values are +also valid: + +
      +
    • if event_name=filled and the type of the parent node is slot:
    • +
    • reprompt
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=nomatch and the type of the parent node is slot: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=generic and the type of the parent node is frame: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots +If you specify jump_to, then you must also specify a value for the dialog_node property.
    • +
  • +
See more
@@ -376,7 +406,40 @@

Declaration

-

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

+

What happens after the dialog node completes. The valid values depend on the node type:

+ +
    +
  • The following values are valid for any node: + +
      +
    • get_user_input
    • +
    • skip_user_input
    • +
    • jump_to
    • +
  • +
  • If the node is of type event_handler and its parent node is of type slot or frame, additional values are +also valid: + +
      +
    • if event_name=filled and the type of the parent node is slot:
    • +
    • reprompt
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=nomatch and the type of the parent node is slot: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=generic and the type of the parent node is frame: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots +If you specify jump_to, then you must also specify a value for the dialog_node property.
    • +
  • +
@@ -464,7 +527,11 @@

Declaration

Declaration

Swift

-
public init(behavior: String, dialogNode: String? = nil, selector: String? = nil)
+
public init(
+    behavior: String,
+    dialogNode: String? = nil,
+    selector: String? = nil
+)
@@ -480,7 +547,37 @@

Parameters

-

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

+

What happens after the dialog node completes. The valid values depend on the node type: + +

    +
  • The following values are valid for any node:
  • +
  • get_user_input
  • +
  • skip_user_input
  • +
  • jump_to
  • +
  • If the node is of type event_handler and its parent node is of type slot or frame, additional values are +also valid:
  • +
  • if event_name=filled and the type of the parent node is slot: + +
      +
    • reprompt
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=nomatch and the type of the parent node is slot: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=generic and the type of the parent node is frame: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots +If you specify jump_to, then you must also specify a value for the dialog_node property.
    • +
  • +

@@ -523,7 +620,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/DialogNodeNextStep/Behavior.html b/docs/swift-api/services/ConversationV1/Structs/DialogNodeNextStep/Behavior.html index a08da9f3e..e77ab615c 100644 --- a/docs/swift-api/services/ConversationV1/Structs/DialogNodeNextStep/Behavior.html +++ b/docs/swift-api/services/ConversationV1/Structs/DialogNodeNextStep/Behavior.html @@ -170,9 +170,6 @@ - @@ -301,7 +298,40 @@

Behavior

-

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

+

What happens after the dialog node completes. The valid values depend on the node type:

+ +
    +
  • The following values are valid for any node: + +
      +
    • get_user_input
    • +
    • skip_user_input
    • +
    • jump_to
    • +
  • +
  • If the node is of type event_handler and its parent node is of type slot or frame, additional values are +also valid: + +
      +
    • if event_name=filled and the type of the parent node is slot:
    • +
    • reprompt
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=nomatch and the type of the parent node is slot: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=generic and the type of the parent node is frame: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots +If you specify jump_to, then you must also specify a value for the dialog_node property.
    • +
  • +
@@ -474,7 +504,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/DialogNodeNextStep/Selector.html b/docs/swift-api/services/ConversationV1/Structs/DialogNodeNextStep/Selector.html index f6028a0e3..01ad7fc78 100644 --- a/docs/swift-api/services/ConversationV1/Structs/DialogNodeNextStep/Selector.html +++ b/docs/swift-api/services/ConversationV1/Structs/DialogNodeNextStep/Selector.html @@ -170,9 +170,6 @@ - @@ -420,7 +417,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/DialogNodeVisitedDetails.html b/docs/swift-api/services/ConversationV1/Structs/DialogNodeVisitedDetails.html index 650c0b7ae..c5baeff1b 100644 --- a/docs/swift-api/services/ConversationV1/Structs/DialogNodeVisitedDetails.html +++ b/docs/swift-api/services/ConversationV1/Structs/DialogNodeVisitedDetails.html @@ -170,9 +170,6 @@ - @@ -408,7 +405,11 @@

Declaration

Declaration

Swift

-
public init(dialogNode: String? = nil, title: String? = nil, conditions: String? = nil)
+
public init(
+    dialogNode: String? = nil,
+    title: String? = nil,
+    conditions: String? = nil
+)
@@ -467,7 +468,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/Entity.html b/docs/swift-api/services/ConversationV1/Structs/Entity.html index 2bcb25997..5185ab722 100644 --- a/docs/swift-api/services/ConversationV1/Structs/Entity.html +++ b/docs/swift-api/services/ConversationV1/Structs/Entity.html @@ -170,9 +170,6 @@ - @@ -474,7 +471,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/EntityCollection.html b/docs/swift-api/services/ConversationV1/Structs/EntityCollection.html index 09b4808aa..a3a0b22fe 100644 --- a/docs/swift-api/services/ConversationV1/Structs/EntityCollection.html +++ b/docs/swift-api/services/ConversationV1/Structs/EntityCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/EntityExport.html b/docs/swift-api/services/ConversationV1/Structs/EntityExport.html index 2cf1b4a8f..60d44edad 100644 --- a/docs/swift-api/services/ConversationV1/Structs/EntityExport.html +++ b/docs/swift-api/services/ConversationV1/Structs/EntityExport.html @@ -170,9 +170,6 @@ - @@ -501,7 +498,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/Example.html b/docs/swift-api/services/ConversationV1/Structs/Example.html index 1a73e888c..7c70f61a7 100644 --- a/docs/swift-api/services/ConversationV1/Structs/Example.html +++ b/docs/swift-api/services/ConversationV1/Structs/Example.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/ExampleCollection.html b/docs/swift-api/services/ConversationV1/Structs/ExampleCollection.html index 3b9faa0df..189ffdf3a 100644 --- a/docs/swift-api/services/ConversationV1/Structs/ExampleCollection.html +++ b/docs/swift-api/services/ConversationV1/Structs/ExampleCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/InputData.html b/docs/swift-api/services/ConversationV1/Structs/InputData.html index 8581c9a61..3f87eedc6 100644 --- a/docs/swift-api/services/ConversationV1/Structs/InputData.html +++ b/docs/swift-api/services/ConversationV1/Structs/InputData.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,8 @@

InputData

-

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be +no longer than 2048 characters.

@@ -354,7 +352,9 @@

Declaration

Declaration

Swift

-
public init(text: String)
+
public init(
+    text: String
+)
@@ -370,7 +370,8 @@

Parameters

-

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must +be no longer than 2048 characters.

@@ -389,7 +390,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/Intent.html b/docs/swift-api/services/ConversationV1/Structs/Intent.html index 484a010f7..61f84d18a 100644 --- a/docs/swift-api/services/ConversationV1/Structs/Intent.html +++ b/docs/swift-api/services/ConversationV1/Structs/Intent.html @@ -170,9 +170,6 @@ - @@ -420,7 +417,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/IntentCollection.html b/docs/swift-api/services/ConversationV1/Structs/IntentCollection.html index 87e432f2f..776746738 100644 --- a/docs/swift-api/services/ConversationV1/Structs/IntentCollection.html +++ b/docs/swift-api/services/ConversationV1/Structs/IntentCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/IntentExport.html b/docs/swift-api/services/ConversationV1/Structs/IntentExport.html index 681f78b9b..dec0b82d5 100644 --- a/docs/swift-api/services/ConversationV1/Structs/IntentExport.html +++ b/docs/swift-api/services/ConversationV1/Structs/IntentExport.html @@ -170,9 +170,6 @@ - @@ -447,7 +444,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/LogCollection.html b/docs/swift-api/services/ConversationV1/Structs/LogCollection.html index fd16ed002..686a94636 100644 --- a/docs/swift-api/services/ConversationV1/Structs/LogCollection.html +++ b/docs/swift-api/services/ConversationV1/Structs/LogCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/LogExport.html b/docs/swift-api/services/ConversationV1/Structs/LogExport.html index 7980931b3..4544b6c7e 100644 --- a/docs/swift-api/services/ConversationV1/Structs/LogExport.html +++ b/docs/swift-api/services/ConversationV1/Structs/LogExport.html @@ -170,9 +170,6 @@ - @@ -501,7 +498,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/LogMessage.html b/docs/swift-api/services/ConversationV1/Structs/LogMessage.html index 0cf5346b0..587035ad1 100644 --- a/docs/swift-api/services/ConversationV1/Structs/LogMessage.html +++ b/docs/swift-api/services/ConversationV1/Structs/LogMessage.html @@ -170,9 +170,6 @@ - @@ -436,7 +433,11 @@

Declaration

Declaration

Swift

-
public init(level: String, msg: String, additionalProperties: [String: JSON] = [:])
+
public init(
+    level: String,
+    msg: String,
+    additionalProperties: [String: JSON] = [:]
+)
@@ -535,7 +536,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/LogMessage/Level.html b/docs/swift-api/services/ConversationV1/Structs/LogMessage/Level.html index d09ee4711..353992ba1 100644 --- a/docs/swift-api/services/ConversationV1/Structs/LogMessage/Level.html +++ b/docs/swift-api/services/ConversationV1/Structs/LogMessage/Level.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/LogPagination.html b/docs/swift-api/services/ConversationV1/Structs/LogPagination.html index e0b94465f..4a7fe67fb 100644 --- a/docs/swift-api/services/ConversationV1/Structs/LogPagination.html +++ b/docs/swift-api/services/ConversationV1/Structs/LogPagination.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/MessageInput.html b/docs/swift-api/services/ConversationV1/Structs/MessageInput.html index 3f31de773..51d20c603 100644 --- a/docs/swift-api/services/ConversationV1/Structs/MessageInput.html +++ b/docs/swift-api/services/ConversationV1/Structs/MessageInput.html @@ -170,9 +170,6 @@ - @@ -339,7 +336,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/MessageRequest.html b/docs/swift-api/services/ConversationV1/Structs/MessageRequest.html index 071a87ccc..7f073a932 100644 --- a/docs/swift-api/services/ConversationV1/Structs/MessageRequest.html +++ b/docs/swift-api/services/ConversationV1/Structs/MessageRequest.html @@ -170,9 +170,6 @@ - @@ -374,7 +371,8 @@

Declaration

-

State information for the conversation. Continue a conversation by including the context object from the previous response.

+

State information for the conversation. Continue a conversation by including the context object from the previous +response.

@@ -401,7 +399,8 @@

Declaration

-

Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input.

+

Entities to use when evaluating the message. Include entities from the previous response to continue using those +entities rather than detecting entities in the new input.

@@ -428,7 +427,8 @@

Declaration

-

Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input.

+

Intents to use when evaluating the user input. Include intents from the previous response to continue using those +intents rather than trying to recognize intents in the new input.

@@ -455,7 +455,8 @@

Declaration

-

System output. Include the output from the previous response to maintain intermediate information over multiple requests.

+

System output. Include the output from the previous response to maintain intermediate information over multiple +requests.

@@ -489,7 +490,14 @@

Declaration

Declaration

Swift

-
public init(input: InputData? = nil, alternateIntents: Bool? = nil, context: Context? = nil, entities: [RuntimeEntity]? = nil, intents: [RuntimeIntent]? = nil, output: OutputData? = nil)
+
public init(
+    input: InputData? = nil,
+    alternateIntents: Bool? = nil,
+    context: Context? = nil,
+    entities: [RuntimeEntity]? = nil,
+    intents: [RuntimeIntent]? = nil,
+    output: OutputData? = nil
+)
@@ -529,7 +537,8 @@

Parameters

-

State information for the conversation. Continue a conversation by including the context object from the previous response.

+

State information for the conversation. Continue a conversation by including the context object from the previous +response.

@@ -541,7 +550,8 @@

Parameters

-

Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input.

+

Entities to use when evaluating the message. Include entities from the previous response to continue using those +entities rather than detecting entities in the new input.

@@ -553,7 +563,8 @@

Parameters

-

Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input.

+

Intents to use when evaluating the user input. Include intents from the previous response to continue using those +intents rather than trying to recognize intents in the new input.

@@ -565,7 +576,8 @@

Parameters

-

System output. Include the output from the previous response to maintain intermediate information over multiple requests.

+

System output. Include the output from the previous response to maintain intermediate information over multiple +requests.

@@ -584,7 +596,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/MessageResponse.html b/docs/swift-api/services/ConversationV1/Structs/MessageResponse.html index 01dced1d5..00abd9a97 100644 --- a/docs/swift-api/services/ConversationV1/Structs/MessageResponse.html +++ b/docs/swift-api/services/ConversationV1/Structs/MessageResponse.html @@ -170,9 +170,6 @@ - @@ -527,7 +524,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/OutputData.html b/docs/swift-api/services/ConversationV1/Structs/OutputData.html index 6a6a14c9e..d86d50515 100644 --- a/docs/swift-api/services/ConversationV1/Structs/OutputData.html +++ b/docs/swift-api/services/ConversationV1/Structs/OutputData.html @@ -170,9 +170,6 @@ - @@ -374,7 +371,8 @@

Declaration

-

An array of the nodes that were triggered to create the response, in the order in which they were visited. This information is useful for debugging and for tracing the path taken through the node tree.

+

An array of the nodes that were triggered to create the response, in the order in which they were visited. This +information is useful for debugging and for tracing the path taken through the node tree.

@@ -401,7 +399,9 @@

Declaration

-

An array of objects containing detailed diagnostic information about the nodes that were triggered during processing of the input message. Included only if nodes_visited_details is set to true in the message request.

+

An array of objects containing detailed diagnostic information about the nodes that were triggered during +processing of the input message. Included only if nodes_visited_details is set to true in the message +request.

@@ -462,7 +462,13 @@

Declaration

Declaration

Swift

-
public init(logMessages: [LogMessage], text: [String], nodesVisited: [String]? = nil, nodesVisitedDetails: [DialogNodeVisitedDetails]? = nil, additionalProperties: [String: JSON] = [:])
+
public init(
+    logMessages: [LogMessage],
+    text: [String],
+    nodesVisited: [String]? = nil,
+    nodesVisitedDetails: [DialogNodeVisitedDetails]? = nil,
+    additionalProperties: [String: JSON] = [:]
+)
@@ -502,7 +508,8 @@

Parameters

-

An array of the nodes that were triggered to create the response, in the order in which they were visited. This information is useful for debugging and for tracing the path taken through the node tree.

+

An array of the nodes that were triggered to create the response, in the order in which they were visited. This +information is useful for debugging and for tracing the path taken through the node tree.

@@ -514,7 +521,9 @@

Parameters

-

An array of objects containing detailed diagnostic information about the nodes that were triggered during processing of the input message. Included only if nodes_visited_details is set to true in the message request.

+

An array of objects containing detailed diagnostic information about the nodes that were triggered during +processing of the input message. Included only if nodes_visited_details is set to true in the message +request.

@@ -585,7 +594,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/Pagination.html b/docs/swift-api/services/ConversationV1/Structs/Pagination.html index 3b2a5ae43..c0c7c4b0b 100644 --- a/docs/swift-api/services/ConversationV1/Structs/Pagination.html +++ b/docs/swift-api/services/ConversationV1/Structs/Pagination.html @@ -170,9 +170,6 @@ - @@ -474,7 +471,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/RuntimeEntity.html b/docs/swift-api/services/ConversationV1/Structs/RuntimeEntity.html index 2de743830..d90509a30 100644 --- a/docs/swift-api/services/ConversationV1/Structs/RuntimeEntity.html +++ b/docs/swift-api/services/ConversationV1/Structs/RuntimeEntity.html @@ -170,9 +170,6 @@ - @@ -347,7 +344,8 @@

Declaration

-

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text.

+

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input +text.

@@ -516,7 +514,15 @@

Declaration

Declaration

Swift

-
public init(entity: String, location: [Int], value: String, confidence: Double? = nil, metadata: [String: JSON]? = nil, groups: [CaptureGroup]? = nil, additionalProperties: [String: JSON] = [:])
+
public init(
+    entity: String,
+    location: [Int],
+    value: String,
+    confidence: Double? = nil,
+    metadata: [String: JSON]? = nil,
+    groups: [CaptureGroup]? = nil,
+    additionalProperties: [String: JSON] = [:]
+)
@@ -544,7 +550,8 @@

Parameters

-

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text.

+

An array of zero-based character offsets that indicate where the detected entity values begin and end in the +input text.

@@ -663,7 +670,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/RuntimeIntent.html b/docs/swift-api/services/ConversationV1/Structs/RuntimeIntent.html index 6041e73ca..db1a0a199 100644 --- a/docs/swift-api/services/ConversationV1/Structs/RuntimeIntent.html +++ b/docs/swift-api/services/ConversationV1/Structs/RuntimeIntent.html @@ -170,9 +170,6 @@ - @@ -408,7 +405,11 @@

Declaration

Declaration

Swift

-
public init(intent: String, confidence: Double, additionalProperties: [String: JSON] = [:])
+
public init(
+    intent: String,
+    confidence: Double,
+    additionalProperties: [String: JSON] = [:]
+)
@@ -507,7 +508,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/Synonym.html b/docs/swift-api/services/ConversationV1/Structs/Synonym.html index a6dee1510..b273a9b25 100644 --- a/docs/swift-api/services/ConversationV1/Structs/Synonym.html +++ b/docs/swift-api/services/ConversationV1/Structs/Synonym.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/SynonymCollection.html b/docs/swift-api/services/ConversationV1/Structs/SynonymCollection.html index 123c82044..afb630716 100644 --- a/docs/swift-api/services/ConversationV1/Structs/SynonymCollection.html +++ b/docs/swift-api/services/ConversationV1/Structs/SynonymCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/SystemResponse.html b/docs/swift-api/services/ConversationV1/Structs/SystemResponse.html index aba2cf8bd..cc4ddfd75 100644 --- a/docs/swift-api/services/ConversationV1/Structs/SystemResponse.html +++ b/docs/swift-api/services/ConversationV1/Structs/SystemResponse.html @@ -170,9 +170,6 @@ - @@ -354,7 +351,9 @@

Declaration

Declaration

Swift

-
public init(additionalProperties: [String: JSON] = [:])
+
public init(
+    additionalProperties: [String: JSON] = [:]
+)
@@ -422,7 +421,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/UpdateCounterexample.html b/docs/swift-api/services/ConversationV1/Structs/UpdateCounterexample.html index c58ec5ef6..73faba268 100644 --- a/docs/swift-api/services/ConversationV1/Structs/UpdateCounterexample.html +++ b/docs/swift-api/services/ConversationV1/Structs/UpdateCounterexample.html @@ -170,9 +170,6 @@ - @@ -354,7 +351,9 @@

Declaration

Declaration

Swift

-
public init(text: String? = nil)
+
public init(
+    text: String? = nil
+)
@@ -389,7 +388,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode.html b/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode.html index 0f6a4e450..00cd7daca 100644 --- a/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode.html +++ b/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode.html @@ -170,9 +170,6 @@ - @@ -460,7 +457,12 @@

Declaration

-

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

+

The dialog node ID. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -487,7 +489,8 @@

Declaration

-

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -514,7 +517,8 @@

Declaration

-

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab +characters, and it must be no longer than 2048 characters.

@@ -595,7 +599,8 @@

Declaration

-

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

+

The output of the dialog node. For more information about how to specify dialog node output, see the +documentation.

@@ -703,7 +708,12 @@

Declaration

-

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

+

The alias used to identify the dialog node. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -926,7 +936,25 @@

Declaration

Declaration

Swift

-
public init(dialogNode: String? = nil, description: String? = nil, conditions: String? = nil, parent: String? = nil, previousSibling: String? = nil, output: [String: JSON]? = nil, context: [String: JSON]? = nil, metadata: [String: JSON]? = nil, nextStep: DialogNodeNextStep? = nil, title: String? = nil, nodeType: String? = nil, eventName: String? = nil, variable: String? = nil, actions: [DialogNodeAction]? = nil, digressIn: String? = nil, digressOut: String? = nil, digressOutSlots: String? = nil)
+
public init(
+    dialogNode: String? = nil,
+    description: String? = nil,
+    conditions: String? = nil,
+    parent: String? = nil,
+    previousSibling: String? = nil,
+    output: [String: JSON]? = nil,
+    context: [String: JSON]? = nil,
+    metadata: [String: JSON]? = nil,
+    nextStep: DialogNodeNextStep? = nil,
+    title: String? = nil,
+    nodeType: String? = nil,
+    eventName: String? = nil,
+    variable: String? = nil,
+    actions: [DialogNodeAction]? = nil,
+    digressIn: String? = nil,
+    digressOut: String? = nil,
+    digressOutSlots: String? = nil
+)
@@ -942,7 +970,12 @@

Parameters

-

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

+

The dialog node ID. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 1024 characters.
  • +

@@ -954,7 +987,8 @@

Parameters

-

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and +it must be no longer than 128 characters.

@@ -966,7 +1000,8 @@

Parameters

-

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab +characters, and it must be no longer than 2048 characters.

@@ -1002,7 +1037,8 @@

Parameters

-

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

+

The output of the dialog node. For more information about how to specify dialog node output, see the +documentation.

@@ -1050,7 +1086,12 @@

Parameters

-

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

+

The alias used to identify the dialog node. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -1153,7 +1194,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode/DigressIn.html b/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode/DigressIn.html index f1523f52f..df4fd277f 100644 --- a/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode/DigressIn.html +++ b/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode/DigressIn.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode/DigressOut.html b/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode/DigressOut.html index 0a9cc93a4..39e8be11f 100644 --- a/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode/DigressOut.html +++ b/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode/DigressOut.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode/DigressOutSlots.html b/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode/DigressOutSlots.html index 8cbe1ed62..315e59834 100644 --- a/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode/DigressOutSlots.html +++ b/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode/DigressOutSlots.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode/EventName.html b/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode/EventName.html index 3aa4d3476..c4e9bcf08 100644 --- a/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode/EventName.html +++ b/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode/EventName.html @@ -170,9 +170,6 @@ - @@ -555,7 +552,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode/NodeType.html b/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode/NodeType.html index 62a5ffdfc..745c8a7db 100644 --- a/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode/NodeType.html +++ b/docs/swift-api/services/ConversationV1/Structs/UpdateDialogNode/NodeType.html @@ -170,9 +170,6 @@ - @@ -474,7 +471,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/UpdateEntity.html b/docs/swift-api/services/ConversationV1/Structs/UpdateEntity.html index 5970979db..75eb23210 100644 --- a/docs/swift-api/services/ConversationV1/Structs/UpdateEntity.html +++ b/docs/swift-api/services/ConversationV1/Structs/UpdateEntity.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

UpdateEntity

-

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

+

The name of the entity. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, underscore, and hyphen characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -347,7 +350,8 @@

Declaration

-

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must +be no longer than 128 characters.

@@ -462,7 +466,13 @@

Declaration

Declaration

Swift

-
public init(entity: String? = nil, description: String? = nil, metadata: [String: JSON]? = nil, fuzzyMatch: Bool? = nil, values: [CreateValue]? = nil)
+
public init(
+    entity: String? = nil,
+    description: String? = nil,
+    metadata: [String: JSON]? = nil,
+    fuzzyMatch: Bool? = nil,
+    values: [CreateValue]? = nil
+)
@@ -478,7 +488,13 @@

Parameters

-

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

+

The name of the entity. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, and hyphen characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -490,7 +506,8 @@

Parameters

-

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -545,7 +562,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/UpdateExample.html b/docs/swift-api/services/ConversationV1/Structs/UpdateExample.html index 28331be68..38e421ebc 100644 --- a/docs/swift-api/services/ConversationV1/Structs/UpdateExample.html +++ b/docs/swift-api/services/ConversationV1/Structs/UpdateExample.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

UpdateExample

-

The text of the user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

+

The text of the user input example. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -354,7 +357,9 @@

Declaration

Declaration

Swift

-
public init(text: String? = nil)
+
public init(
+    text: String? = nil
+)
@@ -370,7 +375,13 @@

Parameters

-

The text of the user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

+

The text of the user input example. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -389,7 +400,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/UpdateIntent.html b/docs/swift-api/services/ConversationV1/Structs/UpdateIntent.html index 5bb9e7c29..872a0dc13 100644 --- a/docs/swift-api/services/ConversationV1/Structs/UpdateIntent.html +++ b/docs/swift-api/services/ConversationV1/Structs/UpdateIntent.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

UpdateIntent

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +
@@ -408,7 +411,11 @@

Declaration

Declaration

Swift

-
public init(intent: String? = nil, description: String? = nil, examples: [CreateExample]? = nil)
+
public init(
+    intent: String? = nil,
+    description: String? = nil,
+    examples: [CreateExample]? = nil
+)
@@ -424,7 +431,13 @@

Parameters

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +

@@ -467,7 +480,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/UpdateSynonym.html b/docs/swift-api/services/ConversationV1/Structs/UpdateSynonym.html index f1184b586..efb65b2cb 100644 --- a/docs/swift-api/services/ConversationV1/Structs/UpdateSynonym.html +++ b/docs/swift-api/services/ConversationV1/Structs/UpdateSynonym.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

UpdateSynonym

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -354,7 +357,9 @@

Declaration

Declaration

Swift

-
public init(synonym: String? = nil)
+
public init(
+    synonym: String? = nil
+)
@@ -370,7 +375,13 @@

Parameters

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -389,7 +400,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/UpdateValue.html b/docs/swift-api/services/ConversationV1/Structs/UpdateValue.html index 20ba42b85..8027b6ea4 100644 --- a/docs/swift-api/services/ConversationV1/Structs/UpdateValue.html +++ b/docs/swift-api/services/ConversationV1/Structs/UpdateValue.html @@ -170,9 +170,6 @@ - @@ -348,7 +345,13 @@

Declaration

-

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the entity value. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -429,7 +432,14 @@

Declaration

-

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following resrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), +but not both. A synonym must conform to the following resrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -456,7 +466,10 @@

Declaration

-

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

+

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), +but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to +specify a pattern, see the +documentation.

@@ -490,7 +503,13 @@

Declaration

Declaration

Swift

-
public init(value: String? = nil, metadata: [String: JSON]? = nil, valueType: String? = nil, synonyms: [String]? = nil, patterns: [String]? = nil)
+
public init(
+    value: String? = nil,
+    metadata: [String: JSON]? = nil,
+    valueType: String? = nil,
+    synonyms: [String]? = nil,
+    patterns: [String]? = nil
+)
@@ -506,7 +525,13 @@

Parameters

-

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the entity value. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -542,7 +567,14 @@

Parameters

-

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following resrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by +type), but not both. A synonym must conform to the following resrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -554,7 +586,10 @@

Parameters

-

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

+

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by +type), but not both. A pattern is a regular expression no longer than 128 characters. For more information +about how to specify a pattern, see the +documentation.

@@ -573,7 +608,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/UpdateValue/ValueType.html b/docs/swift-api/services/ConversationV1/Structs/UpdateValue/ValueType.html index 50e7c99d2..260763d1b 100644 --- a/docs/swift-api/services/ConversationV1/Structs/UpdateValue/ValueType.html +++ b/docs/swift-api/services/ConversationV1/Structs/UpdateValue/ValueType.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/UpdateWorkspace.html b/docs/swift-api/services/ConversationV1/Structs/UpdateWorkspace.html index 1c7932f7c..8978a25b7 100644 --- a/docs/swift-api/services/ConversationV1/Structs/UpdateWorkspace.html +++ b/docs/swift-api/services/ConversationV1/Structs/UpdateWorkspace.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,8 @@

UpdateWorkspace

-

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

+

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be +no longer than 64 characters.

@@ -347,7 +345,8 @@

Declaration

-

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -536,7 +535,8 @@

Declaration

-

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that +workspace training data is not to be used.

@@ -570,7 +570,17 @@

Declaration

Declaration

Swift

-
public init(name: String? = nil, description: String? = nil, language: String? = nil, intents: [CreateIntent]? = nil, entities: [CreateEntity]? = nil, dialogNodes: [CreateDialogNode]? = nil, counterexamples: [CreateCounterexample]? = nil, metadata: [String: JSON]? = nil, learningOptOut: Bool? = nil)
+
public init(
+    name: String? = nil,
+    description: String? = nil,
+    language: String? = nil,
+    intents: [CreateIntent]? = nil,
+    entities: [CreateEntity]? = nil,
+    dialogNodes: [CreateDialogNode]? = nil,
+    counterexamples: [CreateCounterexample]? = nil,
+    metadata: [String: JSON]? = nil,
+    learningOptOut: Bool? = nil
+)
@@ -586,7 +596,8 @@

Parameters

-

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

+

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be +no longer than 64 characters.

@@ -598,7 +609,8 @@

Parameters

-

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -682,7 +694,8 @@

Parameters

-

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace can be used by IBM for general service improvements. true indicates +that workspace training data is not to be used.

@@ -701,7 +714,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/Structs/Value.html b/docs/swift-api/services/ConversationV1/Structs/Value.html index e27241820..3b252eebb 100644 --- a/docs/swift-api/services/ConversationV1/Structs/Value.html +++ b/docs/swift-api/services/ConversationV1/Structs/Value.html @@ -170,9 +170,6 @@ - @@ -529,7 +526,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/Value/ValueType.html b/docs/swift-api/services/ConversationV1/Structs/Value/ValueType.html index 44b51b27a..94e038445 100644 --- a/docs/swift-api/services/ConversationV1/Structs/Value/ValueType.html +++ b/docs/swift-api/services/ConversationV1/Structs/Value/ValueType.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/ValueCollection.html b/docs/swift-api/services/ConversationV1/Structs/ValueCollection.html index 0278251db..3b252c9aa 100644 --- a/docs/swift-api/services/ConversationV1/Structs/ValueCollection.html +++ b/docs/swift-api/services/ConversationV1/Structs/ValueCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/ValueExport.html b/docs/swift-api/services/ConversationV1/Structs/ValueExport.html index f8c60976b..b512650ef 100644 --- a/docs/swift-api/services/ConversationV1/Structs/ValueExport.html +++ b/docs/swift-api/services/ConversationV1/Structs/ValueExport.html @@ -170,9 +170,6 @@ - @@ -529,7 +526,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/ValueExport/ValueType.html b/docs/swift-api/services/ConversationV1/Structs/ValueExport/ValueType.html index d319cbee7..692041aa8 100644 --- a/docs/swift-api/services/ConversationV1/Structs/ValueExport/ValueType.html +++ b/docs/swift-api/services/ConversationV1/Structs/ValueExport/ValueType.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/Workspace.html b/docs/swift-api/services/ConversationV1/Structs/Workspace.html index d6661642f..bb19ded75 100644 --- a/docs/swift-api/services/ConversationV1/Structs/Workspace.html +++ b/docs/swift-api/services/ConversationV1/Structs/Workspace.html @@ -170,9 +170,6 @@ - @@ -509,7 +506,8 @@

Declaration

-

Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for +general service improvements. true indicates that workspace training data is not to be used.

@@ -528,7 +526,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/WorkspaceCollection.html b/docs/swift-api/services/ConversationV1/Structs/WorkspaceCollection.html index d783897e1..47c4c1a79 100644 --- a/docs/swift-api/services/ConversationV1/Structs/WorkspaceCollection.html +++ b/docs/swift-api/services/ConversationV1/Structs/WorkspaceCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/WorkspaceExport.html b/docs/swift-api/services/ConversationV1/Structs/WorkspaceExport.html index c560ec20e..4cf6565a6 100644 --- a/docs/swift-api/services/ConversationV1/Structs/WorkspaceExport.html +++ b/docs/swift-api/services/ConversationV1/Structs/WorkspaceExport.html @@ -170,9 +170,6 @@ - @@ -564,7 +561,8 @@

Declaration

-

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that +workspace training data is not to be used.

@@ -691,7 +689,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/Structs/WorkspaceExport/Status.html b/docs/swift-api/services/ConversationV1/Structs/WorkspaceExport/Status.html index 6919958f8..8570a6345 100644 --- a/docs/swift-api/services/ConversationV1/Structs/WorkspaceExport/Status.html +++ b/docs/swift-api/services/ConversationV1/Structs/WorkspaceExport/Status.html @@ -170,9 +170,6 @@ - @@ -447,7 +444,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Classes.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Classes.html index ffecc4358..d1f243138 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Classes.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Classes.html @@ -170,9 +170,6 @@ - @@ -314,8 +311,8 @@

Classes

-

The IBM Watson Conversation service combines machine learning, natural language understanding, and integrated dialog -tools to create conversation flows between your apps and your users.

+

The IBM Watson™ Conversation service combines machine learning, natural language understanding, and integrated +dialog tools to create conversation flows between your apps and your users.

See more
@@ -336,7 +333,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Classes/Conversation.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Classes/Conversation.html index fdec3a834..02f6c1a9f 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Classes/Conversation.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Classes/Conversation.html @@ -170,9 +170,6 @@ - @@ -302,8 +299,8 @@

Conversation

-

The IBM Watson Conversation service combines machine learning, natural language understanding, and integrated dialog -tools to create conversation flows between your apps and your users.

+

The IBM Watson™ Conversation service combines machine learning, natural language understanding, and integrated +dialog tools to create conversation flows between your apps and your users.

@@ -606,7 +603,8 @@

Declaration

Get response to user input.

-

Get a response to a user’s input. There is no rate limit for this operation.

+

Get a response to a user’s input. +There is no rate limit for this operation.

@@ -647,8 +645,8 @@

Parameters

-

The message to be sent. This includes the user’s input, along with optional intents, entities, and context from the -last response.

+

The message to be sent. This includes the user’s input, along with optional intents, entities, and context from +the last response.

@@ -660,8 +658,8 @@

Parameters

-

Whether to include additional diagnostic information about the dialog nodes that were visited during processing of -the message.

+

Whether to include additional diagnostic information about the dialog nodes that were visited during processing +of the message.

@@ -722,8 +720,8 @@

Parameters

List workspaces.

-

List the workspaces associated with a Conversation service instance. This operation is limited to 500 requests -per 30 minutes. For more information, see Rate limiting.

+

List the workspaces associated with a Conversation service instance. +This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

@@ -865,8 +863,8 @@

Parameters

Create workspace.

Create a workspace based on component objects. You must provide workspace components defining the content of the -new workspace. This operation is limited to 30 requests per 30 minutes. For more information, see Rate -limiting.

+new workspace. +This operation is limited to 30 requests per 30 minutes. For more information, see Rate limiting.

@@ -893,8 +891,9 @@

Parameters

-

The content of the new workspace. The maximum size for this data is 50MB. If you need to import a larger -workspace, consider importing the workspace without intents and entities and then adding them separately.

+

The content of the new workspace. +The maximum size for this data is 50MB. If you need to import a larger workspace, consider importing the +workspace without intents and entities and then adding them separately.

@@ -955,9 +954,9 @@

Parameters

Get information about a workspace.

-

Get information about a workspace, optionally including all workspace content. With export=false, this -operation is limited to 6000 requests per 5 minutes. With export=true, the limit is 20 requests per 30 -minutes. For more information, see Rate limiting.

+

Get information about a workspace, optionally including all workspace content. +With export=false, this operation is limited to 6000 requests per 5 minutes. With export=true, the +limit is 20 requests per 30 minutes. For more information, see Rate limiting.

@@ -998,8 +997,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -1073,8 +1072,8 @@

Parameters

Update workspace.

Update an existing workspace with new or modified data. You must provide component objects defining the content of -the updated workspace. This operation is limited to 30 request per 30 minutes. For more information, see Rate -limiting.

+the updated workspace. +This operation is limited to 30 request per 30 minutes. For more information, see Rate limiting.

@@ -1115,9 +1114,9 @@

Parameters

-

Valid data defining the new and updated workspace content. The maximum size for this data is 50MB. If you need -to import a larger amount of workspace data, consider importing components such as intents and entities using -separate operations.

+

Valid data defining the new and updated workspace content. +The maximum size for this data is 50MB. If you need to import a larger amount of workspace data, consider +importing components such as intents and entities using separate operations.

@@ -1132,8 +1131,9 @@

Parameters

Whether the new data is to be appended to the existing data in the workspace. If append=false, elements included in the new data completely replace the corresponding existing elements, including all subelements. For example, if the new data includes entities and append=false, all existing entities in the workspace are -discarded and replaced with the new entities. If append=true, existing elements are preserved, and the new -elements are added. If any elements in the new data collide with existing elements, the update request fails.

+discarded and replaced with the new entities. +If append=true, existing elements are preserved, and the new elements are added. If any elements in the new +data collide with existing elements, the update request fails.

@@ -1194,8 +1194,8 @@

Parameters

Delete workspace.

-

Delete a workspace from the service instance. This operation is limited to 30 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete a workspace from the service instance. +This operation is limited to 30 requests per 30 minutes. For more information, see Rate limiting.

@@ -1283,9 +1283,9 @@

Parameters

List intents.

-

List the intents for a workspace. With export=false, this operation is limited to 2000 requests per 30 -minutes. With export=true, the limit is 400 requests per 30 minutes. For more information, see Rate -limiting.

+

List the intents for a workspace. +With export=false, this operation is limited to 2000 requests per 30 minutes. With export=true, the +limit is 400 requests per 30 minutes. For more information, see Rate limiting.

@@ -1330,8 +1330,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -1453,8 +1453,8 @@

Parameters

Create intent.

-

Create a new intent. This operation is limited to 2000 requests per 30 minutes. For more information, see Rate -limiting.

+

Create a new intent. +This operation is limited to 2000 requests per 30 minutes. For more information, see Rate limiting.

@@ -1496,9 +1496,13 @@

Parameters

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode -alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It -must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +

@@ -1510,8 +1514,8 @@

Parameters

-

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must -be no longer than 128 characters.

+

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -1584,9 +1588,9 @@

Parameters

Get intent.

-

Get information about an intent, optionally including all intent content. With export=false, this -operation is limited to 6000 requests per 5 minutes. With export=true, the limit is 400 requests per 30 -minutes. For more information, see Rate limiting.

+

Get information about an intent, optionally including all intent content. +With export=false, this operation is limited to 6000 requests per 5 minutes. With export=true, the +limit is 400 requests per 30 minutes. For more information, see Rate limiting.

@@ -1640,8 +1644,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -1715,8 +1719,8 @@

Parameters

Update intent.

Update an existing intent with new or modified data. You must provide component objects defining the content of the -updated intent. This operation is limited to 2000 requests per 30 minutes. For more information, see Rate -limiting.

+updated intent. +This operation is limited to 2000 requests per 30 minutes. For more information, see Rate limiting.

@@ -1771,9 +1775,13 @@

Parameters

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode -alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It -must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +

@@ -1858,8 +1866,8 @@

Parameters

Delete intent.

-

Delete an intent from a workspace. This operation is limited to 2000 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete an intent from a workspace. +This operation is limited to 2000 requests per 30 minutes. For more information, see Rate limiting.

@@ -1960,8 +1968,8 @@

Parameters

List user input examples.

-

List the user input examples for an intent. This operation is limited to 2500 requests per 30 minutes. For more -information, see Rate limiting.

+

List the user input examples for an intent. +This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

@@ -2128,8 +2136,8 @@

Parameters

Create user input example.

-

Add a new user input example to an intent. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Add a new user input example to an intent. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -2182,9 +2190,13 @@

Parameters

-

The text of a user input example. This string must conform to the following restrictions: - It cannot contain -carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no -longer than 1024 characters.

+

The text of a user input example. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +

@@ -2245,8 +2257,8 @@

Parameters

Get user input example.

-

Get information about a user input example. This operation is limited to 6000 requests per 5 minutes. For more -information, see Rate limiting.

+

Get information about a user input example. +This operation is limited to 6000 requests per 5 minutes. For more information, see Rate limiting.

@@ -2373,8 +2385,8 @@

Parameters

Update user input example.

-

Update the text of a user input example. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Update the text of a user input example. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -2440,9 +2452,13 @@

Parameters

-

The text of the user input example. This string must conform to the following restrictions: - It cannot contain -carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no -longer than 1024 characters.

+

The text of the user input example. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +

@@ -2503,8 +2519,8 @@

Parameters

Delete user input example.

-

Delete a user input example from an intent. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete a user input example from an intent. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -2619,7 +2635,7 @@

Parameters

List counterexamples.

List the counterexamples for a workspace. Counterexamples are examples that have been marked as irrelevant input. - This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

+This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

@@ -2814,9 +2830,13 @@

Parameters

-

The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It -cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It -must be no longer than 1024 characters.

+

The text of a user input marked as irrelevant input. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters
  • +
  • It cannot consist of only whitespace characters
  • +
  • It must be no longer than 1024 characters.
  • +

@@ -3108,7 +3128,7 @@

Parameters

Delete counterexample.

Delete a counterexample from a workspace. Counterexamples are examples that have been marked as irrelevant input. - This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

+This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -3209,9 +3229,9 @@

Parameters

List entities.

-

List the entities for a workspace. With export=false, this operation is limited to 1000 requests per 30 -minutes. With export=true, the limit is 200 requests per 30 minutes. For more information, see Rate -limiting.

+

List the entities for a workspace. +With export=false, this operation is limited to 1000 requests per 30 minutes. With export=true, the +limit is 200 requests per 30 minutes. For more information, see Rate limiting.

@@ -3256,8 +3276,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -3379,8 +3399,8 @@

Parameters

Create entity.

-

Create a new entity. This operation is limited to 1000 requests per 30 minutes. For more information, see Rate -limiting.

+

Create a new entity. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -3481,9 +3501,9 @@

Parameters

Get entity.

-

Get information about an entity, optionally including all entity content. With export=false, this -operation is limited to 6000 requests per 5 minutes. With export=true, the limit is 200 requests per 30 -minutes. For more information, see Rate limiting.

+

Get information about an entity, optionally including all entity content. +With export=false, this operation is limited to 6000 requests per 5 minutes. With export=true, the +limit is 200 requests per 30 minutes. For more information, see Rate limiting.

@@ -3537,8 +3557,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -3612,8 +3632,8 @@

Parameters

Update entity.

Update an existing entity with new or modified data. You must provide component objects defining the content of the -updated entity. This operation is limited to 1000 requests per 30 minutes. For more information, see Rate -limiting.

+updated entity. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -3668,8 +3688,8 @@

Parameters

The updated content of the entity. Any elements included in the new data will completely replace the equivalent existing elements, including all subelements. (Previously existing subelements are not retained unless they are -also included in the new data.) For example, if you update the values for an entity, the previously existing values -are discarded and replaced with the new values specified in the update.

+also included in the new data.) For example, if you update the values for an entity, the previously existing +values are discarded and replaced with the new values specified in the update.

@@ -3730,8 +3750,8 @@

Parameters

Delete entity.

-

Delete an entity from a workspace. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete an entity from a workspace. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -3832,8 +3852,8 @@

Parameters

List entity values.

-

List the values for an entity. This operation is limited to 2500 requests per 30 minutes. For more information, -see Rate limiting.

+

List the values for an entity. +This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

@@ -3891,8 +3911,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -4014,8 +4034,8 @@

Parameters

Add entity value.

-

Create a new value for an entity. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Create a new value for an entity. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -4129,8 +4149,8 @@

Parameters

Get entity value.

-

Get information about an entity value. This operation is limited to 6000 requests per 5 minutes. For more -information, see Rate limiting.

+

Get information about an entity value. +This operation is limited to 6000 requests per 5 minutes. For more information, see Rate limiting.

@@ -4197,8 +4217,8 @@

Parameters

-

Whether to include all element content in the returned data. If export=false, the returned data includes only -information about the element itself. If export=true, all content, including subelements, is included.

+

Whether to include all element content in the returned data. If export=false, the returned data includes +only information about the element itself. If export=true, all content, including subelements, is included.

@@ -4272,8 +4292,8 @@

Parameters

Update entity value.

Update an existing entity value with new or modified data. You must provide component objects defining the content -of the updated entity value. This operation is limited to 1000 requests per 30 minutes. For more information, -see Rate limiting.

+of the updated entity value. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -4339,10 +4359,11 @@

Parameters

-

The updated content of the entity value. Any elements included in the new data will completely replace the -equivalent existing elements, including all subelements. (Previously existing subelements are not retained unless -they are also included in the new data.) For example, if you update the synonyms for an entity value, the -previously existing synonyms are discarded and replaced with the new synonyms specified in the update.

+

The updated content of the entity value. +Any elements included in the new data will completely replace the equivalent existing elements, including all +subelements. (Previously existing subelements are not retained unless they are also included in the new data.) +For example, if you update the synonyms for an entity value, the previously existing synonyms are discarded and +replaced with the new synonyms specified in the update.

@@ -4403,8 +4424,8 @@

Parameters

Delete entity value.

-

Delete a value from an entity. This operation is limited to 1000 requests per 30 minutes. For more information, -see Rate limiting.

+

Delete a value from an entity. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -4518,8 +4539,8 @@

Parameters

List entity value synonyms.

-

List the synonyms for an entity value. This operation is limited to 2500 requests per 30 minutes. For more -information, see Rate limiting.

+

List the synonyms for an entity value. +This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

@@ -4699,8 +4720,8 @@

Parameters

Add entity value synonym.

-

Add a new synonym to an entity value. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Add a new synonym to an entity value. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -4766,9 +4787,13 @@

Parameters

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage -return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer -than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -4829,8 +4854,8 @@

Parameters

Get entity value synonym.

-

Get information about a synonym of an entity value. This operation is limited to 6000 requests per 5 minutes. -For more information, see Rate limiting.

+

Get information about a synonym of an entity value. +This operation is limited to 6000 requests per 5 minutes. For more information, see Rate limiting.

@@ -4970,8 +4995,8 @@

Parameters

Update entity value synonym.

-

Update an existing entity value synonym with new text. This operation is limited to 1000 requests per 30 -minutes. For more information, see Rate limiting.

+

Update an existing entity value synonym with new text. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -5050,9 +5075,13 @@

Parameters

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage -return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer -than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -5113,8 +5142,8 @@

Parameters

Delete entity value synonym.

-

Delete a synonym from an entity value. This operation is limited to 1000 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete a synonym from an entity value. +This operation is limited to 1000 requests per 30 minutes. For more information, see Rate limiting.

@@ -5241,8 +5270,8 @@

Parameters

List dialog nodes.

-

List the dialog nodes for a workspace. This operation is limited to 2500 requests per 30 minutes. For more -information, see Rate limiting.

+

List the dialog nodes for a workspace. +This operation is limited to 2500 requests per 30 minutes. For more information, see Rate limiting.

@@ -5396,8 +5425,8 @@

Parameters

Create dialog node.

-

Create a new dialog node. This operation is limited to 500 requests per 30 minutes. For more information, see -Rate limiting.

+

Create a new dialog node. +This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

@@ -5498,8 +5527,8 @@

Parameters

Get dialog node.

-

Get information about a dialog node. This operation is limited to 6000 requests per 5 minutes. For more -information, see Rate limiting.

+

Get information about a dialog node. +This operation is limited to 6000 requests per 5 minutes. For more information, see Rate limiting.

@@ -5613,8 +5642,8 @@

Parameters

Update dialog node.

-

Update an existing dialog node with new or modified data. This operation is limited to 500 requests per 30 -minutes. For more information, see Rate limiting.

+

Update an existing dialog node with new or modified data. +This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

@@ -5667,10 +5696,11 @@

Parameters

-

The updated content of the dialog node. Any elements included in the new data will completely replace the -equivalent existing elements, including all subelements. (Previously existing subelements are not retained unless -they are also included in the new data.) For example, if you update the actions for a dialog node, the previously -existing actions are discarded and replaced with the new actions specified in the update.

+

The updated content of the dialog node. +Any elements included in the new data will completely replace the equivalent existing elements, including all +subelements. (Previously existing subelements are not retained unless they are also included in the new data.) +For example, if you update the actions for a dialog node, the previously existing actions are discarded and +replaced with the new actions specified in the update.

@@ -5731,8 +5761,8 @@

Parameters

Delete dialog node.

-

Delete a dialog node from a workspace. This operation is limited to 500 requests per 30 minutes. For more -information, see Rate limiting.

+

Delete a dialog node from a workspace. +This operation is limited to 500 requests per 30 minutes. For more information, see Rate limiting.

@@ -5833,9 +5863,9 @@

Parameters

List log events in a workspace.

-

List the events from the log of a specific workspace. If cursor is not specified, this operation is limited -to 40 requests per 30 minutes. If cursor is specified, the limit is 120 requests per minute. For more -information, see Rate limiting.

+

List the events from the log of a specific workspace. +If cursor is not specified, this operation is limited to 40 requests per 30 minutes. If cursor is +specified, the limit is 120 requests per minute. For more information, see Rate limiting.

@@ -5891,7 +5921,8 @@

Parameters

-

A cacheable parameter that limits the results to those matching the specified filter. For more information, see the +

A cacheable parameter that limits the results to those matching the specified filter. For more information, see +the documentation.

@@ -5977,9 +6008,9 @@

Parameters

List log events in all workspaces.

-

List the events from the logs of all workspaces in the service instance. If cursor is not specified, this -operation is limited to 40 requests per 30 minutes. If cursor is specified, the limit is 120 requests per -minute. For more information, see Rate limiting.

+

List the events from the logs of all workspaces in the service instance. +If cursor is not specified, this operation is limited to 40 requests per 30 minutes. If cursor is +specified, the limit is 120 requests per minute. For more information, see Rate limiting.

@@ -6111,8 +6142,9 @@

Parameters

Delete labeled data.

Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with -the customer ID. You associate a customer ID with data by passing the X-Watson-Metadata header with a request -that passes data. For more information about personal data and customer IDs, see Information +the customer ID. +You associate a customer ID with data by passing the X-Watson-Metadata header with a request that passes data. +For more information about personal data and customer IDs, see Information security.

@@ -6191,7 +6223,7 @@

Parameters

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Enums.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Enums.html index 7b5a5d7f6..057564c76 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Enums.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Enums.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html index 99fe80c57..768b343cd 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html @@ -170,9 +170,6 @@ - @@ -636,7 +633,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html index 33c3fc03b..bce3d5ef8 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html @@ -170,9 +170,6 @@ - @@ -503,7 +500,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs.html index beb0bbd41..2fdb60370 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs.html @@ -170,9 +170,6 @@ - @@ -2027,49 +2024,10 @@

Declaration

-
-
- - - -

JSON

-
-
-
    -
  • -
    - - - - JSONWrapper - -
    -
    -
    -
    -
    -
    -

    Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct JSONWrapper
    - -
    -
    -
    -
    -
  • -
-
diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CaptureGroup.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CaptureGroup.html index 8869d7306..c5d177be4 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CaptureGroup.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CaptureGroup.html @@ -170,9 +170,6 @@ - @@ -381,7 +378,10 @@

Declaration

Declaration

Swift

-
public init(group: String, location: [Int]? = nil)
+
public init(
+    group: String,
+    location: [Int]? = nil
+)
@@ -428,7 +428,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Context.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Context.html index dd06e423f..8d9186581 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Context.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Context.html @@ -170,9 +170,6 @@ - @@ -408,7 +405,11 @@

Declaration

Declaration

Swift

-
public init(conversationID: String? = nil, system: SystemResponse? = nil, additionalProperties: [String: JSON] = [:])
+
public init(
+    conversationID: String? = nil,
+    system: SystemResponse? = nil,
+    additionalProperties: [String: JSON] = [:]
+)
@@ -507,7 +508,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Counterexample.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Counterexample.html index 8341abefd..8a17d1e73 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Counterexample.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Counterexample.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CounterexampleCollection.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CounterexampleCollection.html index c30e511de..9abdf0b8c 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CounterexampleCollection.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CounterexampleCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateCounterexample.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateCounterexample.html index 15a280847..e7a5d965c 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateCounterexample.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateCounterexample.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

CreateCounterexample

-

The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It must be no longer than 1024 characters.

+

The text of a user input marked as irrelevant input. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters
  • +
  • It cannot consist of only whitespace characters
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -354,7 +357,9 @@

Declaration

Declaration

Swift

-
public init(text: String)
+
public init(
+    text: String
+)
@@ -370,7 +375,13 @@

Parameters

-

The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It must be no longer than 1024 characters.

+

The text of a user input marked as irrelevant input. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters
  • +
  • It cannot consist of only whitespace characters
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -389,7 +400,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode.html index cb396edf5..89b2d0f30 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode.html @@ -170,9 +170,6 @@ - @@ -460,7 +457,12 @@

Declaration

-

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

+

The dialog node ID. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -487,7 +489,8 @@

Declaration

-

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -514,7 +517,8 @@

Declaration

-

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab +characters, and it must be no longer than 2048 characters.

@@ -595,7 +599,8 @@

Declaration

-

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

+

The output of the dialog node. For more information about how to specify dialog node output, see the +documentation.

@@ -730,7 +735,12 @@

Declaration

-

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

+

The alias used to identify the dialog node. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -926,7 +936,25 @@

Declaration

Declaration

Swift

-
public init(dialogNode: String, description: String? = nil, conditions: String? = nil, parent: String? = nil, previousSibling: String? = nil, output: [String: JSON]? = nil, context: [String: JSON]? = nil, metadata: [String: JSON]? = nil, nextStep: DialogNodeNextStep? = nil, actions: [DialogNodeAction]? = nil, title: String? = nil, nodeType: String? = nil, eventName: String? = nil, variable: String? = nil, digressIn: String? = nil, digressOut: String? = nil, digressOutSlots: String? = nil)
+
public init(
+    dialogNode: String,
+    description: String? = nil,
+    conditions: String? = nil,
+    parent: String? = nil,
+    previousSibling: String? = nil,
+    output: [String: JSON]? = nil,
+    context: [String: JSON]? = nil,
+    metadata: [String: JSON]? = nil,
+    nextStep: DialogNodeNextStep? = nil,
+    actions: [DialogNodeAction]? = nil,
+    title: String? = nil,
+    nodeType: String? = nil,
+    eventName: String? = nil,
+    variable: String? = nil,
+    digressIn: String? = nil,
+    digressOut: String? = nil,
+    digressOutSlots: String? = nil
+)
@@ -942,7 +970,12 @@

Parameters

-

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

+

The dialog node ID. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 1024 characters.
  • +

@@ -954,7 +987,8 @@

Parameters

-

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and +it must be no longer than 128 characters.

@@ -966,7 +1000,8 @@

Parameters

-

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab +characters, and it must be no longer than 2048 characters.

@@ -1002,7 +1037,8 @@

Parameters

-

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

+

The output of the dialog node. For more information about how to specify dialog node output, see the +documentation.

@@ -1062,7 +1098,12 @@

Parameters

-

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

+

The alias used to identify the dialog node. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -1153,7 +1194,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressIn.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressIn.html index 6c9926e30..e0424cba0 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressIn.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressIn.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressOut.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressOut.html index 938f924b8..f0586a98e 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressOut.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressOut.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressOutSlots.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressOutSlots.html index 25ab4ba1d..9366dc06a 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressOutSlots.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/DigressOutSlots.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/EventName.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/EventName.html index b997af2bb..ff26e5bee 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/EventName.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/EventName.html @@ -170,9 +170,6 @@ - @@ -555,7 +552,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/NodeType.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/NodeType.html index b1d445fcf..cadd333d7 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/NodeType.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateDialogNode/NodeType.html @@ -170,9 +170,6 @@ - @@ -474,7 +471,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateEntity.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateEntity.html index 2138ec29c..44e00df3d 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateEntity.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateEntity.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

CreateEntity

-

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

+

The name of the entity. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, underscore, and hyphen characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -347,7 +350,8 @@

Declaration

-

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must +be no longer than 128 characters.

@@ -462,7 +466,13 @@

Declaration

Declaration

Swift

-
public init(entity: String, description: String? = nil, metadata: [String: JSON]? = nil, values: [CreateValue]? = nil, fuzzyMatch: Bool? = nil)
+
public init(
+    entity: String,
+    description: String? = nil,
+    metadata: [String: JSON]? = nil,
+    values: [CreateValue]? = nil,
+    fuzzyMatch: Bool? = nil
+)
@@ -478,7 +488,13 @@

Parameters

-

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

+

The name of the entity. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, and hyphen characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -490,7 +506,8 @@

Parameters

-

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -545,7 +562,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateExample.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateExample.html index 5381a0643..50d261e6e 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateExample.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateExample.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

CreateExample

-

The text of a user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

+

The text of a user input example. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -354,7 +357,9 @@

Declaration

Declaration

Swift

-
public init(text: String)
+
public init(
+    text: String
+)
@@ -370,7 +375,13 @@

Parameters

-

The text of a user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

+

The text of a user input example. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -389,7 +400,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateIntent.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateIntent.html index f09c322ae..7adf91b15 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateIntent.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateIntent.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

CreateIntent

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +
@@ -347,7 +350,8 @@

Declaration

-

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must +be no longer than 128 characters.

@@ -408,7 +412,11 @@

Declaration

Declaration

Swift

-
public init(intent: String, description: String? = nil, examples: [CreateExample]? = nil)
+
public init(
+    intent: String,
+    description: String? = nil,
+    examples: [CreateExample]? = nil
+)
@@ -424,7 +432,13 @@

Parameters

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +

@@ -436,7 +450,8 @@

Parameters

-

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -467,7 +482,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateSynonym.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateSynonym.html index eace9051d..23d8026eb 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateSynonym.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateSynonym.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

CreateSynonym

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -354,7 +357,9 @@

Declaration

Declaration

Swift

-
public init(synonym: String)
+
public init(
+    synonym: String
+)
@@ -370,7 +375,13 @@

Parameters

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -389,7 +400,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateValue.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateValue.html index e20b8e908..8bb07abfc 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateValue.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateValue.html @@ -170,9 +170,6 @@ - @@ -348,7 +345,13 @@

Declaration

-

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the entity value. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -402,7 +405,14 @@

Declaration

-

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by +type), but not both. A synonym must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -429,7 +439,10 @@

Declaration

-

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

+

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), +but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to +specify a pattern, see the +documentation.

@@ -490,7 +503,13 @@

Declaration

Declaration

Swift

-
public init(value: String, metadata: [String: JSON]? = nil, synonyms: [String]? = nil, patterns: [String]? = nil, valueType: String? = nil)
+
public init(
+    value: String,
+    metadata: [String: JSON]? = nil,
+    synonyms: [String]? = nil,
+    patterns: [String]? = nil,
+    valueType: String? = nil
+)
@@ -506,7 +525,13 @@

Parameters

-

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the entity value. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -530,7 +555,14 @@

Parameters

-

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated +by type), but not both. A synonym must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -542,7 +574,10 @@

Parameters

-

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

+

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by +type), but not both. A pattern is a regular expression no longer than 128 characters. For more information +about how to specify a pattern, see the +documentation.

@@ -573,7 +608,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateValue/ValueType.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateValue/ValueType.html index 598570b8f..d475f9fc4 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateValue/ValueType.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateValue/ValueType.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateWorkspace.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateWorkspace.html index 41a103170..38576f30e 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateWorkspace.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateWorkspace.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,8 @@

CreateWorkspace

-

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

+

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be +no longer than 64 characters.

@@ -347,7 +345,8 @@

Declaration

-

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -536,7 +535,8 @@

Declaration

-

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that +workspace training data is not to be used.

@@ -570,7 +570,17 @@

Declaration

Declaration

Swift

-
public init(name: String? = nil, description: String? = nil, language: String? = nil, intents: [CreateIntent]? = nil, entities: [CreateEntity]? = nil, dialogNodes: [CreateDialogNode]? = nil, counterexamples: [CreateCounterexample]? = nil, metadata: [String: JSON]? = nil, learningOptOut: Bool? = nil)
+
public init(
+    name: String? = nil,
+    description: String? = nil,
+    language: String? = nil,
+    intents: [CreateIntent]? = nil,
+    entities: [CreateEntity]? = nil,
+    dialogNodes: [CreateDialogNode]? = nil,
+    counterexamples: [CreateCounterexample]? = nil,
+    metadata: [String: JSON]? = nil,
+    learningOptOut: Bool? = nil
+)
@@ -586,7 +596,8 @@

Parameters

-

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

+

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be +no longer than 64 characters.

@@ -598,7 +609,8 @@

Parameters

-

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -682,7 +694,8 @@

Parameters

-

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace can be used by IBM for general service improvements. true indicates +that workspace training data is not to be used.

@@ -701,7 +714,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode.html index 1edb38424..360cdde57 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode.html @@ -170,9 +170,6 @@ - @@ -568,7 +565,8 @@

Declaration

-

The ID of the previous sibling dialog node. This property is not returned if the dialog node has no previous sibling.

+

The ID of the previous sibling dialog node. This property is not returned if the dialog node has no previous +sibling.

@@ -965,7 +963,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressIn.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressIn.html index fe8d86dad..db05038bb 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressIn.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressIn.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressOut.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressOut.html index 9a629982c..feba14e6e 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressOut.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressOut.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressOutSlots.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressOutSlots.html index 2dcc28528..fccb1ff6d 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressOutSlots.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/DigressOutSlots.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/EventName.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/EventName.html index 22f4e3ac6..88eae6c8b 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/EventName.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/EventName.html @@ -170,9 +170,6 @@ - @@ -555,7 +552,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/NodeType.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/NodeType.html index 44b76d634..d5c0a3c5e 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/NodeType.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNode/NodeType.html @@ -170,9 +170,6 @@ - @@ -474,7 +471,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeAction.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeAction.html index f65590d75..07a79e3dc 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeAction.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeAction.html @@ -170,9 +170,6 @@ - @@ -490,7 +487,13 @@

Declaration

Declaration

Swift

-
public init(name: String, resultVariable: String, actionType: String? = nil, parameters: [String: JSON]? = nil, credentials: String? = nil)
+
public init(
+    name: String,
+    resultVariable: String,
+    actionType: String? = nil,
+    parameters: [String: JSON]? = nil,
+    credentials: String? = nil
+)
@@ -573,7 +576,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeAction/ActionType.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeAction/ActionType.html index 2e91c384e..8d74c8893 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeAction/ActionType.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeAction/ActionType.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeCollection.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeCollection.html index ff02b036f..045b3a2e6 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeCollection.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep.html index 53db04213..28926a82a 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,40 @@

DialogNodeNextStep

-

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

+

What happens after the dialog node completes. The valid values depend on the node type:

+ +
    +
  • The following values are valid for any node: + +
      +
    • get_user_input
    • +
    • skip_user_input
    • +
    • jump_to
    • +
  • +
  • If the node is of type event_handler and its parent node is of type slot or frame, additional values are +also valid: + +
      +
    • if event_name=filled and the type of the parent node is slot:
    • +
    • reprompt
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=nomatch and the type of the parent node is slot: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=generic and the type of the parent node is frame: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots +If you specify jump_to, then you must also specify a value for the dialog_node property.
    • +
  • +
See more
@@ -376,7 +406,40 @@

Declaration

-

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

+

What happens after the dialog node completes. The valid values depend on the node type:

+ +
    +
  • The following values are valid for any node: + +
      +
    • get_user_input
    • +
    • skip_user_input
    • +
    • jump_to
    • +
  • +
  • If the node is of type event_handler and its parent node is of type slot or frame, additional values are +also valid: + +
      +
    • if event_name=filled and the type of the parent node is slot:
    • +
    • reprompt
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=nomatch and the type of the parent node is slot: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=generic and the type of the parent node is frame: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots +If you specify jump_to, then you must also specify a value for the dialog_node property.
    • +
  • +
@@ -464,7 +527,11 @@

Declaration

Declaration

Swift

-
public init(behavior: String, dialogNode: String? = nil, selector: String? = nil)
+
public init(
+    behavior: String,
+    dialogNode: String? = nil,
+    selector: String? = nil
+)
@@ -480,7 +547,37 @@

Parameters

-

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

+

What happens after the dialog node completes. The valid values depend on the node type: + +

    +
  • The following values are valid for any node:
  • +
  • get_user_input
  • +
  • skip_user_input
  • +
  • jump_to
  • +
  • If the node is of type event_handler and its parent node is of type slot or frame, additional values are +also valid:
  • +
  • if event_name=filled and the type of the parent node is slot: + +
      +
    • reprompt
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=nomatch and the type of the parent node is slot: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=generic and the type of the parent node is frame: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots +If you specify jump_to, then you must also specify a value for the dialog_node property.
    • +
  • +

@@ -523,7 +620,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep/Behavior.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep/Behavior.html index a08da9f3e..e77ab615c 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep/Behavior.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep/Behavior.html @@ -170,9 +170,6 @@ - @@ -301,7 +298,40 @@

Behavior

-

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

+

What happens after the dialog node completes. The valid values depend on the node type:

+ +
    +
  • The following values are valid for any node: + +
      +
    • get_user_input
    • +
    • skip_user_input
    • +
    • jump_to
    • +
  • +
  • If the node is of type event_handler and its parent node is of type slot or frame, additional values are +also valid: + +
      +
    • if event_name=filled and the type of the parent node is slot:
    • +
    • reprompt
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=nomatch and the type of the parent node is slot: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots
    • +
  • +
  • if event_name=generic and the type of the parent node is frame: + +
      +
    • reprompt
    • +
    • skip_slot
    • +
    • skip_all_slots +If you specify jump_to, then you must also specify a value for the dialog_node property.
    • +
  • +
@@ -474,7 +504,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep/Selector.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep/Selector.html index f6028a0e3..01ad7fc78 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep/Selector.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeNextStep/Selector.html @@ -170,9 +170,6 @@ - @@ -420,7 +417,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeVisitedDetails.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeVisitedDetails.html index 650c0b7ae..c5baeff1b 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeVisitedDetails.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/DialogNodeVisitedDetails.html @@ -170,9 +170,6 @@ - @@ -408,7 +405,11 @@

Declaration

Declaration

Swift

-
public init(dialogNode: String? = nil, title: String? = nil, conditions: String? = nil)
+
public init(
+    dialogNode: String? = nil,
+    title: String? = nil,
+    conditions: String? = nil
+)
@@ -467,7 +468,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Entity.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Entity.html index 2bcb25997..5185ab722 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Entity.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Entity.html @@ -170,9 +170,6 @@ - @@ -474,7 +471,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/EntityCollection.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/EntityCollection.html index 09b4808aa..a3a0b22fe 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/EntityCollection.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/EntityCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/EntityExport.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/EntityExport.html index 2cf1b4a8f..60d44edad 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/EntityExport.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/EntityExport.html @@ -170,9 +170,6 @@ - @@ -501,7 +498,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Example.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Example.html index 1a73e888c..7c70f61a7 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Example.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Example.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/ExampleCollection.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/ExampleCollection.html index 3b9faa0df..189ffdf3a 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/ExampleCollection.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/ExampleCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/InputData.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/InputData.html index 8581c9a61..3f87eedc6 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/InputData.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/InputData.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,8 @@

InputData

-

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be +no longer than 2048 characters.

@@ -354,7 +352,9 @@

Declaration

Declaration

Swift

-
public init(text: String)
+
public init(
+    text: String
+)
@@ -370,7 +370,8 @@

Parameters

-

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must +be no longer than 2048 characters.

@@ -389,7 +390,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Intent.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Intent.html index 484a010f7..61f84d18a 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Intent.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Intent.html @@ -170,9 +170,6 @@ - @@ -420,7 +417,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/IntentCollection.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/IntentCollection.html index 87e432f2f..776746738 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/IntentCollection.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/IntentCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/IntentExport.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/IntentExport.html index 681f78b9b..dec0b82d5 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/IntentExport.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/IntentExport.html @@ -170,9 +170,6 @@ - @@ -447,7 +444,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/LogCollection.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/LogCollection.html index fd16ed002..686a94636 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/LogCollection.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/LogCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/LogExport.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/LogExport.html index 7980931b3..4544b6c7e 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/LogExport.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/LogExport.html @@ -170,9 +170,6 @@ - @@ -501,7 +498,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/LogMessage.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/LogMessage.html index 0cf5346b0..587035ad1 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/LogMessage.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/LogMessage.html @@ -170,9 +170,6 @@ - @@ -436,7 +433,11 @@

Declaration

Declaration

Swift

-
public init(level: String, msg: String, additionalProperties: [String: JSON] = [:])
+
public init(
+    level: String,
+    msg: String,
+    additionalProperties: [String: JSON] = [:]
+)
@@ -535,7 +536,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/LogMessage/Level.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/LogMessage/Level.html index d09ee4711..353992ba1 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/LogMessage/Level.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/LogMessage/Level.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/LogPagination.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/LogPagination.html index e0b94465f..4a7fe67fb 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/LogPagination.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/LogPagination.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageInput.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageInput.html index 3f31de773..51d20c603 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageInput.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageInput.html @@ -170,9 +170,6 @@ - @@ -339,7 +336,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageRequest.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageRequest.html index 071a87ccc..7f073a932 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageRequest.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageRequest.html @@ -170,9 +170,6 @@ - @@ -374,7 +371,8 @@

Declaration

-

State information for the conversation. Continue a conversation by including the context object from the previous response.

+

State information for the conversation. Continue a conversation by including the context object from the previous +response.

@@ -401,7 +399,8 @@

Declaration

-

Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input.

+

Entities to use when evaluating the message. Include entities from the previous response to continue using those +entities rather than detecting entities in the new input.

@@ -428,7 +427,8 @@

Declaration

-

Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input.

+

Intents to use when evaluating the user input. Include intents from the previous response to continue using those +intents rather than trying to recognize intents in the new input.

@@ -455,7 +455,8 @@

Declaration

-

System output. Include the output from the previous response to maintain intermediate information over multiple requests.

+

System output. Include the output from the previous response to maintain intermediate information over multiple +requests.

@@ -489,7 +490,14 @@

Declaration

Declaration

Swift

-
public init(input: InputData? = nil, alternateIntents: Bool? = nil, context: Context? = nil, entities: [RuntimeEntity]? = nil, intents: [RuntimeIntent]? = nil, output: OutputData? = nil)
+
public init(
+    input: InputData? = nil,
+    alternateIntents: Bool? = nil,
+    context: Context? = nil,
+    entities: [RuntimeEntity]? = nil,
+    intents: [RuntimeIntent]? = nil,
+    output: OutputData? = nil
+)
@@ -529,7 +537,8 @@

Parameters

-

State information for the conversation. Continue a conversation by including the context object from the previous response.

+

State information for the conversation. Continue a conversation by including the context object from the previous +response.

@@ -541,7 +550,8 @@

Parameters

-

Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input.

+

Entities to use when evaluating the message. Include entities from the previous response to continue using those +entities rather than detecting entities in the new input.

@@ -553,7 +563,8 @@

Parameters

-

Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input.

+

Intents to use when evaluating the user input. Include intents from the previous response to continue using those +intents rather than trying to recognize intents in the new input.

@@ -565,7 +576,8 @@

Parameters

-

System output. Include the output from the previous response to maintain intermediate information over multiple requests.

+

System output. Include the output from the previous response to maintain intermediate information over multiple +requests.

@@ -584,7 +596,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageResponse.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageResponse.html index 01dced1d5..00abd9a97 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageResponse.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/MessageResponse.html @@ -170,9 +170,6 @@ - @@ -527,7 +524,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/OutputData.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/OutputData.html index 6a6a14c9e..d86d50515 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/OutputData.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/OutputData.html @@ -170,9 +170,6 @@ - @@ -374,7 +371,8 @@

Declaration

-

An array of the nodes that were triggered to create the response, in the order in which they were visited. This information is useful for debugging and for tracing the path taken through the node tree.

+

An array of the nodes that were triggered to create the response, in the order in which they were visited. This +information is useful for debugging and for tracing the path taken through the node tree.

@@ -401,7 +399,9 @@

Declaration

-

An array of objects containing detailed diagnostic information about the nodes that were triggered during processing of the input message. Included only if nodes_visited_details is set to true in the message request.

+

An array of objects containing detailed diagnostic information about the nodes that were triggered during +processing of the input message. Included only if nodes_visited_details is set to true in the message +request.

@@ -462,7 +462,13 @@

Declaration

Declaration

Swift

-
public init(logMessages: [LogMessage], text: [String], nodesVisited: [String]? = nil, nodesVisitedDetails: [DialogNodeVisitedDetails]? = nil, additionalProperties: [String: JSON] = [:])
+
public init(
+    logMessages: [LogMessage],
+    text: [String],
+    nodesVisited: [String]? = nil,
+    nodesVisitedDetails: [DialogNodeVisitedDetails]? = nil,
+    additionalProperties: [String: JSON] = [:]
+)
@@ -502,7 +508,8 @@

Parameters

-

An array of the nodes that were triggered to create the response, in the order in which they were visited. This information is useful for debugging and for tracing the path taken through the node tree.

+

An array of the nodes that were triggered to create the response, in the order in which they were visited. This +information is useful for debugging and for tracing the path taken through the node tree.

@@ -514,7 +521,9 @@

Parameters

-

An array of objects containing detailed diagnostic information about the nodes that were triggered during processing of the input message. Included only if nodes_visited_details is set to true in the message request.

+

An array of objects containing detailed diagnostic information about the nodes that were triggered during +processing of the input message. Included only if nodes_visited_details is set to true in the message +request.

@@ -585,7 +594,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Pagination.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Pagination.html index 3b2a5ae43..c0c7c4b0b 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Pagination.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Pagination.html @@ -170,9 +170,6 @@ - @@ -474,7 +471,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/RuntimeEntity.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/RuntimeEntity.html index 2de743830..d90509a30 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/RuntimeEntity.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/RuntimeEntity.html @@ -170,9 +170,6 @@ - @@ -347,7 +344,8 @@

Declaration

-

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text.

+

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input +text.

@@ -516,7 +514,15 @@

Declaration

Declaration

Swift

-
public init(entity: String, location: [Int], value: String, confidence: Double? = nil, metadata: [String: JSON]? = nil, groups: [CaptureGroup]? = nil, additionalProperties: [String: JSON] = [:])
+
public init(
+    entity: String,
+    location: [Int],
+    value: String,
+    confidence: Double? = nil,
+    metadata: [String: JSON]? = nil,
+    groups: [CaptureGroup]? = nil,
+    additionalProperties: [String: JSON] = [:]
+)
@@ -544,7 +550,8 @@

Parameters

-

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text.

+

An array of zero-based character offsets that indicate where the detected entity values begin and end in the +input text.

@@ -663,7 +670,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/RuntimeIntent.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/RuntimeIntent.html index 6041e73ca..db1a0a199 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/RuntimeIntent.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/RuntimeIntent.html @@ -170,9 +170,6 @@ - @@ -408,7 +405,11 @@

Declaration

Declaration

Swift

-
public init(intent: String, confidence: Double, additionalProperties: [String: JSON] = [:])
+
public init(
+    intent: String,
+    confidence: Double,
+    additionalProperties: [String: JSON] = [:]
+)
@@ -507,7 +508,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Synonym.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Synonym.html index a6dee1510..b273a9b25 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Synonym.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Synonym.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/SynonymCollection.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/SynonymCollection.html index 123c82044..afb630716 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/SynonymCollection.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/SynonymCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/SystemResponse.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/SystemResponse.html index aba2cf8bd..cc4ddfd75 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/SystemResponse.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/SystemResponse.html @@ -170,9 +170,6 @@ - @@ -354,7 +351,9 @@

Declaration

Declaration

Swift

-
public init(additionalProperties: [String: JSON] = [:])
+
public init(
+    additionalProperties: [String: JSON] = [:]
+)
@@ -422,7 +421,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateCounterexample.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateCounterexample.html index c58ec5ef6..73faba268 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateCounterexample.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateCounterexample.html @@ -170,9 +170,6 @@ - @@ -354,7 +351,9 @@

Declaration

Declaration

Swift

-
public init(text: String? = nil)
+
public init(
+    text: String? = nil
+)
@@ -389,7 +388,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode.html index 0f6a4e450..00cd7daca 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode.html @@ -170,9 +170,6 @@ - @@ -460,7 +457,12 @@

Declaration

-

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

+

The dialog node ID. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -487,7 +489,8 @@

Declaration

-

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -514,7 +517,8 @@

Declaration

-

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab +characters, and it must be no longer than 2048 characters.

@@ -595,7 +599,8 @@

Declaration

-

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

+

The output of the dialog node. For more information about how to specify dialog node output, see the +documentation.

@@ -703,7 +708,12 @@

Declaration

-

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

+

The alias used to identify the dialog node. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -926,7 +936,25 @@

Declaration

Declaration

Swift

-
public init(dialogNode: String? = nil, description: String? = nil, conditions: String? = nil, parent: String? = nil, previousSibling: String? = nil, output: [String: JSON]? = nil, context: [String: JSON]? = nil, metadata: [String: JSON]? = nil, nextStep: DialogNodeNextStep? = nil, title: String? = nil, nodeType: String? = nil, eventName: String? = nil, variable: String? = nil, actions: [DialogNodeAction]? = nil, digressIn: String? = nil, digressOut: String? = nil, digressOutSlots: String? = nil)
+
public init(
+    dialogNode: String? = nil,
+    description: String? = nil,
+    conditions: String? = nil,
+    parent: String? = nil,
+    previousSibling: String? = nil,
+    output: [String: JSON]? = nil,
+    context: [String: JSON]? = nil,
+    metadata: [String: JSON]? = nil,
+    nextStep: DialogNodeNextStep? = nil,
+    title: String? = nil,
+    nodeType: String? = nil,
+    eventName: String? = nil,
+    variable: String? = nil,
+    actions: [DialogNodeAction]? = nil,
+    digressIn: String? = nil,
+    digressOut: String? = nil,
+    digressOutSlots: String? = nil
+)
@@ -942,7 +970,12 @@

Parameters

-

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

+

The dialog node ID. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 1024 characters.
  • +

@@ -954,7 +987,8 @@

Parameters

-

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and +it must be no longer than 128 characters.

@@ -966,7 +1000,8 @@

Parameters

-

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

+

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab +characters, and it must be no longer than 2048 characters.

@@ -1002,7 +1037,8 @@

Parameters

-

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

+

The output of the dialog node. For more information about how to specify dialog node output, see the +documentation.

@@ -1050,7 +1086,12 @@

Parameters

-

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

+

The alias used to identify the dialog node. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -1153,7 +1194,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressIn.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressIn.html index f1523f52f..df4fd277f 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressIn.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressIn.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressOut.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressOut.html index 0a9cc93a4..39e8be11f 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressOut.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressOut.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressOutSlots.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressOutSlots.html index 8cbe1ed62..315e59834 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressOutSlots.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/DigressOutSlots.html @@ -170,9 +170,6 @@ - @@ -393,7 +390,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/EventName.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/EventName.html index 3aa4d3476..c4e9bcf08 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/EventName.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/EventName.html @@ -170,9 +170,6 @@ - @@ -555,7 +552,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/NodeType.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/NodeType.html index 62a5ffdfc..745c8a7db 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/NodeType.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateDialogNode/NodeType.html @@ -170,9 +170,6 @@ - @@ -474,7 +471,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateEntity.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateEntity.html index 5970979db..75eb23210 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateEntity.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateEntity.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

UpdateEntity

-

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

+

The name of the entity. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, underscore, and hyphen characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -347,7 +350,8 @@

Declaration

-

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must +be no longer than 128 characters.

@@ -462,7 +466,13 @@

Declaration

Declaration

Swift

-
public init(entity: String? = nil, description: String? = nil, metadata: [String: JSON]? = nil, fuzzyMatch: Bool? = nil, values: [CreateValue]? = nil)
+
public init(
+    entity: String? = nil,
+    description: String? = nil,
+    metadata: [String: JSON]? = nil,
+    fuzzyMatch: Bool? = nil,
+    values: [CreateValue]? = nil
+)
@@ -478,7 +488,13 @@

Parameters

-

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

+

The name of the entity. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, and hyphen characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -490,7 +506,8 @@

Parameters

-

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -545,7 +562,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateExample.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateExample.html index 28331be68..38e421ebc 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateExample.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateExample.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

UpdateExample

-

The text of the user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

+

The text of the user input example. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -354,7 +357,9 @@

Declaration

Declaration

Swift

-
public init(text: String? = nil)
+
public init(
+    text: String? = nil
+)
@@ -370,7 +375,13 @@

Parameters

-

The text of the user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

+

The text of the user input example. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 1024 characters.
  • +
@@ -389,7 +400,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateIntent.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateIntent.html index 5bb9e7c29..872a0dc13 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateIntent.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateIntent.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

UpdateIntent

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions:

+ +
    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +
@@ -408,7 +411,11 @@

Declaration

Declaration

Swift

-
public init(intent: String? = nil, description: String? = nil, examples: [CreateExample]? = nil)
+
public init(
+    intent: String? = nil,
+    description: String? = nil,
+    examples: [CreateExample]? = nil
+)
@@ -424,7 +431,13 @@

Parameters

-

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

+

The name of the intent. This string must conform to the following restrictions: + +

    +
  • It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters.
  • +
  • It cannot begin with the reserved prefix sys-.
  • +
  • It must be no longer than 128 characters.
  • +

@@ -467,7 +480,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateSynonym.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateSynonym.html index f1184b586..efb65b2cb 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateSynonym.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateSynonym.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,13 @@

UpdateSynonym

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -354,7 +357,9 @@

Declaration

Declaration

Swift

-
public init(synonym: String? = nil)
+
public init(
+    synonym: String? = nil
+)
@@ -370,7 +375,13 @@

Parameters

-

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the synonym. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -389,7 +400,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateValue.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateValue.html index 20ba42b85..8027b6ea4 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateValue.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateValue.html @@ -170,9 +170,6 @@ - @@ -348,7 +345,13 @@

Declaration

-

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the entity value. This string must conform to the following restrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -429,7 +432,14 @@

Declaration

-

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following resrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), +but not both. A synonym must conform to the following resrictions:

+ +
    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +
@@ -456,7 +466,10 @@

Declaration

-

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

+

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), +but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to +specify a pattern, see the +documentation.

@@ -490,7 +503,13 @@

Declaration

Declaration

Swift

-
public init(value: String? = nil, metadata: [String: JSON]? = nil, valueType: String? = nil, synonyms: [String]? = nil, patterns: [String]? = nil)
+
public init(
+    value: String? = nil,
+    metadata: [String: JSON]? = nil,
+    valueType: String? = nil,
+    synonyms: [String]? = nil,
+    patterns: [String]? = nil
+)
@@ -506,7 +525,13 @@

Parameters

-

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

The text of the entity value. This string must conform to the following restrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -542,7 +567,14 @@

Parameters

-

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following resrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

+

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by +type), but not both. A synonym must conform to the following resrictions: + +

    +
  • It cannot contain carriage return, newline, or tab characters.
  • +
  • It cannot consist of only whitespace characters.
  • +
  • It must be no longer than 64 characters.
  • +

@@ -554,7 +586,10 @@

Parameters

-

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

+

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by +type), but not both. A pattern is a regular expression no longer than 128 characters. For more information +about how to specify a pattern, see the +documentation.

@@ -573,7 +608,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateValue/ValueType.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateValue/ValueType.html index 50e7c99d2..260763d1b 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateValue/ValueType.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateValue/ValueType.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateWorkspace.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateWorkspace.html index 1c7932f7c..8978a25b7 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateWorkspace.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateWorkspace.html @@ -170,9 +170,6 @@ - @@ -320,7 +317,8 @@

UpdateWorkspace

-

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

+

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be +no longer than 64 characters.

@@ -347,7 +345,8 @@

Declaration

-

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -536,7 +535,8 @@

Declaration

-

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that +workspace training data is not to be used.

@@ -570,7 +570,17 @@

Declaration

Declaration

Swift

-
public init(name: String? = nil, description: String? = nil, language: String? = nil, intents: [CreateIntent]? = nil, entities: [CreateEntity]? = nil, dialogNodes: [CreateDialogNode]? = nil, counterexamples: [CreateCounterexample]? = nil, metadata: [String: JSON]? = nil, learningOptOut: Bool? = nil)
+
public init(
+    name: String? = nil,
+    description: String? = nil,
+    language: String? = nil,
+    intents: [CreateIntent]? = nil,
+    entities: [CreateEntity]? = nil,
+    dialogNodes: [CreateDialogNode]? = nil,
+    counterexamples: [CreateCounterexample]? = nil,
+    metadata: [String: JSON]? = nil,
+    learningOptOut: Bool? = nil
+)
@@ -586,7 +596,8 @@

Parameters

-

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

+

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be +no longer than 64 characters.

@@ -598,7 +609,8 @@

Parameters

-

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

+

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it +must be no longer than 128 characters.

@@ -682,7 +694,8 @@

Parameters

-

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace can be used by IBM for general service improvements. true indicates +that workspace training data is not to be used.

@@ -701,7 +714,7 @@

Return Value

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Value.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Value.html index e27241820..3b252eebb 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Value.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Value.html @@ -170,9 +170,6 @@ - @@ -529,7 +526,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Value/ValueType.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Value/ValueType.html index 44b51b27a..94e038445 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Value/ValueType.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Value/ValueType.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueCollection.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueCollection.html index 0278251db..3b252c9aa 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueCollection.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueExport.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueExport.html index f8c60976b..b512650ef 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueExport.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueExport.html @@ -170,9 +170,6 @@ - @@ -529,7 +526,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueExport/ValueType.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueExport/ValueType.html index d319cbee7..692041aa8 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueExport/ValueType.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/ValueExport/ValueType.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Workspace.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Workspace.html index d6661642f..bb19ded75 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Workspace.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/Workspace.html @@ -170,9 +170,6 @@ - @@ -509,7 +506,8 @@

Declaration

-

Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for +general service improvements. true indicates that workspace training data is not to be used.

@@ -528,7 +526,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceCollection.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceCollection.html index d783897e1..47c4c1a79 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceCollection.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceCollection.html @@ -170,9 +170,6 @@ - @@ -366,7 +363,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceExport.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceExport.html index c560ec20e..4cf6565a6 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceExport.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceExport.html @@ -170,9 +170,6 @@ - @@ -564,7 +561,8 @@

Declaration

-

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

+

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that +workspace training data is not to be used.

@@ -691,7 +689,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceExport/Status.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceExport/Status.html index 6919958f8..8570a6345 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceExport/Status.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/Structs/WorkspaceExport/Status.html @@ -170,9 +170,6 @@ - @@ -447,7 +444,7 @@

Declaration

diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/index.html b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/index.html index b73b1e414..e1bfeeafe 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/index.html +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/index.html @@ -169,9 +169,6 @@ - @@ -334,7 +331,8 @@

Services

  • Assistant
  • Discovery
  • -
  • Language Translator
  • +
  • Language Translator V2
  • +
  • Language Translator V3
  • Natural Language Classifier
  • Natural Language Understanding
  • Personality Insights
  • @@ -379,7 +377,7 @@

    Swift Package Manager

    Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

    dependencies: [
    -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
    +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
     ]
     

    Service Instances

    @@ -422,7 +420,7 @@

    Username and Password

    API Key

    -

    Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

    +

    Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

    let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
     

    Using IAM

    @@ -657,7 +655,12 @@

    Private Data Collections

  • IBM Discovery - Documentation
  • IBM Discovery - Demo
-

Language Translator

+

Language Translator V2

+ +

Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

@@ -668,6 +671,25 @@

Language Translator

let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} + +

Language Translator V3

+ +

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

+ +

The following example demonstrates how to use the Language Translator service:

+
import LanguageTranslatorV3
+
+let username = "your-username-here"
+let password = "your-password-here"
+let version = "yyyy-mm-dd" // use today's date for the most recent version
+let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
+
 let failure = { (error: Error) in print(error) }
 let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
 languageTranslator.translate(request: request, failure: failure) {
@@ -1058,7 +1080,7 @@ 

Visual Recognition

let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -1066,6 +1088,10 @@

Visual Recognition

print(classifiedImages) }
+ +

Note: a different initializer is used for authentication with instances created before May 23, 2018:

+
let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
+

Using Core ML

The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

@@ -1117,7 +1143,7 @@

Bundlin diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/search.json b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/search.json index fe261b840..f6b8bebed 100644 --- a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/search.json +++ b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/Documents/search.json @@ -1 +1 @@ -{"Structs/WorkspaceExport/Status.html#/s:14ConversationV115WorkspaceExportV6StatusO11nonExistentA2EmF":{"name":"nonExistent","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:14ConversationV115WorkspaceExportV6StatusO8trainingA2EmF":{"name":"training","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:14ConversationV115WorkspaceExportV6StatusO6failedA2EmF":{"name":"failed","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:14ConversationV115WorkspaceExportV6StatusO9availableA2EmF":{"name":"available","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:14ConversationV115WorkspaceExportV6StatusO11unavailableA2EmF":{"name":"unavailable","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html":{"name":"Status","abstract":"

The current status of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV4nameSSvp":{"name":"name","abstract":"

The name of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV11descriptionSSvp":{"name":"description","abstract":"

The description of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV8languageSSvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV8metadatas10DictionaryVySSAA4JSONOGvp":{"name":"metadata","abstract":"

Any metadata that is required by the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The workspace ID.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV6statusSSvp":{"name":"status","abstract":"

The current status of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV14learningOptOutSbvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV7intentsSayAA06IntentD0VGSgvp":{"name":"intents","abstract":"

An array of intents.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV8entitiesSayAA06EntityD0VGSgvp":{"name":"entities","abstract":"

An array of entities.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV15counterexamplesSayAA14CounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of counterexamples.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV11dialogNodesSayAA10DialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects describing the dialog nodes in the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceCollection.html#/s:14ConversationV119WorkspaceCollectionV10workspacesSayAA0C0VGvp":{"name":"workspaces","abstract":"

An array of objects describing the workspaces associated with the service instance.

","parent_name":"WorkspaceCollection"},"Structs/WorkspaceCollection.html#/s:14ConversationV119WorkspaceCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

An object defining the pagination data for the returned objects.

","parent_name":"WorkspaceCollection"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV4nameSSvp":{"name":"name","abstract":"

The name of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV8languageSSvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The workspace ID.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

","parent_name":"Workspace"},"Structs/ValueExport/ValueType.html#/s:14ConversationV111ValueExportV0C4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/ValueExport/ValueType.html#/s:14ConversationV111ValueExportV0C4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/ValueExport/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV9valueTextSSvp":{"name":"valueText","abstract":"

The text of the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array containing any patterns for the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV9valueTypeSSvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"ValueExport"},"Structs/ValueCollection.html#/s:14ConversationV115ValueCollectionV6valuesSayAA0C6ExportVGvp":{"name":"values","abstract":"

An array of entity values.

","parent_name":"ValueCollection"},"Structs/ValueCollection.html#/s:14ConversationV115ValueCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

An object defining the pagination data for the returned objects.

","parent_name":"ValueCollection"},"Structs/Value/ValueType.html#/s:14ConversationV15ValueV0C4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/Value/ValueType.html#/s:14ConversationV15ValueV0C4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/Value/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV9valueTextSSvp":{"name":"valueText","abstract":"

The text of the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array containing any patterns for the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV9valueTypeSSvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"Value"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV4nameSSSgvp":{"name":"name","abstract":"

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV8languageSSSgvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV7intentsSayAA12CreateIntentVGSgvp":{"name":"intents","abstract":"

An array of objects defining the intents for the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV8entitiesSayAA12CreateEntityVGSgvp":{"name":"entities","abstract":"

An array of objects defining the entities for the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV11dialogNodesSayAA16CreateDialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects defining the nodes in the workspace dialog.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV15counterexamplesSayAA20CreateCounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of objects defining input examples that have been marked as irrelevant input.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceVACSSSg4name_AD11descriptionAD8languageSayAA12CreateIntentVGSg7intentsSayAA0H6EntityVGSg8entitiesSayAA0H10DialogNodeVGSg11dialogNodesSayAA0H14CounterexampleVGSg15counterexampless10DictionaryVySSAA4JSONOGSg8metadataSbSg14learningOptOuttcfc":{"name":"init(name:description:language:intents:entities:dialogNodes:counterexamples:metadata:learningOptOut:)","abstract":"

Initialize a UpdateWorkspace with member variables.

","parent_name":"UpdateWorkspace"},"Structs/UpdateValue/ValueType.html#/s:14ConversationV111UpdateValueV0D4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/UpdateValue/ValueType.html#/s:14ConversationV111UpdateValueV0D4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/UpdateValue/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueV5valueSSSgvp":{"name":"value","abstract":"

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueV9valueTypeSSSgvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following resrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueVACSSSg5value_s10DictionaryVySSAA4JSONOGSg8metadataAD0E4TypeSaySSGSg8synonymsAO8patternstcfc":{"name":"init(value:metadata:valueType:synonyms:patterns:)","abstract":"

Initialize a UpdateValue with member variables.

","parent_name":"UpdateValue"},"Structs/UpdateSynonym.html#/s:14ConversationV113UpdateSynonymV7synonymSSSgvp":{"name":"synonym","abstract":"

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"UpdateSynonym"},"Structs/UpdateSynonym.html#/s:14ConversationV113UpdateSynonymVACSSSg7synonym_tcfc":{"name":"init(synonym:)","abstract":"

Initialize a UpdateSynonym with member variables.

","parent_name":"UpdateSynonym"},"Structs/UpdateIntent.html#/s:14ConversationV112UpdateIntentV6intentSSSgvp":{"name":"intent","abstract":"

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:14ConversationV112UpdateIntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:14ConversationV112UpdateIntentV8examplesSayAA13CreateExampleVGSgvp":{"name":"examples","abstract":"

An array of user input examples for the intent.

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:14ConversationV112UpdateIntentVACSSSg6intent_AD11descriptionSayAA13CreateExampleVGSg8examplestcfc":{"name":"init(intent:description:examples:)","abstract":"

Initialize a UpdateIntent with member variables.

","parent_name":"UpdateIntent"},"Structs/UpdateExample.html#/s:14ConversationV113UpdateExampleV4textSSSgvp":{"name":"text","abstract":"

The text of the user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

","parent_name":"UpdateExample"},"Structs/UpdateExample.html#/s:14ConversationV113UpdateExampleVACSSSg4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a UpdateExample with member variables.

","parent_name":"UpdateExample"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityV6entitySSSgvp":{"name":"entity","abstract":"

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether to use fuzzy matching for the entity.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityV6valuesSayAA11CreateValueVGSgvp":{"name":"values","abstract":"

An array of entity values.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityVACSSSg6entity_AD11descriptions10DictionaryVySSAA4JSONOGSg8metadataSbSg10fuzzyMatchSayAA11CreateValueVGSg6valuestcfc":{"name":"init(entity:description:metadata:fuzzyMatch:values:)","abstract":"

Initialize a UpdateEntity with member variables.

","parent_name":"UpdateEntity"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:14ConversationV116UpdateDialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:14ConversationV116UpdateDialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:14ConversationV116UpdateDialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOut.html#/s:14ConversationV116UpdateDialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressOut.html#/s:14ConversationV116UpdateDialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressOut.html#/s:14ConversationV116UpdateDialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressIn.html#/s:14ConversationV116UpdateDialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/DigressIn.html#/s:14ConversationV116UpdateDialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/DigressIn.html#/s:14ConversationV116UpdateDialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV06dialogE0SSSgvp":{"name":"dialogNode","abstract":"

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous sibling dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context for the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

The metadata for the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV8nextStepAA0de4NextG0VSgvp":{"name":"nextStep","abstract":"

The next step to be executed in dialog processing.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV7actionsSayAA0dE6ActionVGSgvp":{"name":"actions","abstract":"

An array of objects describing any actions to be invoked by the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeVACSSSg06dialogE0_AD11descriptionAD10conditionsAD6parentAD15previousSiblings10DictionaryVySSAA4JSONOGSg6outputAO7contextAO8metadataAA0dE8NextStepVSg04nextR0AD5titleAD8nodeTypeAD9eventNameAD8variableSayAA0dE6ActionVGSg7actionsAD9digressInAD10digressOutAD15digressOutSlotstcfc":{"name":"init(dialogNode:description:conditions:parent:previousSibling:output:context:metadata:nextStep:title:nodeType:eventName:variable:actions:digressIn:digressOut:digressOutSlots:)","abstract":"

Initialize a UpdateDialogNode with member variables.

","parent_name":"UpdateDialogNode"},"Structs/UpdateCounterexample.html#/s:14ConversationV120UpdateCounterexampleV4textSSSgvp":{"name":"text","abstract":"

The text of a user input counterexample.

","parent_name":"UpdateCounterexample"},"Structs/UpdateCounterexample.html#/s:14ConversationV120UpdateCounterexampleVACSSSg4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a UpdateCounterexample with member variables.

","parent_name":"UpdateCounterexample"},"Structs/SystemResponse.html#/s:14ConversationV114SystemResponseV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:14ConversationV114SystemResponseVACs10DictionaryVySSAA4JSONOG20additionalProperties_tcfc":{"name":"init(additionalProperties:)","abstract":"

Initialize a SystemResponse.

","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"SystemResponse"},"Structs/SynonymCollection.html#/s:14ConversationV117SynonymCollectionV8synonymsSayAA0C0VGvp":{"name":"synonyms","abstract":"

An array of synonyms.

","parent_name":"SynonymCollection"},"Structs/SynonymCollection.html#/s:14ConversationV117SynonymCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"SynonymCollection"},"Structs/Synonym.html#/s:14ConversationV17SynonymV11synonymTextSSvp":{"name":"synonymText","abstract":"

The text of the synonym.

","parent_name":"Synonym"},"Structs/Synonym.html#/s:14ConversationV17SynonymV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the synonym.

","parent_name":"Synonym"},"Structs/Synonym.html#/s:14ConversationV17SynonymV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the most recent update to the synonym.

","parent_name":"Synonym"},"Structs/RuntimeIntent.html#/s:14ConversationV113RuntimeIntentV6intentSSvp":{"name":"intent","abstract":"

The name of the recognized intent.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:14ConversationV113RuntimeIntentV10confidenceSdvp":{"name":"confidence","abstract":"

A decimal percentage that represents Watson’s confidence in the intent.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:14ConversationV113RuntimeIntentV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:14ConversationV113RuntimeIntentVACSS6intent_Sd10confidences10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(intent:confidence:additionalProperties:)","abstract":"

Initialize a RuntimeIntent with member variables.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"RuntimeIntent"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV6entitySSvp":{"name":"entity","abstract":"

An entity detected in the input.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV8locationSaySiGvp":{"name":"location","abstract":"

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV5valueSSvp":{"name":"value","abstract":"

The term in the input text that was recognized as an entity value.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV10confidenceSdSgvp":{"name":"confidence","abstract":"

A decimal percentage that represents Watson’s confidence in the entity.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata for the entity.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV6groupsSayAA12CaptureGroupVGSgvp":{"name":"groups","abstract":"

The recognized capture groups for the entity, as defined by the entity pattern.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityVACSS6entity_SaySiG8locationSS5valueSdSg10confidences10DictionaryVySSAA4JSONOGSg8metadataSayAA12CaptureGroupVGSg6groupsAN20additionalPropertiestcfc":{"name":"init(entity:location:value:confidence:metadata:groups:additionalProperties:)","abstract":"

Initialize a RuntimeEntity with member variables.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"RuntimeEntity"},"Structs/Pagination.html#/s:14ConversationV110PaginationV10refreshUrlSSvp":{"name":"refreshUrl","abstract":"

The URL that will return the same page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:14ConversationV110PaginationV7nextUrlSSSgvp":{"name":"nextUrl","abstract":"

The URL that will return the next page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:14ConversationV110PaginationV5totalSiSgvp":{"name":"total","abstract":"

Reserved for future use.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:14ConversationV110PaginationV7matchedSiSgvp":{"name":"matched","abstract":"

Reserved for future use.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:14ConversationV110PaginationV13refreshCursorSSSgvp":{"name":"refreshCursor","abstract":"

A token identifying the current page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:14ConversationV110PaginationV10nextCursorSSSgvp":{"name":"nextCursor","abstract":"

A token identifying the next page of results.

","parent_name":"Pagination"},"Structs/OutputData.html#/s:14ConversationV110OutputDataV11logMessagesSayAA10LogMessageVGvp":{"name":"logMessages","abstract":"

An array of up to 50 messages logged with the request.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:14ConversationV110OutputDataV4textSaySSGvp":{"name":"text","abstract":"

An array of responses to the user.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:14ConversationV110OutputDataV12nodesVisitedSaySSGSgvp":{"name":"nodesVisited","abstract":"

An array of the nodes that were triggered to create the response, in the order in which they were visited. This information is useful for debugging and for tracing the path taken through the node tree.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:14ConversationV110OutputDataV19nodesVisitedDetailsSayAA010DialogNodefG0VGSgvp":{"name":"nodesVisitedDetails","abstract":"

An array of objects containing detailed diagnostic information about the nodes that were triggered during processing of the input message. Included only if nodes_visited_details is set to true in the message request.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:14ConversationV110OutputDataV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:14ConversationV110OutputDataVACSayAA10LogMessageVG11logMessages_SaySSG4textAHSg12nodesVisitedSayAA010DialogNodeK7DetailsVGSg0jkN0s10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(logMessages:text:nodesVisited:nodesVisitedDetails:additionalProperties:)","abstract":"

Initialize a OutputData with member variables.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"OutputData"},"Structs/OutputData.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"OutputData"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV5inputAA0C5InputVSgvp":{"name":"input","abstract":"

The user input from the request.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV7intentsSayAA13RuntimeIntentVGvp":{"name":"intents","abstract":"

An array of intents recognized in the user input, sorted in descending order of confidence.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV8entitiesSayAA13RuntimeEntityVGvp":{"name":"entities","abstract":"

An array of entities identified in the user input.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV16alternateIntentsSbSgvp":{"name":"alternateIntents","abstract":"

Whether to return more than one intent. A value of true indicates that all matching intents are returned.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV7contextAA7ContextVvp":{"name":"context","abstract":"

State information for the conversation.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV6outputAA10OutputDataVvp":{"name":"output","abstract":"

Output from the dialog, including the response to the user, the nodes that were triggered, and log messages.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"MessageResponse"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV5inputAA9InputDataVSgvp":{"name":"input","abstract":"

An input object that includes the input text.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV16alternateIntentsSbSgvp":{"name":"alternateIntents","abstract":"

Whether to return more than one intent. Set to true to return all matching intents.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV7contextAA7ContextVSgvp":{"name":"context","abstract":"

State information for the conversation. Continue a conversation by including the context object from the previous response.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV8entitiesSayAA13RuntimeEntityVGSgvp":{"name":"entities","abstract":"

Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV7intentsSayAA13RuntimeIntentVGSgvp":{"name":"intents","abstract":"

Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV6outputAA10OutputDataVSgvp":{"name":"output","abstract":"

System output. Include the output from the previous response to maintain intermediate information over multiple requests.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestVAcA9InputDataVSg5input_SbSg16alternateIntentsAA7ContextVSg7contextSayAA13RuntimeEntityVGSg8entitiesSayAA0L6IntentVGSg7intentsAA06OutputF0VSg6outputtcfc":{"name":"init(input:alternateIntents:context:entities:intents:output:)","abstract":"

Initialize a MessageRequest with member variables.

","parent_name":"MessageRequest"},"Structs/MessageInput.html#/s:14ConversationV112MessageInputV4textSSSgvp":{"name":"text","abstract":"

The user’s input.

","parent_name":"MessageInput"},"Structs/LogPagination.html#/s:14ConversationV113LogPaginationV7nextUrlSSSgvp":{"name":"nextUrl","abstract":"

The URL that will return the next page of results, if any.

","parent_name":"LogPagination"},"Structs/LogPagination.html#/s:14ConversationV113LogPaginationV7matchedSiSgvp":{"name":"matched","abstract":"

Reserved for future use.

","parent_name":"LogPagination"},"Structs/LogPagination.html#/s:14ConversationV113LogPaginationV10nextCursorSSSgvp":{"name":"nextCursor","abstract":"

A token identifying the next page of results.

","parent_name":"LogPagination"},"Structs/LogMessage/Level.html#/s:14ConversationV110LogMessageV5LevelO4infoA2EmF":{"name":"info","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html#/s:14ConversationV110LogMessageV5LevelO5errorA2EmF":{"name":"error","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html#/s:14ConversationV110LogMessageV5LevelO4warnA2EmF":{"name":"warn","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html":{"name":"Level","abstract":"

The severity of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:14ConversationV110LogMessageV5levelSSvp":{"name":"level","abstract":"

The severity of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:14ConversationV110LogMessageV3msgSSvp":{"name":"msg","abstract":"

The text of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:14ConversationV110LogMessageV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:14ConversationV110LogMessageVACSS5level_SS3msgs10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(level:msg:additionalProperties:)","abstract":"

Initialize a LogMessage with member variables.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"LogMessage"},"Structs/LogExport.html#/s:14ConversationV19LogExportV7requestAA14MessageRequestVvp":{"name":"request","abstract":"

A request received by the workspace, including the user input and context.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV8responseAA15MessageResponseVvp":{"name":"response","abstract":"

The response sent by the workspace, including the output text, detected intents and entities, and context.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV5logIDSSvp":{"name":"logID","abstract":"

A unique identifier for the logged event.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV16requestTimestampSSvp":{"name":"requestTimestamp","abstract":"

The timestamp for receipt of the message.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV17responseTimestampSSvp":{"name":"responseTimestamp","abstract":"

The timestamp for the system response to the message.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The unique identifier of the workspace where the request was made.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV8languageSSvp":{"name":"language","abstract":"

The language of the workspace where the message request was made.

","parent_name":"LogExport"},"Structs/LogCollection.html#/s:14ConversationV113LogCollectionV4logsSayAA0C6ExportVGvp":{"name":"logs","abstract":"

An array of objects describing log events.

","parent_name":"LogCollection"},"Structs/LogCollection.html#/s:14ConversationV113LogCollectionV10paginationAA0C10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"LogCollection"},"Structs/IntentExport.html#/s:14ConversationV112IntentExportV10intentNameSSvp":{"name":"intentName","abstract":"

The name of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:14ConversationV112IntentExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:14ConversationV112IntentExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:14ConversationV112IntentExportV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:14ConversationV112IntentExportV8examplesSayAA7ExampleVGSgvp":{"name":"examples","abstract":"

An array of objects describing the user input examples for the intent.

","parent_name":"IntentExport"},"Structs/IntentCollection.html#/s:14ConversationV116IntentCollectionV7intentsSayAA0C6ExportVGvp":{"name":"intents","abstract":"

An array of objects describing the intents defined for the workspace.

","parent_name":"IntentCollection"},"Structs/IntentCollection.html#/s:14ConversationV116IntentCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"IntentCollection"},"Structs/Intent.html#/s:14ConversationV16IntentV10intentNameSSvp":{"name":"intentName","abstract":"

The name of the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:14ConversationV16IntentV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:14ConversationV16IntentV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:14ConversationV16IntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"Intent"},"Structs/InputData.html#/s:14ConversationV19InputDataV4textSSvp":{"name":"text","abstract":"

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

","parent_name":"InputData"},"Structs/InputData.html#/s:14ConversationV19InputDataVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a InputData with member variables.

","parent_name":"InputData"},"Structs/ExampleCollection.html#/s:14ConversationV117ExampleCollectionV8examplesSayAA0C0VGvp":{"name":"examples","abstract":"

An array of objects describing the examples defined for the intent.

","parent_name":"ExampleCollection"},"Structs/ExampleCollection.html#/s:14ConversationV117ExampleCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"ExampleCollection"},"Structs/Example.html#/s:14ConversationV17ExampleV11exampleTextSSvp":{"name":"exampleText","abstract":"

The text of the user input example.

","parent_name":"Example"},"Structs/Example.html#/s:14ConversationV17ExampleV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the example.

","parent_name":"Example"},"Structs/Example.html#/s:14ConversationV17ExampleV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the example.

","parent_name":"Example"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV10entityNameSSvp":{"name":"entityName","abstract":"

The name of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether fuzzy matching is used for the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV6valuesSayAA05ValueD0VGSgvp":{"name":"values","abstract":"

An array objects describing the entity values.

","parent_name":"EntityExport"},"Structs/EntityCollection.html#/s:14ConversationV116EntityCollectionV8entitiesSayAA0C6ExportVGvp":{"name":"entities","abstract":"

An array of objects describing the entities defined for the workspace.

","parent_name":"EntityCollection"},"Structs/EntityCollection.html#/s:14ConversationV116EntityCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"EntityCollection"},"Structs/Entity.html#/s:14ConversationV16EntityV10entityNameSSvp":{"name":"entityName","abstract":"

The name of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:14ConversationV16EntityV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:14ConversationV16EntityV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:14ConversationV16EntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:14ConversationV16EntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:14ConversationV16EntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether fuzzy matching is used for the entity.

","parent_name":"Entity"},"Structs/DialogNodeVisitedDetails.html#/s:14ConversationV124DialogNodeVisitedDetailsV06dialogD0SSSgvp":{"name":"dialogNode","abstract":"

A dialog node that was triggered during processing of the input message.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:14ConversationV124DialogNodeVisitedDetailsV5titleSSSgvp":{"name":"title","abstract":"

The title of the dialog node.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:14ConversationV124DialogNodeVisitedDetailsV10conditionsSSSgvp":{"name":"conditions","abstract":"

The conditions that trigger the dialog node.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:14ConversationV124DialogNodeVisitedDetailsVACSSSg06dialogD0_AD5titleAD10conditionstcfc":{"name":"init(dialogNode:title:conditions:)","abstract":"

Initialize a DialogNodeVisitedDetails with member variables.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeNextStep/Selector.html#/s:14ConversationV118DialogNodeNextStepV8SelectorO9conditionA2EmF":{"name":"condition","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:14ConversationV118DialogNodeNextStepV8SelectorO6clientA2EmF":{"name":"client","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:14ConversationV118DialogNodeNextStepV8SelectorO9userInputA2EmF":{"name":"userInput","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:14ConversationV118DialogNodeNextStepV8SelectorO4bodyA2EmF":{"name":"body","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO12getUserInputA2EmF":{"name":"getUserInput","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO13skipUserInputA2EmF":{"name":"skipUserInput","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO6jumpToA2EmF":{"name":"jumpTo","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO8repromptA2EmF":{"name":"reprompt","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO8skipSlotA2EmF":{"name":"skipSlot","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO12skipAllSlotsA2EmF":{"name":"skipAllSlots","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html":{"name":"Behavior","abstract":"

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep/Selector.html":{"name":"Selector","abstract":"

Which part of the dialog node to process next.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:14ConversationV118DialogNodeNextStepV8behaviorSSvp":{"name":"behavior","abstract":"

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:14ConversationV118DialogNodeNextStepV06dialogD0SSSgvp":{"name":"dialogNode","abstract":"

The ID of the dialog node to process next. This parameter is required if behavior=jump_to.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:14ConversationV118DialogNodeNextStepV8selectorSSSgvp":{"name":"selector","abstract":"

Which part of the dialog node to process next.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:14ConversationV118DialogNodeNextStepVACSS8behavior_SSSg06dialogD0AE8selectortcfc":{"name":"init(behavior:dialogNode:selector:)","abstract":"

Initialize a DialogNodeNextStep with member variables.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeCollection.html#/s:14ConversationV120DialogNodeCollectionV11dialogNodesSayAA0cD0VGvp":{"name":"dialogNodes","abstract":"

An array of objects describing the dialog nodes defined for the workspace.

","parent_name":"DialogNodeCollection"},"Structs/DialogNodeCollection.html#/s:14ConversationV120DialogNodeCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"DialogNodeCollection"},"Structs/DialogNodeAction/ActionType.html#/s:14ConversationV116DialogNodeActionV0E4TypeO6clientA2EmF":{"name":"client","abstract":"

Undocumented

","parent_name":"ActionType"},"Structs/DialogNodeAction/ActionType.html#/s:14ConversationV116DialogNodeActionV0E4TypeO6serverA2EmF":{"name":"server","abstract":"

Undocumented

","parent_name":"ActionType"},"Structs/DialogNodeAction/ActionType.html":{"name":"ActionType","abstract":"

The type of action to invoke.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionV4nameSSvp":{"name":"name","abstract":"

The name of the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionV10actionTypeSSSgvp":{"name":"actionType","abstract":"

The type of action to invoke.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionV10parameterss10DictionaryVySSAA4JSONOGSgvp":{"name":"parameters","abstract":"

A map of key/value pairs to be provided to the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionV14resultVariableSSvp":{"name":"resultVariable","abstract":"

The location in the dialog context where the result of the action is stored.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionV11credentialsSSSgvp":{"name":"credentials","abstract":"

The name of the context variable that the client application will use to pass in credentials for the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionVACSS4name_SS14resultVariableSSSg10actionTypes10DictionaryVySSAA4JSONOGSg10parametersAF11credentialstcfc":{"name":"init(name:resultVariable:actionType:parameters:credentials:)","abstract":"

Initialize a DialogNodeAction with member variables.

","parent_name":"DialogNodeAction"},"Structs/DialogNode/DigressOutSlots.html#/s:14ConversationV110DialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOutSlots.html#/s:14ConversationV110DialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOutSlots.html#/s:14ConversationV110DialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOut.html#/s:14ConversationV110DialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressOut.html#/s:14ConversationV110DialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressOut.html#/s:14ConversationV110DialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressIn.html#/s:14ConversationV110DialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/DigressIn.html#/s:14ConversationV110DialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/DigressIn.html#/s:14ConversationV110DialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV06dialogD2IDSSvp":{"name":"dialogNodeID","abstract":"

The dialog node ID.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that triggers the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node. This property is not returned if the dialog node has no parent.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous sibling dialog node. This property is not returned if the dialog node has no previous sibling.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context (if defined) for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV8nextStepAA0cd4NextF0VSgvp":{"name":"nextStep","abstract":"

The next step to execute following this dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the most recent update to the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV7actionsSayAA0cD6ActionVGSgvp":{"name":"actions","abstract":"

The actions for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"DialogNode"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV4nameSSSgvp":{"name":"name","abstract":"

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV8languageSSSgvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV7intentsSayAA0C6IntentVGSgvp":{"name":"intents","abstract":"

An array of objects defining the intents for the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV8entitiesSayAA0C6EntityVGSgvp":{"name":"entities","abstract":"

An array of objects defining the entities for the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV11dialogNodesSayAA0C10DialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects defining the nodes in the workspace dialog.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV15counterexamplesSayAA0C14CounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of objects defining input examples that have been marked as irrelevant input.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceVACSSSg4name_AD11descriptionAD8languageSayAA0C6IntentVGSg7intentsSayAA0C6EntityVGSg8entitiesSayAA0C10DialogNodeVGSg11dialogNodesSayAA0C14CounterexampleVGSg15counterexampless10DictionaryVySSAA4JSONOGSg8metadataSbSg14learningOptOuttcfc":{"name":"init(name:description:language:intents:entities:dialogNodes:counterexamples:metadata:learningOptOut:)","abstract":"

Initialize a CreateWorkspace with member variables.

","parent_name":"CreateWorkspace"},"Structs/CreateValue/ValueType.html#/s:14ConversationV111CreateValueV0D4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/CreateValue/ValueType.html#/s:14ConversationV111CreateValueV0D4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/CreateValue/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueV5valueSSvp":{"name":"value","abstract":"

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueV9valueTypeSSSgvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueVACSS5value_s10DictionaryVySSAA4JSONOGSg8metadataSaySSGSg8synonymsAM8patternsSSSg0E4Typetcfc":{"name":"init(value:metadata:synonyms:patterns:valueType:)","abstract":"

Initialize a CreateValue with member variables.

","parent_name":"CreateValue"},"Structs/CreateSynonym.html#/s:14ConversationV113CreateSynonymV7synonymSSvp":{"name":"synonym","abstract":"

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"CreateSynonym"},"Structs/CreateSynonym.html#/s:14ConversationV113CreateSynonymVACSS7synonym_tcfc":{"name":"init(synonym:)","abstract":"

Initialize a CreateSynonym with member variables.

","parent_name":"CreateSynonym"},"Structs/CreateIntent.html#/s:14ConversationV112CreateIntentV6intentSSvp":{"name":"intent","abstract":"

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:14ConversationV112CreateIntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:14ConversationV112CreateIntentV8examplesSayAA0C7ExampleVGSgvp":{"name":"examples","abstract":"

An array of user input examples for the intent.

","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:14ConversationV112CreateIntentVACSS6intent_SSSg11descriptionSayAA0C7ExampleVGSg8examplestcfc":{"name":"init(intent:description:examples:)","abstract":"

Initialize a CreateIntent with member variables.

","parent_name":"CreateIntent"},"Structs/CreateExample.html#/s:14ConversationV113CreateExampleV4textSSvp":{"name":"text","abstract":"

The text of a user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

","parent_name":"CreateExample"},"Structs/CreateExample.html#/s:14ConversationV113CreateExampleVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a CreateExample with member variables.

","parent_name":"CreateExample"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityV6entitySSvp":{"name":"entity","abstract":"

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the value.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityV6valuesSayAA0C5ValueVGSgvp":{"name":"values","abstract":"

An array of objects describing the entity values.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether to use fuzzy matching for the entity.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityVACSS6entity_SSSg11descriptions10DictionaryVySSAA4JSONOGSg8metadataSayAA0C5ValueVGSg6valuesSbSg10fuzzyMatchtcfc":{"name":"init(entity:description:metadata:values:fuzzyMatch:)","abstract":"

Initialize a CreateEntity with member variables.

","parent_name":"CreateEntity"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:14ConversationV116CreateDialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:14ConversationV116CreateDialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:14ConversationV116CreateDialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOut.html#/s:14ConversationV116CreateDialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressOut.html#/s:14ConversationV116CreateDialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressOut.html#/s:14ConversationV116CreateDialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressIn.html#/s:14ConversationV116CreateDialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/DigressIn.html#/s:14ConversationV116CreateDialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/DigressIn.html#/s:14ConversationV116CreateDialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV06dialogE0SSvp":{"name":"dialogNode","abstract":"

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context for the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

The metadata for the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV8nextStepAA0de4NextG0VSgvp":{"name":"nextStep","abstract":"

The next step to be executed in dialog processing.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV7actionsSayAA0dE6ActionVGSgvp":{"name":"actions","abstract":"

An array of objects describing any actions to be invoked by the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeVACSS06dialogE0_SSSg11descriptionAE10conditionsAE6parentAE15previousSiblings10DictionaryVySSAA4JSONOGSg6outputAO7contextAO8metadataAA0dE8NextStepVSg04nextR0SayAA0dE6ActionVGSg7actionsAE5titleAE8nodeTypeAE9eventNameAE8variableAE9digressInAE10digressOutAE15digressOutSlotstcfc":{"name":"init(dialogNode:description:conditions:parent:previousSibling:output:context:metadata:nextStep:actions:title:nodeType:eventName:variable:digressIn:digressOut:digressOutSlots:)","abstract":"

Initialize a CreateDialogNode with member variables.

","parent_name":"CreateDialogNode"},"Structs/CreateCounterexample.html#/s:14ConversationV120CreateCounterexampleV4textSSvp":{"name":"text","abstract":"

The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It must be no longer than 1024 characters.

","parent_name":"CreateCounterexample"},"Structs/CreateCounterexample.html#/s:14ConversationV120CreateCounterexampleVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a CreateCounterexample with member variables.

","parent_name":"CreateCounterexample"},"Structs/CounterexampleCollection.html#/s:14ConversationV124CounterexampleCollectionV15counterexamplesSayAA0C0VGvp":{"name":"counterexamples","abstract":"

An array of objects describing the examples marked as irrelevant input.

","parent_name":"CounterexampleCollection"},"Structs/CounterexampleCollection.html#/s:14ConversationV124CounterexampleCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"CounterexampleCollection"},"Structs/Counterexample.html#/s:14ConversationV114CounterexampleV4textSSvp":{"name":"text","abstract":"

The text of the counterexample.

","parent_name":"Counterexample"},"Structs/Counterexample.html#/s:14ConversationV114CounterexampleV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the counterexample.

","parent_name":"Counterexample"},"Structs/Counterexample.html#/s:14ConversationV114CounterexampleV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the counterexample.

","parent_name":"Counterexample"},"Structs/Context.html#/s:14ConversationV17ContextV14conversationIDSSSgvp":{"name":"conversationID","abstract":"

The unique identifier of the conversation.

","parent_name":"Context"},"Structs/Context.html#/s:14ConversationV17ContextV6systemAA14SystemResponseVSgvp":{"name":"system","abstract":"

For internal use only.

","parent_name":"Context"},"Structs/Context.html#/s:14ConversationV17ContextV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"Context"},"Structs/Context.html#/s:14ConversationV17ContextVACSSSg14conversationID_AA14SystemResponseVSg6systems10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(conversationID:system:additionalProperties:)","abstract":"

Initialize a Context with member variables.

","parent_name":"Context"},"Structs/Context.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"Context"},"Structs/Context.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"Context"},"Structs/CaptureGroup.html#/s:14ConversationV112CaptureGroupV5groupSSvp":{"name":"group","abstract":"

A recognized capture group for the entity.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html#/s:14ConversationV112CaptureGroupV8locationSaySiGSgvp":{"name":"location","abstract":"

Zero-based character offsets that indicate where the entity value begins and ends in the input text.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html#/s:14ConversationV112CaptureGroupVACSS5group_SaySiGSg8locationtcfc":{"name":"init(group:location:)","abstract":"

Initialize a CaptureGroup with member variables.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html":{"name":"CaptureGroup","abstract":"

CaptureGroup.

"},"Structs/Context.html":{"name":"Context","abstract":"

State information for the conversation. To maintain state, include the context from the previous response.

"},"Structs/Counterexample.html":{"name":"Counterexample","abstract":"

Counterexample.

"},"Structs/CounterexampleCollection.html":{"name":"CounterexampleCollection","abstract":"

CounterexampleCollection.

"},"Structs/CreateCounterexample.html":{"name":"CreateCounterexample","abstract":"

CreateCounterexample.

"},"Structs/CreateDialogNode.html":{"name":"CreateDialogNode","abstract":"

CreateDialogNode.

"},"Structs/CreateEntity.html":{"name":"CreateEntity","abstract":"

CreateEntity.

"},"Structs/CreateExample.html":{"name":"CreateExample","abstract":"

CreateExample.

"},"Structs/CreateIntent.html":{"name":"CreateIntent","abstract":"

CreateIntent.

"},"Structs/CreateSynonym.html":{"name":"CreateSynonym","abstract":"

CreateSynonym.

"},"Structs/CreateValue.html":{"name":"CreateValue","abstract":"

CreateValue.

"},"Structs/CreateWorkspace.html":{"name":"CreateWorkspace","abstract":"

CreateWorkspace.

"},"Structs/DialogNode.html":{"name":"DialogNode","abstract":"

DialogNode.

"},"Structs/DialogNodeAction.html":{"name":"DialogNodeAction","abstract":"

DialogNodeAction.

"},"Structs/DialogNodeCollection.html":{"name":"DialogNodeCollection","abstract":"

An array of dialog nodes.

"},"Structs/DialogNodeNextStep.html":{"name":"DialogNodeNextStep","abstract":"

The next step to execute following this dialog node.

"},"Structs/DialogNodeVisitedDetails.html":{"name":"DialogNodeVisitedDetails","abstract":"

DialogNodeVisitedDetails.

"},"Structs/Entity.html":{"name":"Entity","abstract":"

Entity.

"},"Structs/EntityCollection.html":{"name":"EntityCollection","abstract":"

An array of entities.

"},"Structs/EntityExport.html":{"name":"EntityExport","abstract":"

EntityExport.

"},"Structs/Example.html":{"name":"Example","abstract":"

Example.

"},"Structs/ExampleCollection.html":{"name":"ExampleCollection","abstract":"

ExampleCollection.

"},"Structs/InputData.html":{"name":"InputData","abstract":"

The user input.

"},"Structs/Intent.html":{"name":"Intent","abstract":"

Intent.

"},"Structs/IntentCollection.html":{"name":"IntentCollection","abstract":"

IntentCollection.

"},"Structs/IntentExport.html":{"name":"IntentExport","abstract":"

IntentExport.

"},"Structs/LogCollection.html":{"name":"LogCollection","abstract":"

LogCollection.

"},"Structs/LogExport.html":{"name":"LogExport","abstract":"

LogExport.

"},"Structs/LogMessage.html":{"name":"LogMessage","abstract":"

Log message details.

"},"Structs/LogPagination.html":{"name":"LogPagination","abstract":"

The pagination data for the returned objects.

"},"Structs/MessageInput.html":{"name":"MessageInput","abstract":"

The text of the user input.

"},"Structs/MessageRequest.html":{"name":"MessageRequest","abstract":"

A request formatted for the Conversation service.

"},"Structs/MessageResponse.html":{"name":"MessageResponse","abstract":"

A response from the Conversation service.

"},"Structs/OutputData.html":{"name":"OutputData","abstract":"

An output object that includes the response to the user, the nodes that were hit, and messages from the log.

"},"Structs/Pagination.html":{"name":"Pagination","abstract":"

The pagination data for the returned objects.

"},"Structs/RuntimeEntity.html":{"name":"RuntimeEntity","abstract":"

A term from the request that was identified as an entity.

"},"Structs/RuntimeIntent.html":{"name":"RuntimeIntent","abstract":"

An intent identified in the user input.

"},"Structs/Synonym.html":{"name":"Synonym","abstract":"

Synonym.

"},"Structs/SynonymCollection.html":{"name":"SynonymCollection","abstract":"

SynonymCollection.

"},"Structs/SystemResponse.html":{"name":"SystemResponse","abstract":"

For internal use only.

"},"Structs/UpdateCounterexample.html":{"name":"UpdateCounterexample","abstract":"

UpdateCounterexample.

"},"Structs/UpdateDialogNode.html":{"name":"UpdateDialogNode","abstract":"

UpdateDialogNode.

"},"Structs/UpdateEntity.html":{"name":"UpdateEntity","abstract":"

UpdateEntity.

"},"Structs/UpdateExample.html":{"name":"UpdateExample","abstract":"

UpdateExample.

"},"Structs/UpdateIntent.html":{"name":"UpdateIntent","abstract":"

UpdateIntent.

"},"Structs/UpdateSynonym.html":{"name":"UpdateSynonym","abstract":"

UpdateSynonym.

"},"Structs/UpdateValue.html":{"name":"UpdateValue","abstract":"

UpdateValue.

"},"Structs/UpdateWorkspace.html":{"name":"UpdateWorkspace","abstract":"

UpdateWorkspace.

"},"Structs/Value.html":{"name":"Value","abstract":"

Value.

"},"Structs/ValueCollection.html":{"name":"ValueCollection","abstract":"

ValueCollection.

"},"Structs/ValueExport.html":{"name":"ValueExport","abstract":"

ValueExport.

"},"Structs/Workspace.html":{"name":"Workspace","abstract":"

Workspace.

"},"Structs/WorkspaceCollection.html":{"name":"WorkspaceCollection","abstract":"

WorkspaceCollection.

"},"Structs/WorkspaceExport.html":{"name":"WorkspaceExport","abstract":"

WorkspaceExport.

"},"Structs.html#/s:14ConversationV111JSONWrapperV":{"name":"JSONWrapper","abstract":"

Used internally to serialize and deserialize JSON."},"Enums/RestError.html#/s:14ConversationV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO013serializationD0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO08encodingD0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO011fileManagerD0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:14ConversationV14JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/Conversation.html#/s:14ConversationV10A0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

Create a Conversation object.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a Conversation object.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a Conversation object.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C7messageySS11workspaceID_AA14MessageRequestVSg7requestSbSg19nodesVisitedDetailss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F8ResponseVc7successtF":{"name":"message(workspaceID:request:nodesVisitedDetails:headers:failure:success:)","abstract":"

Get response to user input.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C14listWorkspacesySiSg9pageLimit_SbSg12includeCountSSSg4sortAI6cursorAG0G5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA19WorkspaceCollectionVc7successtF":{"name":"listWorkspaces(pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List workspaces.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C15createWorkspaceyAA06CreateD0VSg10properties_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createWorkspace(properties:headers:failure:success:)","abstract":"

Create workspace.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12getWorkspaceySS11workspaceID_SbSg6exportAF12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getWorkspace(workspaceID:export:includeAudit:headers:failure:success:)","abstract":"

Get information about a workspace.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C15updateWorkspaceySS11workspaceID_AA06UpdateD0VSg10propertiesSbSg6appends10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateWorkspace(workspaceID:properties:append:headers:failure:success:)","abstract":"

Update workspace.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C15deleteWorkspaceySS11workspaceID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteWorkspace(workspaceID:headers:failure:success:)","abstract":"

Delete workspace.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11listIntentsySS11workspaceID_SbSg6exportSiSg9pageLimitAF12includeCountSSSg4sortAK6cursorAF0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA16IntentCollectionVc7successtF":{"name":"listIntents(workspaceID:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List intents.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12createIntentySS11workspaceID_SS6intentSSSg11descriptionSayAA13CreateExampleVGSg8exampless10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createIntent(workspaceID:intent:description:examples:headers:failure:success:)","abstract":"

Create intent.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C9getIntentySS11workspaceID_SS6intentSbSg6exportAG12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getIntent(workspaceID:intent:export:includeAudit:headers:failure:success:)","abstract":"

Get intent.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12updateIntentySS11workspaceID_SS6intentSSSg03newD0AG0H11DescriptionSayAA13CreateExampleVGSg0H8Exampless10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateIntent(workspaceID:intent:newIntent:newDescription:newExamples:headers:failure:success:)","abstract":"

Update intent.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12deleteIntentySS11workspaceID_SS6intents10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteIntent(workspaceID:intent:headers:failure:success:)","abstract":"

Delete intent.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12listExamplesySS11workspaceID_SS6intentSiSg9pageLimitSbSg12includeCountSSSg4sortAK6cursorAI0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA17ExampleCollectionVc7successtF":{"name":"listExamples(workspaceID:intent:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List user input examples.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13createExampleySS11workspaceID_SS6intentSS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createExample(workspaceID:intent:text:headers:failure:success:)","abstract":"

Create user input example.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C10getExampleySS11workspaceID_SS6intentSS4textSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getExample(workspaceID:intent:text:includeAudit:headers:failure:success:)","abstract":"

Get user input example.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13updateExampleySS11workspaceID_SS6intentSS4textSSSg7newTexts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateExample(workspaceID:intent:text:newText:headers:failure:success:)","abstract":"

Update user input example.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13deleteExampleySS11workspaceID_SS6intentSS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteExample(workspaceID:intent:text:headers:failure:success:)","abstract":"

Delete user input example.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C19listCounterexamplesySS11workspaceID_SiSg9pageLimitSbSg12includeCountSSSg4sortAJ6cursorAH0I5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA24CounterexampleCollectionVc7successtF":{"name":"listCounterexamples(workspaceID:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List counterexamples.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C20createCounterexampleySS11workspaceID_SS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createCounterexample(workspaceID:text:headers:failure:success:)","abstract":"

Create counterexample.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C17getCounterexampleySS11workspaceID_SS4textSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getCounterexample(workspaceID:text:includeAudit:headers:failure:success:)","abstract":"

Get counterexample.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C20updateCounterexampleySS11workspaceID_SS4textSSSg7newTexts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateCounterexample(workspaceID:text:newText:headers:failure:success:)","abstract":"

Update counterexample.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C20deleteCounterexampleySS11workspaceID_SS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteCounterexample(workspaceID:text:headers:failure:success:)","abstract":"

Delete counterexample.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12listEntitiesySS11workspaceID_SbSg6exportSiSg9pageLimitAF12includeCountSSSg4sortAK6cursorAF0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA16EntityCollectionVc7successtF":{"name":"listEntities(workspaceID:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entities.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12createEntityySS11workspaceID_AA06CreateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createEntity(workspaceID:properties:headers:failure:success:)","abstract":"

Create entity.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C9getEntityySS11workspaceID_SS6entitySbSg6exportAG12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getEntity(workspaceID:entity:export:includeAudit:headers:failure:success:)","abstract":"

Get entity.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12updateEntityySS11workspaceID_SS6entityAA06UpdateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateEntity(workspaceID:entity:properties:headers:failure:success:)","abstract":"

Update entity.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12deleteEntityySS11workspaceID_SS6entitys10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteEntity(workspaceID:entity:headers:failure:success:)","abstract":"

Delete entity.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C10listValuesySS11workspaceID_SS6entitySbSg6exportSiSg9pageLimitAG12includeCountSSSg4sortAL6cursorAG0K5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA15ValueCollectionVc7successtF":{"name":"listValues(workspaceID:entity:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entity values.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11createValueySS11workspaceID_SS6entityAA06CreateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createValue(workspaceID:entity:properties:headers:failure:success:)","abstract":"

Add entity value.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C8getValueySS11workspaceID_SS6entitySS5valueSbSg6exportAH12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getValue(workspaceID:entity:value:export:includeAudit:headers:failure:success:)","abstract":"

Get entity value.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11updateValueySS11workspaceID_SS6entitySS5valueAA06UpdateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateValue(workspaceID:entity:value:properties:headers:failure:success:)","abstract":"

Update entity value.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11deleteValueySS11workspaceID_SS6entitySS5values10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteValue(workspaceID:entity:value:headers:failure:success:)","abstract":"

Delete entity value.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12listSynonymsySS11workspaceID_SS6entitySS5valueSiSg9pageLimitSbSg12includeCountSSSg4sortAL6cursorAJ0K5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA17SynonymCollectionVc7successtF":{"name":"listSynonyms(workspaceID:entity:value:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entity value synonyms.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13createSynonymySS11workspaceID_SS6entitySS5valueSS7synonyms10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createSynonym(workspaceID:entity:value:synonym:headers:failure:success:)","abstract":"

Add entity value synonym.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C10getSynonymySS11workspaceID_SS6entitySS5valueSS7synonymSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getSynonym(workspaceID:entity:value:synonym:includeAudit:headers:failure:success:)","abstract":"

Get entity value synonym.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13updateSynonymySS11workspaceID_SS6entitySS5valueSS7synonymSSSg03newD0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateSynonym(workspaceID:entity:value:synonym:newSynonym:headers:failure:success:)","abstract":"

Update entity value synonym.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13deleteSynonymySS11workspaceID_SS6entitySS5valueSS7synonyms10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteSynonym(workspaceID:entity:value:synonym:headers:failure:success:)","abstract":"

Delete entity value synonym.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C15listDialogNodesySS11workspaceID_SiSg9pageLimitSbSg12includeCountSSSg4sortAJ6cursorAH0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D14NodeCollectionVc7successtF":{"name":"listDialogNodes(workspaceID:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List dialog nodes.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C16createDialogNodeySS11workspaceID_AA06CreatedE0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"createDialogNode(workspaceID:properties:headers:failure:success:)","abstract":"

Create dialog node.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13getDialogNodeySS11workspaceID_SS06dialogE0SbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"getDialogNode(workspaceID:dialogNode:includeAudit:headers:failure:success:)","abstract":"

Get dialog node.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C16updateDialogNodeySS11workspaceID_SS06dialogE0AA06UpdatedE0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"updateDialogNode(workspaceID:dialogNode:properties:headers:failure:success:)","abstract":"

Update dialog node.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C16deleteDialogNodeySS11workspaceID_SS06dialogE0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteDialogNode(workspaceID:dialogNode:headers:failure:success:)","abstract":"

Delete dialog node.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C8listLogsySS11workspaceID_SSSg4sortAF6filterSiSg9pageLimitAF6cursors10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA13LogCollectionVc7successtF":{"name":"listLogs(workspaceID:sort:filter:pageLimit:cursor:headers:failure:success:)","abstract":"

List log events in a workspace.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11listAllLogsySS6filter_SSSg4sortSiSg9pageLimitAF6cursors10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA13LogCollectionVc7successtF":{"name":"listAllLogs(filter:sort:pageLimit:cursor:headers:failure:success:)","abstract":"

List log events in all workspaces.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

Delete labeled data.

","parent_name":"Conversation"},"Classes/Conversation.html":{"name":"Conversation","abstract":"

The IBM Watson Conversation service combines machine learning, natural language understanding, and integrated dialog"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file +{"Structs/WorkspaceExport/Status.html#/s:14ConversationV115WorkspaceExportV6StatusO11nonExistentA2EmF":{"name":"nonExistent","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:14ConversationV115WorkspaceExportV6StatusO8trainingA2EmF":{"name":"training","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:14ConversationV115WorkspaceExportV6StatusO6failedA2EmF":{"name":"failed","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:14ConversationV115WorkspaceExportV6StatusO9availableA2EmF":{"name":"available","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:14ConversationV115WorkspaceExportV6StatusO11unavailableA2EmF":{"name":"unavailable","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html":{"name":"Status","abstract":"

The current status of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV4nameSSvp":{"name":"name","abstract":"

The name of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV11descriptionSSvp":{"name":"description","abstract":"

The description of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV8languageSSvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV8metadatas10DictionaryVySSAA4JSONOGvp":{"name":"metadata","abstract":"

Any metadata that is required by the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The workspace ID.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV6statusSSvp":{"name":"status","abstract":"

The current status of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV14learningOptOutSbvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV7intentsSayAA06IntentD0VGSgvp":{"name":"intents","abstract":"

An array of intents.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV8entitiesSayAA06EntityD0VGSgvp":{"name":"entities","abstract":"

An array of entities.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV15counterexamplesSayAA14CounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of counterexamples.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV11dialogNodesSayAA10DialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects describing the dialog nodes in the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceCollection.html#/s:14ConversationV119WorkspaceCollectionV10workspacesSayAA0C0VGvp":{"name":"workspaces","abstract":"

An array of objects describing the workspaces associated with the service instance.

","parent_name":"WorkspaceCollection"},"Structs/WorkspaceCollection.html#/s:14ConversationV119WorkspaceCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

An object defining the pagination data for the returned objects.

","parent_name":"WorkspaceCollection"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV4nameSSvp":{"name":"name","abstract":"

The name of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV8languageSSvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The workspace ID.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for","parent_name":"Workspace"},"Structs/ValueExport/ValueType.html#/s:14ConversationV111ValueExportV0C4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/ValueExport/ValueType.html#/s:14ConversationV111ValueExportV0C4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/ValueExport/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV9valueTextSSvp":{"name":"valueText","abstract":"

The text of the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array containing any patterns for the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV9valueTypeSSvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"ValueExport"},"Structs/ValueCollection.html#/s:14ConversationV115ValueCollectionV6valuesSayAA0C6ExportVGvp":{"name":"values","abstract":"

An array of entity values.

","parent_name":"ValueCollection"},"Structs/ValueCollection.html#/s:14ConversationV115ValueCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

An object defining the pagination data for the returned objects.

","parent_name":"ValueCollection"},"Structs/Value/ValueType.html#/s:14ConversationV15ValueV0C4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/Value/ValueType.html#/s:14ConversationV15ValueV0C4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/Value/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV9valueTextSSvp":{"name":"valueText","abstract":"

The text of the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array containing any patterns for the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV9valueTypeSSvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"Value"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV4nameSSSgvp":{"name":"name","abstract":"

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV8languageSSSgvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV7intentsSayAA12CreateIntentVGSgvp":{"name":"intents","abstract":"

An array of objects defining the intents for the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV8entitiesSayAA12CreateEntityVGSgvp":{"name":"entities","abstract":"

An array of objects defining the entities for the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV11dialogNodesSayAA16CreateDialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects defining the nodes in the workspace dialog.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV15counterexamplesSayAA20CreateCounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of objects defining input examples that have been marked as irrelevant input.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceVACSSSg4name_AD11descriptionAD8languageSayAA12CreateIntentVGSg7intentsSayAA0H6EntityVGSg8entitiesSayAA0H10DialogNodeVGSg11dialogNodesSayAA0H14CounterexampleVGSg15counterexampless10DictionaryVySSAA4JSONOGSg8metadataSbSg14learningOptOuttcfc":{"name":"init(name:description:language:intents:entities:dialogNodes:counterexamples:metadata:learningOptOut:)","abstract":"

Initialize a UpdateWorkspace with member variables.

","parent_name":"UpdateWorkspace"},"Structs/UpdateValue/ValueType.html#/s:14ConversationV111UpdateValueV0D4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/UpdateValue/ValueType.html#/s:14ConversationV111UpdateValueV0D4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/UpdateValue/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueV5valueSSSgvp":{"name":"value","abstract":"

The text of the entity value. This string must conform to the following restrictions:

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueV9valueTypeSSSgvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type),","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type),","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueVACSSSg5value_s10DictionaryVySSAA4JSONOGSg8metadataAD0E4TypeSaySSGSg8synonymsAO8patternstcfc":{"name":"init(value:metadata:valueType:synonyms:patterns:)","abstract":"

Initialize a UpdateValue with member variables.

","parent_name":"UpdateValue"},"Structs/UpdateSynonym.html#/s:14ConversationV113UpdateSynonymV7synonymSSSgvp":{"name":"synonym","abstract":"

The text of the synonym. This string must conform to the following restrictions:

","parent_name":"UpdateSynonym"},"Structs/UpdateSynonym.html#/s:14ConversationV113UpdateSynonymVACSSSg7synonym_tcfc":{"name":"init(synonym:)","abstract":"

Initialize a UpdateSynonym with member variables.

","parent_name":"UpdateSynonym"},"Structs/UpdateIntent.html#/s:14ConversationV112UpdateIntentV6intentSSSgvp":{"name":"intent","abstract":"

The name of the intent. This string must conform to the following restrictions:

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:14ConversationV112UpdateIntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:14ConversationV112UpdateIntentV8examplesSayAA13CreateExampleVGSgvp":{"name":"examples","abstract":"

An array of user input examples for the intent.

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:14ConversationV112UpdateIntentVACSSSg6intent_AD11descriptionSayAA13CreateExampleVGSg8examplestcfc":{"name":"init(intent:description:examples:)","abstract":"

Initialize a UpdateIntent with member variables.

","parent_name":"UpdateIntent"},"Structs/UpdateExample.html#/s:14ConversationV113UpdateExampleV4textSSSgvp":{"name":"text","abstract":"

The text of the user input example. This string must conform to the following restrictions:

","parent_name":"UpdateExample"},"Structs/UpdateExample.html#/s:14ConversationV113UpdateExampleVACSSSg4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a UpdateExample with member variables.

","parent_name":"UpdateExample"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityV6entitySSSgvp":{"name":"entity","abstract":"

The name of the entity. This string must conform to the following restrictions:

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether to use fuzzy matching for the entity.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityV6valuesSayAA11CreateValueVGSgvp":{"name":"values","abstract":"

An array of entity values.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityVACSSSg6entity_AD11descriptions10DictionaryVySSAA4JSONOGSg8metadataSbSg10fuzzyMatchSayAA11CreateValueVGSg6valuestcfc":{"name":"init(entity:description:metadata:fuzzyMatch:values:)","abstract":"

Initialize a UpdateEntity with member variables.

","parent_name":"UpdateEntity"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:14ConversationV116UpdateDialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:14ConversationV116UpdateDialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:14ConversationV116UpdateDialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOut.html#/s:14ConversationV116UpdateDialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressOut.html#/s:14ConversationV116UpdateDialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressOut.html#/s:14ConversationV116UpdateDialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressIn.html#/s:14ConversationV116UpdateDialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/DigressIn.html#/s:14ConversationV116UpdateDialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/DigressIn.html#/s:14ConversationV116UpdateDialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV06dialogE0SSSgvp":{"name":"dialogNode","abstract":"

The dialog node ID. This string must conform to the following restrictions:

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous sibling dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node. For more information about how to specify dialog node output, see the","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context for the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

The metadata for the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV8nextStepAA0de4NextG0VSgvp":{"name":"nextStep","abstract":"

The next step to be executed in dialog processing.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node. This string must conform to the following restrictions:

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV7actionsSayAA0dE6ActionVGSgvp":{"name":"actions","abstract":"

An array of objects describing any actions to be invoked by the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeVACSSSg06dialogE0_AD11descriptionAD10conditionsAD6parentAD15previousSiblings10DictionaryVySSAA4JSONOGSg6outputAO7contextAO8metadataAA0dE8NextStepVSg04nextR0AD5titleAD8nodeTypeAD9eventNameAD8variableSayAA0dE6ActionVGSg7actionsAD9digressInAD10digressOutAD15digressOutSlotstcfc":{"name":"init(dialogNode:description:conditions:parent:previousSibling:output:context:metadata:nextStep:title:nodeType:eventName:variable:actions:digressIn:digressOut:digressOutSlots:)","abstract":"

Initialize a UpdateDialogNode with member variables.

","parent_name":"UpdateDialogNode"},"Structs/UpdateCounterexample.html#/s:14ConversationV120UpdateCounterexampleV4textSSSgvp":{"name":"text","abstract":"

The text of a user input counterexample.

","parent_name":"UpdateCounterexample"},"Structs/UpdateCounterexample.html#/s:14ConversationV120UpdateCounterexampleVACSSSg4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a UpdateCounterexample with member variables.

","parent_name":"UpdateCounterexample"},"Structs/SystemResponse.html#/s:14ConversationV114SystemResponseV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:14ConversationV114SystemResponseVACs10DictionaryVySSAA4JSONOG20additionalProperties_tcfc":{"name":"init(additionalProperties:)","abstract":"

Initialize a SystemResponse.

","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"SystemResponse"},"Structs/SynonymCollection.html#/s:14ConversationV117SynonymCollectionV8synonymsSayAA0C0VGvp":{"name":"synonyms","abstract":"

An array of synonyms.

","parent_name":"SynonymCollection"},"Structs/SynonymCollection.html#/s:14ConversationV117SynonymCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"SynonymCollection"},"Structs/Synonym.html#/s:14ConversationV17SynonymV11synonymTextSSvp":{"name":"synonymText","abstract":"

The text of the synonym.

","parent_name":"Synonym"},"Structs/Synonym.html#/s:14ConversationV17SynonymV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the synonym.

","parent_name":"Synonym"},"Structs/Synonym.html#/s:14ConversationV17SynonymV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the most recent update to the synonym.

","parent_name":"Synonym"},"Structs/RuntimeIntent.html#/s:14ConversationV113RuntimeIntentV6intentSSvp":{"name":"intent","abstract":"

The name of the recognized intent.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:14ConversationV113RuntimeIntentV10confidenceSdvp":{"name":"confidence","abstract":"

A decimal percentage that represents Watson’s confidence in the intent.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:14ConversationV113RuntimeIntentV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:14ConversationV113RuntimeIntentVACSS6intent_Sd10confidences10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(intent:confidence:additionalProperties:)","abstract":"

Initialize a RuntimeIntent with member variables.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"RuntimeIntent"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV6entitySSvp":{"name":"entity","abstract":"

An entity detected in the input.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV8locationSaySiGvp":{"name":"location","abstract":"

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV5valueSSvp":{"name":"value","abstract":"

The term in the input text that was recognized as an entity value.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV10confidenceSdSgvp":{"name":"confidence","abstract":"

A decimal percentage that represents Watson’s confidence in the entity.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata for the entity.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV6groupsSayAA12CaptureGroupVGSgvp":{"name":"groups","abstract":"

The recognized capture groups for the entity, as defined by the entity pattern.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityVACSS6entity_SaySiG8locationSS5valueSdSg10confidences10DictionaryVySSAA4JSONOGSg8metadataSayAA12CaptureGroupVGSg6groupsAN20additionalPropertiestcfc":{"name":"init(entity:location:value:confidence:metadata:groups:additionalProperties:)","abstract":"

Initialize a RuntimeEntity with member variables.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"RuntimeEntity"},"Structs/Pagination.html#/s:14ConversationV110PaginationV10refreshUrlSSvp":{"name":"refreshUrl","abstract":"

The URL that will return the same page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:14ConversationV110PaginationV7nextUrlSSSgvp":{"name":"nextUrl","abstract":"

The URL that will return the next page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:14ConversationV110PaginationV5totalSiSgvp":{"name":"total","abstract":"

Reserved for future use.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:14ConversationV110PaginationV7matchedSiSgvp":{"name":"matched","abstract":"

Reserved for future use.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:14ConversationV110PaginationV13refreshCursorSSSgvp":{"name":"refreshCursor","abstract":"

A token identifying the current page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:14ConversationV110PaginationV10nextCursorSSSgvp":{"name":"nextCursor","abstract":"

A token identifying the next page of results.

","parent_name":"Pagination"},"Structs/OutputData.html#/s:14ConversationV110OutputDataV11logMessagesSayAA10LogMessageVGvp":{"name":"logMessages","abstract":"

An array of up to 50 messages logged with the request.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:14ConversationV110OutputDataV4textSaySSGvp":{"name":"text","abstract":"

An array of responses to the user.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:14ConversationV110OutputDataV12nodesVisitedSaySSGSgvp":{"name":"nodesVisited","abstract":"

An array of the nodes that were triggered to create the response, in the order in which they were visited. This","parent_name":"OutputData"},"Structs/OutputData.html#/s:14ConversationV110OutputDataV19nodesVisitedDetailsSayAA010DialogNodefG0VGSgvp":{"name":"nodesVisitedDetails","abstract":"

An array of objects containing detailed diagnostic information about the nodes that were triggered during","parent_name":"OutputData"},"Structs/OutputData.html#/s:14ConversationV110OutputDataV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:14ConversationV110OutputDataVACSayAA10LogMessageVG11logMessages_SaySSG4textAHSg12nodesVisitedSayAA010DialogNodeK7DetailsVGSg0jkN0s10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(logMessages:text:nodesVisited:nodesVisitedDetails:additionalProperties:)","abstract":"

Initialize a OutputData with member variables.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"OutputData"},"Structs/OutputData.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"OutputData"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV5inputAA0C5InputVSgvp":{"name":"input","abstract":"

The user input from the request.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV7intentsSayAA13RuntimeIntentVGvp":{"name":"intents","abstract":"

An array of intents recognized in the user input, sorted in descending order of confidence.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV8entitiesSayAA13RuntimeEntityVGvp":{"name":"entities","abstract":"

An array of entities identified in the user input.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV16alternateIntentsSbSgvp":{"name":"alternateIntents","abstract":"

Whether to return more than one intent. A value of true indicates that all matching intents are returned.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV7contextAA7ContextVvp":{"name":"context","abstract":"

State information for the conversation.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV6outputAA10OutputDataVvp":{"name":"output","abstract":"

Output from the dialog, including the response to the user, the nodes that were triggered, and log messages.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"MessageResponse"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV5inputAA9InputDataVSgvp":{"name":"input","abstract":"

An input object that includes the input text.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV16alternateIntentsSbSgvp":{"name":"alternateIntents","abstract":"

Whether to return more than one intent. Set to true to return all matching intents.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV7contextAA7ContextVSgvp":{"name":"context","abstract":"

State information for the conversation. Continue a conversation by including the context object from the previous","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV8entitiesSayAA13RuntimeEntityVGSgvp":{"name":"entities","abstract":"

Entities to use when evaluating the message. Include entities from the previous response to continue using those","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV7intentsSayAA13RuntimeIntentVGSgvp":{"name":"intents","abstract":"

Intents to use when evaluating the user input. Include intents from the previous response to continue using those","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV6outputAA10OutputDataVSgvp":{"name":"output","abstract":"

System output. Include the output from the previous response to maintain intermediate information over multiple","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestVAcA9InputDataVSg5input_SbSg16alternateIntentsAA7ContextVSg7contextSayAA13RuntimeEntityVGSg8entitiesSayAA0L6IntentVGSg7intentsAA06OutputF0VSg6outputtcfc":{"name":"init(input:alternateIntents:context:entities:intents:output:)","abstract":"

Initialize a MessageRequest with member variables.

","parent_name":"MessageRequest"},"Structs/MessageInput.html#/s:14ConversationV112MessageInputV4textSSSgvp":{"name":"text","abstract":"

The user’s input.

","parent_name":"MessageInput"},"Structs/LogPagination.html#/s:14ConversationV113LogPaginationV7nextUrlSSSgvp":{"name":"nextUrl","abstract":"

The URL that will return the next page of results, if any.

","parent_name":"LogPagination"},"Structs/LogPagination.html#/s:14ConversationV113LogPaginationV7matchedSiSgvp":{"name":"matched","abstract":"

Reserved for future use.

","parent_name":"LogPagination"},"Structs/LogPagination.html#/s:14ConversationV113LogPaginationV10nextCursorSSSgvp":{"name":"nextCursor","abstract":"

A token identifying the next page of results.

","parent_name":"LogPagination"},"Structs/LogMessage/Level.html#/s:14ConversationV110LogMessageV5LevelO4infoA2EmF":{"name":"info","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html#/s:14ConversationV110LogMessageV5LevelO5errorA2EmF":{"name":"error","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html#/s:14ConversationV110LogMessageV5LevelO4warnA2EmF":{"name":"warn","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html":{"name":"Level","abstract":"

The severity of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:14ConversationV110LogMessageV5levelSSvp":{"name":"level","abstract":"

The severity of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:14ConversationV110LogMessageV3msgSSvp":{"name":"msg","abstract":"

The text of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:14ConversationV110LogMessageV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:14ConversationV110LogMessageVACSS5level_SS3msgs10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(level:msg:additionalProperties:)","abstract":"

Initialize a LogMessage with member variables.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"LogMessage"},"Structs/LogExport.html#/s:14ConversationV19LogExportV7requestAA14MessageRequestVvp":{"name":"request","abstract":"

A request received by the workspace, including the user input and context.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV8responseAA15MessageResponseVvp":{"name":"response","abstract":"

The response sent by the workspace, including the output text, detected intents and entities, and context.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV5logIDSSvp":{"name":"logID","abstract":"

A unique identifier for the logged event.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV16requestTimestampSSvp":{"name":"requestTimestamp","abstract":"

The timestamp for receipt of the message.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV17responseTimestampSSvp":{"name":"responseTimestamp","abstract":"

The timestamp for the system response to the message.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The unique identifier of the workspace where the request was made.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV8languageSSvp":{"name":"language","abstract":"

The language of the workspace where the message request was made.

","parent_name":"LogExport"},"Structs/LogCollection.html#/s:14ConversationV113LogCollectionV4logsSayAA0C6ExportVGvp":{"name":"logs","abstract":"

An array of objects describing log events.

","parent_name":"LogCollection"},"Structs/LogCollection.html#/s:14ConversationV113LogCollectionV10paginationAA0C10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"LogCollection"},"Structs/IntentExport.html#/s:14ConversationV112IntentExportV10intentNameSSvp":{"name":"intentName","abstract":"

The name of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:14ConversationV112IntentExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:14ConversationV112IntentExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:14ConversationV112IntentExportV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:14ConversationV112IntentExportV8examplesSayAA7ExampleVGSgvp":{"name":"examples","abstract":"

An array of objects describing the user input examples for the intent.

","parent_name":"IntentExport"},"Structs/IntentCollection.html#/s:14ConversationV116IntentCollectionV7intentsSayAA0C6ExportVGvp":{"name":"intents","abstract":"

An array of objects describing the intents defined for the workspace.

","parent_name":"IntentCollection"},"Structs/IntentCollection.html#/s:14ConversationV116IntentCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"IntentCollection"},"Structs/Intent.html#/s:14ConversationV16IntentV10intentNameSSvp":{"name":"intentName","abstract":"

The name of the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:14ConversationV16IntentV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:14ConversationV16IntentV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:14ConversationV16IntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"Intent"},"Structs/InputData.html#/s:14ConversationV19InputDataV4textSSvp":{"name":"text","abstract":"

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be","parent_name":"InputData"},"Structs/InputData.html#/s:14ConversationV19InputDataVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a InputData with member variables.

","parent_name":"InputData"},"Structs/ExampleCollection.html#/s:14ConversationV117ExampleCollectionV8examplesSayAA0C0VGvp":{"name":"examples","abstract":"

An array of objects describing the examples defined for the intent.

","parent_name":"ExampleCollection"},"Structs/ExampleCollection.html#/s:14ConversationV117ExampleCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"ExampleCollection"},"Structs/Example.html#/s:14ConversationV17ExampleV11exampleTextSSvp":{"name":"exampleText","abstract":"

The text of the user input example.

","parent_name":"Example"},"Structs/Example.html#/s:14ConversationV17ExampleV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the example.

","parent_name":"Example"},"Structs/Example.html#/s:14ConversationV17ExampleV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the example.

","parent_name":"Example"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV10entityNameSSvp":{"name":"entityName","abstract":"

The name of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether fuzzy matching is used for the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV6valuesSayAA05ValueD0VGSgvp":{"name":"values","abstract":"

An array objects describing the entity values.

","parent_name":"EntityExport"},"Structs/EntityCollection.html#/s:14ConversationV116EntityCollectionV8entitiesSayAA0C6ExportVGvp":{"name":"entities","abstract":"

An array of objects describing the entities defined for the workspace.

","parent_name":"EntityCollection"},"Structs/EntityCollection.html#/s:14ConversationV116EntityCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"EntityCollection"},"Structs/Entity.html#/s:14ConversationV16EntityV10entityNameSSvp":{"name":"entityName","abstract":"

The name of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:14ConversationV16EntityV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:14ConversationV16EntityV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:14ConversationV16EntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:14ConversationV16EntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:14ConversationV16EntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether fuzzy matching is used for the entity.

","parent_name":"Entity"},"Structs/DialogNodeVisitedDetails.html#/s:14ConversationV124DialogNodeVisitedDetailsV06dialogD0SSSgvp":{"name":"dialogNode","abstract":"

A dialog node that was triggered during processing of the input message.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:14ConversationV124DialogNodeVisitedDetailsV5titleSSSgvp":{"name":"title","abstract":"

The title of the dialog node.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:14ConversationV124DialogNodeVisitedDetailsV10conditionsSSSgvp":{"name":"conditions","abstract":"

The conditions that trigger the dialog node.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:14ConversationV124DialogNodeVisitedDetailsVACSSSg06dialogD0_AD5titleAD10conditionstcfc":{"name":"init(dialogNode:title:conditions:)","abstract":"

Initialize a DialogNodeVisitedDetails with member variables.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeNextStep/Selector.html#/s:14ConversationV118DialogNodeNextStepV8SelectorO9conditionA2EmF":{"name":"condition","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:14ConversationV118DialogNodeNextStepV8SelectorO6clientA2EmF":{"name":"client","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:14ConversationV118DialogNodeNextStepV8SelectorO9userInputA2EmF":{"name":"userInput","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:14ConversationV118DialogNodeNextStepV8SelectorO4bodyA2EmF":{"name":"body","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO12getUserInputA2EmF":{"name":"getUserInput","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO13skipUserInputA2EmF":{"name":"skipUserInput","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO6jumpToA2EmF":{"name":"jumpTo","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO8repromptA2EmF":{"name":"reprompt","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO8skipSlotA2EmF":{"name":"skipSlot","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO12skipAllSlotsA2EmF":{"name":"skipAllSlots","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html":{"name":"Behavior","abstract":"

What happens after the dialog node completes. The valid values depend on the node type:

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep/Selector.html":{"name":"Selector","abstract":"

Which part of the dialog node to process next.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:14ConversationV118DialogNodeNextStepV8behaviorSSvp":{"name":"behavior","abstract":"

What happens after the dialog node completes. The valid values depend on the node type:

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:14ConversationV118DialogNodeNextStepV06dialogD0SSSgvp":{"name":"dialogNode","abstract":"

The ID of the dialog node to process next. This parameter is required if behavior=jump_to.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:14ConversationV118DialogNodeNextStepV8selectorSSSgvp":{"name":"selector","abstract":"

Which part of the dialog node to process next.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:14ConversationV118DialogNodeNextStepVACSS8behavior_SSSg06dialogD0AE8selectortcfc":{"name":"init(behavior:dialogNode:selector:)","abstract":"

Initialize a DialogNodeNextStep with member variables.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeCollection.html#/s:14ConversationV120DialogNodeCollectionV11dialogNodesSayAA0cD0VGvp":{"name":"dialogNodes","abstract":"

An array of objects describing the dialog nodes defined for the workspace.

","parent_name":"DialogNodeCollection"},"Structs/DialogNodeCollection.html#/s:14ConversationV120DialogNodeCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"DialogNodeCollection"},"Structs/DialogNodeAction/ActionType.html#/s:14ConversationV116DialogNodeActionV0E4TypeO6clientA2EmF":{"name":"client","abstract":"

Undocumented

","parent_name":"ActionType"},"Structs/DialogNodeAction/ActionType.html#/s:14ConversationV116DialogNodeActionV0E4TypeO6serverA2EmF":{"name":"server","abstract":"

Undocumented

","parent_name":"ActionType"},"Structs/DialogNodeAction/ActionType.html":{"name":"ActionType","abstract":"

The type of action to invoke.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionV4nameSSvp":{"name":"name","abstract":"

The name of the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionV10actionTypeSSSgvp":{"name":"actionType","abstract":"

The type of action to invoke.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionV10parameterss10DictionaryVySSAA4JSONOGSgvp":{"name":"parameters","abstract":"

A map of key/value pairs to be provided to the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionV14resultVariableSSvp":{"name":"resultVariable","abstract":"

The location in the dialog context where the result of the action is stored.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionV11credentialsSSSgvp":{"name":"credentials","abstract":"

The name of the context variable that the client application will use to pass in credentials for the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionVACSS4name_SS14resultVariableSSSg10actionTypes10DictionaryVySSAA4JSONOGSg10parametersAF11credentialstcfc":{"name":"init(name:resultVariable:actionType:parameters:credentials:)","abstract":"

Initialize a DialogNodeAction with member variables.

","parent_name":"DialogNodeAction"},"Structs/DialogNode/DigressOutSlots.html#/s:14ConversationV110DialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOutSlots.html#/s:14ConversationV110DialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOutSlots.html#/s:14ConversationV110DialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOut.html#/s:14ConversationV110DialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressOut.html#/s:14ConversationV110DialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressOut.html#/s:14ConversationV110DialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressIn.html#/s:14ConversationV110DialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/DigressIn.html#/s:14ConversationV110DialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/DigressIn.html#/s:14ConversationV110DialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV06dialogD2IDSSvp":{"name":"dialogNodeID","abstract":"

The dialog node ID.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that triggers the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node. This property is not returned if the dialog node has no parent.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous sibling dialog node. This property is not returned if the dialog node has no previous","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context (if defined) for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV8nextStepAA0cd4NextF0VSgvp":{"name":"nextStep","abstract":"

The next step to execute following this dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the most recent update to the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV7actionsSayAA0cD6ActionVGSgvp":{"name":"actions","abstract":"

The actions for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"DialogNode"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV4nameSSSgvp":{"name":"name","abstract":"

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV8languageSSSgvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV7intentsSayAA0C6IntentVGSgvp":{"name":"intents","abstract":"

An array of objects defining the intents for the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV8entitiesSayAA0C6EntityVGSgvp":{"name":"entities","abstract":"

An array of objects defining the entities for the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV11dialogNodesSayAA0C10DialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects defining the nodes in the workspace dialog.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV15counterexamplesSayAA0C14CounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of objects defining input examples that have been marked as irrelevant input.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceVACSSSg4name_AD11descriptionAD8languageSayAA0C6IntentVGSg7intentsSayAA0C6EntityVGSg8entitiesSayAA0C10DialogNodeVGSg11dialogNodesSayAA0C14CounterexampleVGSg15counterexampless10DictionaryVySSAA4JSONOGSg8metadataSbSg14learningOptOuttcfc":{"name":"init(name:description:language:intents:entities:dialogNodes:counterexamples:metadata:learningOptOut:)","abstract":"

Initialize a CreateWorkspace with member variables.

","parent_name":"CreateWorkspace"},"Structs/CreateValue/ValueType.html#/s:14ConversationV111CreateValueV0D4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/CreateValue/ValueType.html#/s:14ConversationV111CreateValueV0D4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/CreateValue/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueV5valueSSvp":{"name":"value","abstract":"

The text of the entity value. This string must conform to the following restrictions:

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type),","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueV9valueTypeSSSgvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueVACSS5value_s10DictionaryVySSAA4JSONOGSg8metadataSaySSGSg8synonymsAM8patternsSSSg0E4Typetcfc":{"name":"init(value:metadata:synonyms:patterns:valueType:)","abstract":"

Initialize a CreateValue with member variables.

","parent_name":"CreateValue"},"Structs/CreateSynonym.html#/s:14ConversationV113CreateSynonymV7synonymSSvp":{"name":"synonym","abstract":"

The text of the synonym. This string must conform to the following restrictions:

","parent_name":"CreateSynonym"},"Structs/CreateSynonym.html#/s:14ConversationV113CreateSynonymVACSS7synonym_tcfc":{"name":"init(synonym:)","abstract":"

Initialize a CreateSynonym with member variables.

","parent_name":"CreateSynonym"},"Structs/CreateIntent.html#/s:14ConversationV112CreateIntentV6intentSSvp":{"name":"intent","abstract":"

The name of the intent. This string must conform to the following restrictions:

","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:14ConversationV112CreateIntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:14ConversationV112CreateIntentV8examplesSayAA0C7ExampleVGSgvp":{"name":"examples","abstract":"

An array of user input examples for the intent.

","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:14ConversationV112CreateIntentVACSS6intent_SSSg11descriptionSayAA0C7ExampleVGSg8examplestcfc":{"name":"init(intent:description:examples:)","abstract":"

Initialize a CreateIntent with member variables.

","parent_name":"CreateIntent"},"Structs/CreateExample.html#/s:14ConversationV113CreateExampleV4textSSvp":{"name":"text","abstract":"

The text of a user input example. This string must conform to the following restrictions:

","parent_name":"CreateExample"},"Structs/CreateExample.html#/s:14ConversationV113CreateExampleVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a CreateExample with member variables.

","parent_name":"CreateExample"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityV6entitySSvp":{"name":"entity","abstract":"

The name of the entity. This string must conform to the following restrictions:

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the value.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityV6valuesSayAA0C5ValueVGSgvp":{"name":"values","abstract":"

An array of objects describing the entity values.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether to use fuzzy matching for the entity.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityVACSS6entity_SSSg11descriptions10DictionaryVySSAA4JSONOGSg8metadataSayAA0C5ValueVGSg6valuesSbSg10fuzzyMatchtcfc":{"name":"init(entity:description:metadata:values:fuzzyMatch:)","abstract":"

Initialize a CreateEntity with member variables.

","parent_name":"CreateEntity"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:14ConversationV116CreateDialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:14ConversationV116CreateDialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:14ConversationV116CreateDialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOut.html#/s:14ConversationV116CreateDialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressOut.html#/s:14ConversationV116CreateDialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressOut.html#/s:14ConversationV116CreateDialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressIn.html#/s:14ConversationV116CreateDialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/DigressIn.html#/s:14ConversationV116CreateDialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/DigressIn.html#/s:14ConversationV116CreateDialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV06dialogE0SSvp":{"name":"dialogNode","abstract":"

The dialog node ID. This string must conform to the following restrictions:

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node. For more information about how to specify dialog node output, see the","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context for the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

The metadata for the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV8nextStepAA0de4NextG0VSgvp":{"name":"nextStep","abstract":"

The next step to be executed in dialog processing.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV7actionsSayAA0dE6ActionVGSgvp":{"name":"actions","abstract":"

An array of objects describing any actions to be invoked by the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node. This string must conform to the following restrictions:

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeVACSS06dialogE0_SSSg11descriptionAE10conditionsAE6parentAE15previousSiblings10DictionaryVySSAA4JSONOGSg6outputAO7contextAO8metadataAA0dE8NextStepVSg04nextR0SayAA0dE6ActionVGSg7actionsAE5titleAE8nodeTypeAE9eventNameAE8variableAE9digressInAE10digressOutAE15digressOutSlotstcfc":{"name":"init(dialogNode:description:conditions:parent:previousSibling:output:context:metadata:nextStep:actions:title:nodeType:eventName:variable:digressIn:digressOut:digressOutSlots:)","abstract":"

Initialize a CreateDialogNode with member variables.

","parent_name":"CreateDialogNode"},"Structs/CreateCounterexample.html#/s:14ConversationV120CreateCounterexampleV4textSSvp":{"name":"text","abstract":"

The text of a user input marked as irrelevant input. This string must conform to the following restrictions:

","parent_name":"CreateCounterexample"},"Structs/CreateCounterexample.html#/s:14ConversationV120CreateCounterexampleVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a CreateCounterexample with member variables.

","parent_name":"CreateCounterexample"},"Structs/CounterexampleCollection.html#/s:14ConversationV124CounterexampleCollectionV15counterexamplesSayAA0C0VGvp":{"name":"counterexamples","abstract":"

An array of objects describing the examples marked as irrelevant input.

","parent_name":"CounterexampleCollection"},"Structs/CounterexampleCollection.html#/s:14ConversationV124CounterexampleCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"CounterexampleCollection"},"Structs/Counterexample.html#/s:14ConversationV114CounterexampleV4textSSvp":{"name":"text","abstract":"

The text of the counterexample.

","parent_name":"Counterexample"},"Structs/Counterexample.html#/s:14ConversationV114CounterexampleV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the counterexample.

","parent_name":"Counterexample"},"Structs/Counterexample.html#/s:14ConversationV114CounterexampleV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the counterexample.

","parent_name":"Counterexample"},"Structs/Context.html#/s:14ConversationV17ContextV14conversationIDSSSgvp":{"name":"conversationID","abstract":"

The unique identifier of the conversation.

","parent_name":"Context"},"Structs/Context.html#/s:14ConversationV17ContextV6systemAA14SystemResponseVSgvp":{"name":"system","abstract":"

For internal use only.

","parent_name":"Context"},"Structs/Context.html#/s:14ConversationV17ContextV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"Context"},"Structs/Context.html#/s:14ConversationV17ContextVACSSSg14conversationID_AA14SystemResponseVSg6systems10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(conversationID:system:additionalProperties:)","abstract":"

Initialize a Context with member variables.

","parent_name":"Context"},"Structs/Context.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"Context"},"Structs/Context.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"Context"},"Structs/CaptureGroup.html#/s:14ConversationV112CaptureGroupV5groupSSvp":{"name":"group","abstract":"

A recognized capture group for the entity.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html#/s:14ConversationV112CaptureGroupV8locationSaySiGSgvp":{"name":"location","abstract":"

Zero-based character offsets that indicate where the entity value begins and ends in the input text.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html#/s:14ConversationV112CaptureGroupVACSS5group_SaySiGSg8locationtcfc":{"name":"init(group:location:)","abstract":"

Initialize a CaptureGroup with member variables.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html":{"name":"CaptureGroup","abstract":"

CaptureGroup.

"},"Structs/Context.html":{"name":"Context","abstract":"

State information for the conversation. To maintain state, include the context from the previous response.

"},"Structs/Counterexample.html":{"name":"Counterexample","abstract":"

Counterexample.

"},"Structs/CounterexampleCollection.html":{"name":"CounterexampleCollection","abstract":"

CounterexampleCollection.

"},"Structs/CreateCounterexample.html":{"name":"CreateCounterexample","abstract":"

CreateCounterexample.

"},"Structs/CreateDialogNode.html":{"name":"CreateDialogNode","abstract":"

CreateDialogNode.

"},"Structs/CreateEntity.html":{"name":"CreateEntity","abstract":"

CreateEntity.

"},"Structs/CreateExample.html":{"name":"CreateExample","abstract":"

CreateExample.

"},"Structs/CreateIntent.html":{"name":"CreateIntent","abstract":"

CreateIntent.

"},"Structs/CreateSynonym.html":{"name":"CreateSynonym","abstract":"

CreateSynonym.

"},"Structs/CreateValue.html":{"name":"CreateValue","abstract":"

CreateValue.

"},"Structs/CreateWorkspace.html":{"name":"CreateWorkspace","abstract":"

CreateWorkspace.

"},"Structs/DialogNode.html":{"name":"DialogNode","abstract":"

DialogNode.

"},"Structs/DialogNodeAction.html":{"name":"DialogNodeAction","abstract":"

DialogNodeAction.

"},"Structs/DialogNodeCollection.html":{"name":"DialogNodeCollection","abstract":"

An array of dialog nodes.

"},"Structs/DialogNodeNextStep.html":{"name":"DialogNodeNextStep","abstract":"

The next step to execute following this dialog node.

"},"Structs/DialogNodeVisitedDetails.html":{"name":"DialogNodeVisitedDetails","abstract":"

DialogNodeVisitedDetails.

"},"Structs/Entity.html":{"name":"Entity","abstract":"

Entity.

"},"Structs/EntityCollection.html":{"name":"EntityCollection","abstract":"

An array of entities.

"},"Structs/EntityExport.html":{"name":"EntityExport","abstract":"

EntityExport.

"},"Structs/Example.html":{"name":"Example","abstract":"

Example.

"},"Structs/ExampleCollection.html":{"name":"ExampleCollection","abstract":"

ExampleCollection.

"},"Structs/InputData.html":{"name":"InputData","abstract":"

The user input.

"},"Structs/Intent.html":{"name":"Intent","abstract":"

Intent.

"},"Structs/IntentCollection.html":{"name":"IntentCollection","abstract":"

IntentCollection.

"},"Structs/IntentExport.html":{"name":"IntentExport","abstract":"

IntentExport.

"},"Structs/LogCollection.html":{"name":"LogCollection","abstract":"

LogCollection.

"},"Structs/LogExport.html":{"name":"LogExport","abstract":"

LogExport.

"},"Structs/LogMessage.html":{"name":"LogMessage","abstract":"

Log message details.

"},"Structs/LogPagination.html":{"name":"LogPagination","abstract":"

The pagination data for the returned objects.

"},"Structs/MessageInput.html":{"name":"MessageInput","abstract":"

The text of the user input.

"},"Structs/MessageRequest.html":{"name":"MessageRequest","abstract":"

A request formatted for the Conversation service.

"},"Structs/MessageResponse.html":{"name":"MessageResponse","abstract":"

A response from the Conversation service.

"},"Structs/OutputData.html":{"name":"OutputData","abstract":"

An output object that includes the response to the user, the nodes that were hit, and messages from the log.

"},"Structs/Pagination.html":{"name":"Pagination","abstract":"

The pagination data for the returned objects.

"},"Structs/RuntimeEntity.html":{"name":"RuntimeEntity","abstract":"

A term from the request that was identified as an entity.

"},"Structs/RuntimeIntent.html":{"name":"RuntimeIntent","abstract":"

An intent identified in the user input.

"},"Structs/Synonym.html":{"name":"Synonym","abstract":"

Synonym.

"},"Structs/SynonymCollection.html":{"name":"SynonymCollection","abstract":"

SynonymCollection.

"},"Structs/SystemResponse.html":{"name":"SystemResponse","abstract":"

For internal use only.

"},"Structs/UpdateCounterexample.html":{"name":"UpdateCounterexample","abstract":"

UpdateCounterexample.

"},"Structs/UpdateDialogNode.html":{"name":"UpdateDialogNode","abstract":"

UpdateDialogNode.

"},"Structs/UpdateEntity.html":{"name":"UpdateEntity","abstract":"

UpdateEntity.

"},"Structs/UpdateExample.html":{"name":"UpdateExample","abstract":"

UpdateExample.

"},"Structs/UpdateIntent.html":{"name":"UpdateIntent","abstract":"

UpdateIntent.

"},"Structs/UpdateSynonym.html":{"name":"UpdateSynonym","abstract":"

UpdateSynonym.

"},"Structs/UpdateValue.html":{"name":"UpdateValue","abstract":"

UpdateValue.

"},"Structs/UpdateWorkspace.html":{"name":"UpdateWorkspace","abstract":"

UpdateWorkspace.

"},"Structs/Value.html":{"name":"Value","abstract":"

Value.

"},"Structs/ValueCollection.html":{"name":"ValueCollection","abstract":"

ValueCollection.

"},"Structs/ValueExport.html":{"name":"ValueExport","abstract":"

ValueExport.

"},"Structs/Workspace.html":{"name":"Workspace","abstract":"

Workspace.

"},"Structs/WorkspaceCollection.html":{"name":"WorkspaceCollection","abstract":"

WorkspaceCollection.

"},"Structs/WorkspaceExport.html":{"name":"WorkspaceExport","abstract":"

WorkspaceExport.

"},"Enums/RestError.html#/s:14ConversationV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO013serializationD0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO08encodingD0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO011fileManagerD0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:14ConversationV14JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/Conversation.html#/s:14ConversationV10A0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

Create a Conversation object.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a Conversation object.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a Conversation object.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C7messageySS11workspaceID_AA14MessageRequestVSg7requestSbSg19nodesVisitedDetailss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F8ResponseVc7successtF":{"name":"message(workspaceID:request:nodesVisitedDetails:headers:failure:success:)","abstract":"

Get response to user input.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C14listWorkspacesySiSg9pageLimit_SbSg12includeCountSSSg4sortAI6cursorAG0G5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA19WorkspaceCollectionVc7successtF":{"name":"listWorkspaces(pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List workspaces.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C15createWorkspaceyAA06CreateD0VSg10properties_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createWorkspace(properties:headers:failure:success:)","abstract":"

Create workspace.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12getWorkspaceySS11workspaceID_SbSg6exportAF12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getWorkspace(workspaceID:export:includeAudit:headers:failure:success:)","abstract":"

Get information about a workspace.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C15updateWorkspaceySS11workspaceID_AA06UpdateD0VSg10propertiesSbSg6appends10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateWorkspace(workspaceID:properties:append:headers:failure:success:)","abstract":"

Update workspace.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C15deleteWorkspaceySS11workspaceID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteWorkspace(workspaceID:headers:failure:success:)","abstract":"

Delete workspace.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11listIntentsySS11workspaceID_SbSg6exportSiSg9pageLimitAF12includeCountSSSg4sortAK6cursorAF0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA16IntentCollectionVc7successtF":{"name":"listIntents(workspaceID:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List intents.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12createIntentySS11workspaceID_SS6intentSSSg11descriptionSayAA13CreateExampleVGSg8exampless10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createIntent(workspaceID:intent:description:examples:headers:failure:success:)","abstract":"

Create intent.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C9getIntentySS11workspaceID_SS6intentSbSg6exportAG12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getIntent(workspaceID:intent:export:includeAudit:headers:failure:success:)","abstract":"

Get intent.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12updateIntentySS11workspaceID_SS6intentSSSg03newD0AG0H11DescriptionSayAA13CreateExampleVGSg0H8Exampless10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateIntent(workspaceID:intent:newIntent:newDescription:newExamples:headers:failure:success:)","abstract":"

Update intent.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12deleteIntentySS11workspaceID_SS6intents10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteIntent(workspaceID:intent:headers:failure:success:)","abstract":"

Delete intent.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12listExamplesySS11workspaceID_SS6intentSiSg9pageLimitSbSg12includeCountSSSg4sortAK6cursorAI0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA17ExampleCollectionVc7successtF":{"name":"listExamples(workspaceID:intent:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List user input examples.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13createExampleySS11workspaceID_SS6intentSS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createExample(workspaceID:intent:text:headers:failure:success:)","abstract":"

Create user input example.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C10getExampleySS11workspaceID_SS6intentSS4textSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getExample(workspaceID:intent:text:includeAudit:headers:failure:success:)","abstract":"

Get user input example.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13updateExampleySS11workspaceID_SS6intentSS4textSSSg7newTexts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateExample(workspaceID:intent:text:newText:headers:failure:success:)","abstract":"

Update user input example.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13deleteExampleySS11workspaceID_SS6intentSS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteExample(workspaceID:intent:text:headers:failure:success:)","abstract":"

Delete user input example.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C19listCounterexamplesySS11workspaceID_SiSg9pageLimitSbSg12includeCountSSSg4sortAJ6cursorAH0I5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA24CounterexampleCollectionVc7successtF":{"name":"listCounterexamples(workspaceID:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List counterexamples.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C20createCounterexampleySS11workspaceID_SS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createCounterexample(workspaceID:text:headers:failure:success:)","abstract":"

Create counterexample.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C17getCounterexampleySS11workspaceID_SS4textSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getCounterexample(workspaceID:text:includeAudit:headers:failure:success:)","abstract":"

Get counterexample.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C20updateCounterexampleySS11workspaceID_SS4textSSSg7newTexts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateCounterexample(workspaceID:text:newText:headers:failure:success:)","abstract":"

Update counterexample.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C20deleteCounterexampleySS11workspaceID_SS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteCounterexample(workspaceID:text:headers:failure:success:)","abstract":"

Delete counterexample.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12listEntitiesySS11workspaceID_SbSg6exportSiSg9pageLimitAF12includeCountSSSg4sortAK6cursorAF0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA16EntityCollectionVc7successtF":{"name":"listEntities(workspaceID:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entities.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12createEntityySS11workspaceID_AA06CreateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createEntity(workspaceID:properties:headers:failure:success:)","abstract":"

Create entity.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C9getEntityySS11workspaceID_SS6entitySbSg6exportAG12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getEntity(workspaceID:entity:export:includeAudit:headers:failure:success:)","abstract":"

Get entity.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12updateEntityySS11workspaceID_SS6entityAA06UpdateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateEntity(workspaceID:entity:properties:headers:failure:success:)","abstract":"

Update entity.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12deleteEntityySS11workspaceID_SS6entitys10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteEntity(workspaceID:entity:headers:failure:success:)","abstract":"

Delete entity.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C10listValuesySS11workspaceID_SS6entitySbSg6exportSiSg9pageLimitAG12includeCountSSSg4sortAL6cursorAG0K5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA15ValueCollectionVc7successtF":{"name":"listValues(workspaceID:entity:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entity values.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11createValueySS11workspaceID_SS6entityAA06CreateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createValue(workspaceID:entity:properties:headers:failure:success:)","abstract":"

Add entity value.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C8getValueySS11workspaceID_SS6entitySS5valueSbSg6exportAH12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getValue(workspaceID:entity:value:export:includeAudit:headers:failure:success:)","abstract":"

Get entity value.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11updateValueySS11workspaceID_SS6entitySS5valueAA06UpdateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateValue(workspaceID:entity:value:properties:headers:failure:success:)","abstract":"

Update entity value.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11deleteValueySS11workspaceID_SS6entitySS5values10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteValue(workspaceID:entity:value:headers:failure:success:)","abstract":"

Delete entity value.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12listSynonymsySS11workspaceID_SS6entitySS5valueSiSg9pageLimitSbSg12includeCountSSSg4sortAL6cursorAJ0K5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA17SynonymCollectionVc7successtF":{"name":"listSynonyms(workspaceID:entity:value:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entity value synonyms.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13createSynonymySS11workspaceID_SS6entitySS5valueSS7synonyms10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createSynonym(workspaceID:entity:value:synonym:headers:failure:success:)","abstract":"

Add entity value synonym.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C10getSynonymySS11workspaceID_SS6entitySS5valueSS7synonymSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getSynonym(workspaceID:entity:value:synonym:includeAudit:headers:failure:success:)","abstract":"

Get entity value synonym.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13updateSynonymySS11workspaceID_SS6entitySS5valueSS7synonymSSSg03newD0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateSynonym(workspaceID:entity:value:synonym:newSynonym:headers:failure:success:)","abstract":"

Update entity value synonym.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13deleteSynonymySS11workspaceID_SS6entitySS5valueSS7synonyms10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteSynonym(workspaceID:entity:value:synonym:headers:failure:success:)","abstract":"

Delete entity value synonym.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C15listDialogNodesySS11workspaceID_SiSg9pageLimitSbSg12includeCountSSSg4sortAJ6cursorAH0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D14NodeCollectionVc7successtF":{"name":"listDialogNodes(workspaceID:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List dialog nodes.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C16createDialogNodeySS11workspaceID_AA06CreatedE0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"createDialogNode(workspaceID:properties:headers:failure:success:)","abstract":"

Create dialog node.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13getDialogNodeySS11workspaceID_SS06dialogE0SbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"getDialogNode(workspaceID:dialogNode:includeAudit:headers:failure:success:)","abstract":"

Get dialog node.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C16updateDialogNodeySS11workspaceID_SS06dialogE0AA06UpdatedE0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"updateDialogNode(workspaceID:dialogNode:properties:headers:failure:success:)","abstract":"

Update dialog node.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C16deleteDialogNodeySS11workspaceID_SS06dialogE0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteDialogNode(workspaceID:dialogNode:headers:failure:success:)","abstract":"

Delete dialog node.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C8listLogsySS11workspaceID_SSSg4sortAF6filterSiSg9pageLimitAF6cursors10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA13LogCollectionVc7successtF":{"name":"listLogs(workspaceID:sort:filter:pageLimit:cursor:headers:failure:success:)","abstract":"

List log events in a workspace.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11listAllLogsySS6filter_SSSg4sortSiSg9pageLimitAF6cursors10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA13LogCollectionVc7successtF":{"name":"listAllLogs(filter:sort:pageLimit:cursor:headers:failure:success:)","abstract":"

List log events in all workspaces.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

Delete labeled data.

","parent_name":"Conversation"},"Classes/Conversation.html":{"name":"Conversation","abstract":"

The IBM Watson™ Conversation service combines machine learning, natural language understanding, and integrated"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file diff --git a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/docSet.dsidx b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/docSet.dsidx index 3b2f264bc..8a0d40efd 100644 Binary files a/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/docSet.dsidx and b/docs/swift-api/services/ConversationV1/docsets/.docset/Contents/Resources/docSet.dsidx differ diff --git a/docs/swift-api/services/ConversationV1/docsets/.tgz b/docs/swift-api/services/ConversationV1/docsets/.tgz index f268f74c2..3c5f4899a 100644 Binary files a/docs/swift-api/services/ConversationV1/docsets/.tgz and b/docs/swift-api/services/ConversationV1/docsets/.tgz differ diff --git a/docs/swift-api/services/ConversationV1/index.html b/docs/swift-api/services/ConversationV1/index.html index b73b1e414..e1bfeeafe 100644 --- a/docs/swift-api/services/ConversationV1/index.html +++ b/docs/swift-api/services/ConversationV1/index.html @@ -169,9 +169,6 @@ - @@ -334,7 +331,8 @@

Services

  • Assistant
  • Discovery
  • -
  • Language Translator
  • +
  • Language Translator V2
  • +
  • Language Translator V3
  • Natural Language Classifier
  • Natural Language Understanding
  • Personality Insights
  • @@ -379,7 +377,7 @@

    Swift Package Manager

    Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

    dependencies: [
    -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
    +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
     ]
     

    Service Instances

    @@ -422,7 +420,7 @@

    Username and Password

    API Key

    -

    Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

    +

    Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

    let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
     

    Using IAM

    @@ -657,7 +655,12 @@

    Private Data Collections

  • IBM Discovery - Documentation
  • IBM Discovery - Demo
-

Language Translator

+

Language Translator V2

+ +

Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

@@ -668,6 +671,25 @@

Language Translator

let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} + +

Language Translator V3

+ +

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

+ +

The following example demonstrates how to use the Language Translator service:

+
import LanguageTranslatorV3
+
+let username = "your-username-here"
+let password = "your-password-here"
+let version = "yyyy-mm-dd" // use today's date for the most recent version
+let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
+
 let failure = { (error: Error) in print(error) }
 let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
 languageTranslator.translate(request: request, failure: failure) {
@@ -1058,7 +1080,7 @@ 

Visual Recognition

let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -1066,6 +1088,10 @@

Visual Recognition

print(classifiedImages) }
+ +

Note: a different initializer is used for authentication with instances created before May 23, 2018:

+
let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
+

Using Core ML

The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

@@ -1117,7 +1143,7 @@

Bundlin diff --git a/docs/swift-api/services/ConversationV1/search.json b/docs/swift-api/services/ConversationV1/search.json index fe261b840..f6b8bebed 100644 --- a/docs/swift-api/services/ConversationV1/search.json +++ b/docs/swift-api/services/ConversationV1/search.json @@ -1 +1 @@ -{"Structs/WorkspaceExport/Status.html#/s:14ConversationV115WorkspaceExportV6StatusO11nonExistentA2EmF":{"name":"nonExistent","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:14ConversationV115WorkspaceExportV6StatusO8trainingA2EmF":{"name":"training","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:14ConversationV115WorkspaceExportV6StatusO6failedA2EmF":{"name":"failed","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:14ConversationV115WorkspaceExportV6StatusO9availableA2EmF":{"name":"available","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:14ConversationV115WorkspaceExportV6StatusO11unavailableA2EmF":{"name":"unavailable","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html":{"name":"Status","abstract":"

The current status of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV4nameSSvp":{"name":"name","abstract":"

The name of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV11descriptionSSvp":{"name":"description","abstract":"

The description of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV8languageSSvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV8metadatas10DictionaryVySSAA4JSONOGvp":{"name":"metadata","abstract":"

Any metadata that is required by the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The workspace ID.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV6statusSSvp":{"name":"status","abstract":"

The current status of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV14learningOptOutSbvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV7intentsSayAA06IntentD0VGSgvp":{"name":"intents","abstract":"

An array of intents.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV8entitiesSayAA06EntityD0VGSgvp":{"name":"entities","abstract":"

An array of entities.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV15counterexamplesSayAA14CounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of counterexamples.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV11dialogNodesSayAA10DialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects describing the dialog nodes in the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceCollection.html#/s:14ConversationV119WorkspaceCollectionV10workspacesSayAA0C0VGvp":{"name":"workspaces","abstract":"

An array of objects describing the workspaces associated with the service instance.

","parent_name":"WorkspaceCollection"},"Structs/WorkspaceCollection.html#/s:14ConversationV119WorkspaceCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

An object defining the pagination data for the returned objects.

","parent_name":"WorkspaceCollection"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV4nameSSvp":{"name":"name","abstract":"

The name of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV8languageSSvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The workspace ID.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

","parent_name":"Workspace"},"Structs/ValueExport/ValueType.html#/s:14ConversationV111ValueExportV0C4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/ValueExport/ValueType.html#/s:14ConversationV111ValueExportV0C4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/ValueExport/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV9valueTextSSvp":{"name":"valueText","abstract":"

The text of the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array containing any patterns for the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV9valueTypeSSvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"ValueExport"},"Structs/ValueCollection.html#/s:14ConversationV115ValueCollectionV6valuesSayAA0C6ExportVGvp":{"name":"values","abstract":"

An array of entity values.

","parent_name":"ValueCollection"},"Structs/ValueCollection.html#/s:14ConversationV115ValueCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

An object defining the pagination data for the returned objects.

","parent_name":"ValueCollection"},"Structs/Value/ValueType.html#/s:14ConversationV15ValueV0C4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/Value/ValueType.html#/s:14ConversationV15ValueV0C4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/Value/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV9valueTextSSvp":{"name":"valueText","abstract":"

The text of the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array containing any patterns for the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV9valueTypeSSvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"Value"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV4nameSSSgvp":{"name":"name","abstract":"

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV8languageSSSgvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV7intentsSayAA12CreateIntentVGSgvp":{"name":"intents","abstract":"

An array of objects defining the intents for the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV8entitiesSayAA12CreateEntityVGSgvp":{"name":"entities","abstract":"

An array of objects defining the entities for the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV11dialogNodesSayAA16CreateDialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects defining the nodes in the workspace dialog.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV15counterexamplesSayAA20CreateCounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of objects defining input examples that have been marked as irrelevant input.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceVACSSSg4name_AD11descriptionAD8languageSayAA12CreateIntentVGSg7intentsSayAA0H6EntityVGSg8entitiesSayAA0H10DialogNodeVGSg11dialogNodesSayAA0H14CounterexampleVGSg15counterexampless10DictionaryVySSAA4JSONOGSg8metadataSbSg14learningOptOuttcfc":{"name":"init(name:description:language:intents:entities:dialogNodes:counterexamples:metadata:learningOptOut:)","abstract":"

Initialize a UpdateWorkspace with member variables.

","parent_name":"UpdateWorkspace"},"Structs/UpdateValue/ValueType.html#/s:14ConversationV111UpdateValueV0D4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/UpdateValue/ValueType.html#/s:14ConversationV111UpdateValueV0D4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/UpdateValue/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueV5valueSSSgvp":{"name":"value","abstract":"

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueV9valueTypeSSSgvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following resrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueVACSSSg5value_s10DictionaryVySSAA4JSONOGSg8metadataAD0E4TypeSaySSGSg8synonymsAO8patternstcfc":{"name":"init(value:metadata:valueType:synonyms:patterns:)","abstract":"

Initialize a UpdateValue with member variables.

","parent_name":"UpdateValue"},"Structs/UpdateSynonym.html#/s:14ConversationV113UpdateSynonymV7synonymSSSgvp":{"name":"synonym","abstract":"

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"UpdateSynonym"},"Structs/UpdateSynonym.html#/s:14ConversationV113UpdateSynonymVACSSSg7synonym_tcfc":{"name":"init(synonym:)","abstract":"

Initialize a UpdateSynonym with member variables.

","parent_name":"UpdateSynonym"},"Structs/UpdateIntent.html#/s:14ConversationV112UpdateIntentV6intentSSSgvp":{"name":"intent","abstract":"

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:14ConversationV112UpdateIntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:14ConversationV112UpdateIntentV8examplesSayAA13CreateExampleVGSgvp":{"name":"examples","abstract":"

An array of user input examples for the intent.

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:14ConversationV112UpdateIntentVACSSSg6intent_AD11descriptionSayAA13CreateExampleVGSg8examplestcfc":{"name":"init(intent:description:examples:)","abstract":"

Initialize a UpdateIntent with member variables.

","parent_name":"UpdateIntent"},"Structs/UpdateExample.html#/s:14ConversationV113UpdateExampleV4textSSSgvp":{"name":"text","abstract":"

The text of the user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

","parent_name":"UpdateExample"},"Structs/UpdateExample.html#/s:14ConversationV113UpdateExampleVACSSSg4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a UpdateExample with member variables.

","parent_name":"UpdateExample"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityV6entitySSSgvp":{"name":"entity","abstract":"

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether to use fuzzy matching for the entity.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityV6valuesSayAA11CreateValueVGSgvp":{"name":"values","abstract":"

An array of entity values.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityVACSSSg6entity_AD11descriptions10DictionaryVySSAA4JSONOGSg8metadataSbSg10fuzzyMatchSayAA11CreateValueVGSg6valuestcfc":{"name":"init(entity:description:metadata:fuzzyMatch:values:)","abstract":"

Initialize a UpdateEntity with member variables.

","parent_name":"UpdateEntity"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:14ConversationV116UpdateDialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:14ConversationV116UpdateDialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:14ConversationV116UpdateDialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOut.html#/s:14ConversationV116UpdateDialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressOut.html#/s:14ConversationV116UpdateDialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressOut.html#/s:14ConversationV116UpdateDialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressIn.html#/s:14ConversationV116UpdateDialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/DigressIn.html#/s:14ConversationV116UpdateDialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/DigressIn.html#/s:14ConversationV116UpdateDialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV06dialogE0SSSgvp":{"name":"dialogNode","abstract":"

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous sibling dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context for the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

The metadata for the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV8nextStepAA0de4NextG0VSgvp":{"name":"nextStep","abstract":"

The next step to be executed in dialog processing.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV7actionsSayAA0dE6ActionVGSgvp":{"name":"actions","abstract":"

An array of objects describing any actions to be invoked by the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeVACSSSg06dialogE0_AD11descriptionAD10conditionsAD6parentAD15previousSiblings10DictionaryVySSAA4JSONOGSg6outputAO7contextAO8metadataAA0dE8NextStepVSg04nextR0AD5titleAD8nodeTypeAD9eventNameAD8variableSayAA0dE6ActionVGSg7actionsAD9digressInAD10digressOutAD15digressOutSlotstcfc":{"name":"init(dialogNode:description:conditions:parent:previousSibling:output:context:metadata:nextStep:title:nodeType:eventName:variable:actions:digressIn:digressOut:digressOutSlots:)","abstract":"

Initialize a UpdateDialogNode with member variables.

","parent_name":"UpdateDialogNode"},"Structs/UpdateCounterexample.html#/s:14ConversationV120UpdateCounterexampleV4textSSSgvp":{"name":"text","abstract":"

The text of a user input counterexample.

","parent_name":"UpdateCounterexample"},"Structs/UpdateCounterexample.html#/s:14ConversationV120UpdateCounterexampleVACSSSg4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a UpdateCounterexample with member variables.

","parent_name":"UpdateCounterexample"},"Structs/SystemResponse.html#/s:14ConversationV114SystemResponseV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:14ConversationV114SystemResponseVACs10DictionaryVySSAA4JSONOG20additionalProperties_tcfc":{"name":"init(additionalProperties:)","abstract":"

Initialize a SystemResponse.

","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"SystemResponse"},"Structs/SynonymCollection.html#/s:14ConversationV117SynonymCollectionV8synonymsSayAA0C0VGvp":{"name":"synonyms","abstract":"

An array of synonyms.

","parent_name":"SynonymCollection"},"Structs/SynonymCollection.html#/s:14ConversationV117SynonymCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"SynonymCollection"},"Structs/Synonym.html#/s:14ConversationV17SynonymV11synonymTextSSvp":{"name":"synonymText","abstract":"

The text of the synonym.

","parent_name":"Synonym"},"Structs/Synonym.html#/s:14ConversationV17SynonymV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the synonym.

","parent_name":"Synonym"},"Structs/Synonym.html#/s:14ConversationV17SynonymV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the most recent update to the synonym.

","parent_name":"Synonym"},"Structs/RuntimeIntent.html#/s:14ConversationV113RuntimeIntentV6intentSSvp":{"name":"intent","abstract":"

The name of the recognized intent.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:14ConversationV113RuntimeIntentV10confidenceSdvp":{"name":"confidence","abstract":"

A decimal percentage that represents Watson’s confidence in the intent.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:14ConversationV113RuntimeIntentV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:14ConversationV113RuntimeIntentVACSS6intent_Sd10confidences10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(intent:confidence:additionalProperties:)","abstract":"

Initialize a RuntimeIntent with member variables.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"RuntimeIntent"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV6entitySSvp":{"name":"entity","abstract":"

An entity detected in the input.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV8locationSaySiGvp":{"name":"location","abstract":"

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV5valueSSvp":{"name":"value","abstract":"

The term in the input text that was recognized as an entity value.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV10confidenceSdSgvp":{"name":"confidence","abstract":"

A decimal percentage that represents Watson’s confidence in the entity.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata for the entity.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV6groupsSayAA12CaptureGroupVGSgvp":{"name":"groups","abstract":"

The recognized capture groups for the entity, as defined by the entity pattern.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityVACSS6entity_SaySiG8locationSS5valueSdSg10confidences10DictionaryVySSAA4JSONOGSg8metadataSayAA12CaptureGroupVGSg6groupsAN20additionalPropertiestcfc":{"name":"init(entity:location:value:confidence:metadata:groups:additionalProperties:)","abstract":"

Initialize a RuntimeEntity with member variables.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"RuntimeEntity"},"Structs/Pagination.html#/s:14ConversationV110PaginationV10refreshUrlSSvp":{"name":"refreshUrl","abstract":"

The URL that will return the same page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:14ConversationV110PaginationV7nextUrlSSSgvp":{"name":"nextUrl","abstract":"

The URL that will return the next page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:14ConversationV110PaginationV5totalSiSgvp":{"name":"total","abstract":"

Reserved for future use.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:14ConversationV110PaginationV7matchedSiSgvp":{"name":"matched","abstract":"

Reserved for future use.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:14ConversationV110PaginationV13refreshCursorSSSgvp":{"name":"refreshCursor","abstract":"

A token identifying the current page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:14ConversationV110PaginationV10nextCursorSSSgvp":{"name":"nextCursor","abstract":"

A token identifying the next page of results.

","parent_name":"Pagination"},"Structs/OutputData.html#/s:14ConversationV110OutputDataV11logMessagesSayAA10LogMessageVGvp":{"name":"logMessages","abstract":"

An array of up to 50 messages logged with the request.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:14ConversationV110OutputDataV4textSaySSGvp":{"name":"text","abstract":"

An array of responses to the user.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:14ConversationV110OutputDataV12nodesVisitedSaySSGSgvp":{"name":"nodesVisited","abstract":"

An array of the nodes that were triggered to create the response, in the order in which they were visited. This information is useful for debugging and for tracing the path taken through the node tree.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:14ConversationV110OutputDataV19nodesVisitedDetailsSayAA010DialogNodefG0VGSgvp":{"name":"nodesVisitedDetails","abstract":"

An array of objects containing detailed diagnostic information about the nodes that were triggered during processing of the input message. Included only if nodes_visited_details is set to true in the message request.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:14ConversationV110OutputDataV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:14ConversationV110OutputDataVACSayAA10LogMessageVG11logMessages_SaySSG4textAHSg12nodesVisitedSayAA010DialogNodeK7DetailsVGSg0jkN0s10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(logMessages:text:nodesVisited:nodesVisitedDetails:additionalProperties:)","abstract":"

Initialize a OutputData with member variables.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"OutputData"},"Structs/OutputData.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"OutputData"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV5inputAA0C5InputVSgvp":{"name":"input","abstract":"

The user input from the request.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV7intentsSayAA13RuntimeIntentVGvp":{"name":"intents","abstract":"

An array of intents recognized in the user input, sorted in descending order of confidence.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV8entitiesSayAA13RuntimeEntityVGvp":{"name":"entities","abstract":"

An array of entities identified in the user input.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV16alternateIntentsSbSgvp":{"name":"alternateIntents","abstract":"

Whether to return more than one intent. A value of true indicates that all matching intents are returned.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV7contextAA7ContextVvp":{"name":"context","abstract":"

State information for the conversation.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV6outputAA10OutputDataVvp":{"name":"output","abstract":"

Output from the dialog, including the response to the user, the nodes that were triggered, and log messages.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"MessageResponse"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV5inputAA9InputDataVSgvp":{"name":"input","abstract":"

An input object that includes the input text.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV16alternateIntentsSbSgvp":{"name":"alternateIntents","abstract":"

Whether to return more than one intent. Set to true to return all matching intents.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV7contextAA7ContextVSgvp":{"name":"context","abstract":"

State information for the conversation. Continue a conversation by including the context object from the previous response.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV8entitiesSayAA13RuntimeEntityVGSgvp":{"name":"entities","abstract":"

Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV7intentsSayAA13RuntimeIntentVGSgvp":{"name":"intents","abstract":"

Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV6outputAA10OutputDataVSgvp":{"name":"output","abstract":"

System output. Include the output from the previous response to maintain intermediate information over multiple requests.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestVAcA9InputDataVSg5input_SbSg16alternateIntentsAA7ContextVSg7contextSayAA13RuntimeEntityVGSg8entitiesSayAA0L6IntentVGSg7intentsAA06OutputF0VSg6outputtcfc":{"name":"init(input:alternateIntents:context:entities:intents:output:)","abstract":"

Initialize a MessageRequest with member variables.

","parent_name":"MessageRequest"},"Structs/MessageInput.html#/s:14ConversationV112MessageInputV4textSSSgvp":{"name":"text","abstract":"

The user’s input.

","parent_name":"MessageInput"},"Structs/LogPagination.html#/s:14ConversationV113LogPaginationV7nextUrlSSSgvp":{"name":"nextUrl","abstract":"

The URL that will return the next page of results, if any.

","parent_name":"LogPagination"},"Structs/LogPagination.html#/s:14ConversationV113LogPaginationV7matchedSiSgvp":{"name":"matched","abstract":"

Reserved for future use.

","parent_name":"LogPagination"},"Structs/LogPagination.html#/s:14ConversationV113LogPaginationV10nextCursorSSSgvp":{"name":"nextCursor","abstract":"

A token identifying the next page of results.

","parent_name":"LogPagination"},"Structs/LogMessage/Level.html#/s:14ConversationV110LogMessageV5LevelO4infoA2EmF":{"name":"info","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html#/s:14ConversationV110LogMessageV5LevelO5errorA2EmF":{"name":"error","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html#/s:14ConversationV110LogMessageV5LevelO4warnA2EmF":{"name":"warn","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html":{"name":"Level","abstract":"

The severity of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:14ConversationV110LogMessageV5levelSSvp":{"name":"level","abstract":"

The severity of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:14ConversationV110LogMessageV3msgSSvp":{"name":"msg","abstract":"

The text of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:14ConversationV110LogMessageV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:14ConversationV110LogMessageVACSS5level_SS3msgs10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(level:msg:additionalProperties:)","abstract":"

Initialize a LogMessage with member variables.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"LogMessage"},"Structs/LogExport.html#/s:14ConversationV19LogExportV7requestAA14MessageRequestVvp":{"name":"request","abstract":"

A request received by the workspace, including the user input and context.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV8responseAA15MessageResponseVvp":{"name":"response","abstract":"

The response sent by the workspace, including the output text, detected intents and entities, and context.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV5logIDSSvp":{"name":"logID","abstract":"

A unique identifier for the logged event.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV16requestTimestampSSvp":{"name":"requestTimestamp","abstract":"

The timestamp for receipt of the message.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV17responseTimestampSSvp":{"name":"responseTimestamp","abstract":"

The timestamp for the system response to the message.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The unique identifier of the workspace where the request was made.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV8languageSSvp":{"name":"language","abstract":"

The language of the workspace where the message request was made.

","parent_name":"LogExport"},"Structs/LogCollection.html#/s:14ConversationV113LogCollectionV4logsSayAA0C6ExportVGvp":{"name":"logs","abstract":"

An array of objects describing log events.

","parent_name":"LogCollection"},"Structs/LogCollection.html#/s:14ConversationV113LogCollectionV10paginationAA0C10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"LogCollection"},"Structs/IntentExport.html#/s:14ConversationV112IntentExportV10intentNameSSvp":{"name":"intentName","abstract":"

The name of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:14ConversationV112IntentExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:14ConversationV112IntentExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:14ConversationV112IntentExportV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:14ConversationV112IntentExportV8examplesSayAA7ExampleVGSgvp":{"name":"examples","abstract":"

An array of objects describing the user input examples for the intent.

","parent_name":"IntentExport"},"Structs/IntentCollection.html#/s:14ConversationV116IntentCollectionV7intentsSayAA0C6ExportVGvp":{"name":"intents","abstract":"

An array of objects describing the intents defined for the workspace.

","parent_name":"IntentCollection"},"Structs/IntentCollection.html#/s:14ConversationV116IntentCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"IntentCollection"},"Structs/Intent.html#/s:14ConversationV16IntentV10intentNameSSvp":{"name":"intentName","abstract":"

The name of the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:14ConversationV16IntentV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:14ConversationV16IntentV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:14ConversationV16IntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"Intent"},"Structs/InputData.html#/s:14ConversationV19InputDataV4textSSvp":{"name":"text","abstract":"

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

","parent_name":"InputData"},"Structs/InputData.html#/s:14ConversationV19InputDataVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a InputData with member variables.

","parent_name":"InputData"},"Structs/ExampleCollection.html#/s:14ConversationV117ExampleCollectionV8examplesSayAA0C0VGvp":{"name":"examples","abstract":"

An array of objects describing the examples defined for the intent.

","parent_name":"ExampleCollection"},"Structs/ExampleCollection.html#/s:14ConversationV117ExampleCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"ExampleCollection"},"Structs/Example.html#/s:14ConversationV17ExampleV11exampleTextSSvp":{"name":"exampleText","abstract":"

The text of the user input example.

","parent_name":"Example"},"Structs/Example.html#/s:14ConversationV17ExampleV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the example.

","parent_name":"Example"},"Structs/Example.html#/s:14ConversationV17ExampleV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the example.

","parent_name":"Example"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV10entityNameSSvp":{"name":"entityName","abstract":"

The name of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether fuzzy matching is used for the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV6valuesSayAA05ValueD0VGSgvp":{"name":"values","abstract":"

An array objects describing the entity values.

","parent_name":"EntityExport"},"Structs/EntityCollection.html#/s:14ConversationV116EntityCollectionV8entitiesSayAA0C6ExportVGvp":{"name":"entities","abstract":"

An array of objects describing the entities defined for the workspace.

","parent_name":"EntityCollection"},"Structs/EntityCollection.html#/s:14ConversationV116EntityCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"EntityCollection"},"Structs/Entity.html#/s:14ConversationV16EntityV10entityNameSSvp":{"name":"entityName","abstract":"

The name of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:14ConversationV16EntityV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:14ConversationV16EntityV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:14ConversationV16EntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:14ConversationV16EntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:14ConversationV16EntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether fuzzy matching is used for the entity.

","parent_name":"Entity"},"Structs/DialogNodeVisitedDetails.html#/s:14ConversationV124DialogNodeVisitedDetailsV06dialogD0SSSgvp":{"name":"dialogNode","abstract":"

A dialog node that was triggered during processing of the input message.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:14ConversationV124DialogNodeVisitedDetailsV5titleSSSgvp":{"name":"title","abstract":"

The title of the dialog node.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:14ConversationV124DialogNodeVisitedDetailsV10conditionsSSSgvp":{"name":"conditions","abstract":"

The conditions that trigger the dialog node.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:14ConversationV124DialogNodeVisitedDetailsVACSSSg06dialogD0_AD5titleAD10conditionstcfc":{"name":"init(dialogNode:title:conditions:)","abstract":"

Initialize a DialogNodeVisitedDetails with member variables.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeNextStep/Selector.html#/s:14ConversationV118DialogNodeNextStepV8SelectorO9conditionA2EmF":{"name":"condition","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:14ConversationV118DialogNodeNextStepV8SelectorO6clientA2EmF":{"name":"client","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:14ConversationV118DialogNodeNextStepV8SelectorO9userInputA2EmF":{"name":"userInput","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:14ConversationV118DialogNodeNextStepV8SelectorO4bodyA2EmF":{"name":"body","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO12getUserInputA2EmF":{"name":"getUserInput","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO13skipUserInputA2EmF":{"name":"skipUserInput","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO6jumpToA2EmF":{"name":"jumpTo","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO8repromptA2EmF":{"name":"reprompt","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO8skipSlotA2EmF":{"name":"skipSlot","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO12skipAllSlotsA2EmF":{"name":"skipAllSlots","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html":{"name":"Behavior","abstract":"

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep/Selector.html":{"name":"Selector","abstract":"

Which part of the dialog node to process next.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:14ConversationV118DialogNodeNextStepV8behaviorSSvp":{"name":"behavior","abstract":"

What happens after the dialog node completes. The valid values depend on the node type: - The following values are valid for any node: - get_user_input - skip_user_input - jump_to - If the node is of type event_handler and its parent node is of type slot or frame, additional values are also valid: - if event_name=filled and the type of the parent node is slot: - reprompt - skip_all_slots - if event_name=nomatch and the type of the parent node is slot: - reprompt - skip_slot - skip_all_slots - if event_name=generic and the type of the parent node is frame: - reprompt - skip_slot - skip_all_slots If you specify jump_to, then you must also specify a value for the dialog_node property.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:14ConversationV118DialogNodeNextStepV06dialogD0SSSgvp":{"name":"dialogNode","abstract":"

The ID of the dialog node to process next. This parameter is required if behavior=jump_to.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:14ConversationV118DialogNodeNextStepV8selectorSSSgvp":{"name":"selector","abstract":"

Which part of the dialog node to process next.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:14ConversationV118DialogNodeNextStepVACSS8behavior_SSSg06dialogD0AE8selectortcfc":{"name":"init(behavior:dialogNode:selector:)","abstract":"

Initialize a DialogNodeNextStep with member variables.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeCollection.html#/s:14ConversationV120DialogNodeCollectionV11dialogNodesSayAA0cD0VGvp":{"name":"dialogNodes","abstract":"

An array of objects describing the dialog nodes defined for the workspace.

","parent_name":"DialogNodeCollection"},"Structs/DialogNodeCollection.html#/s:14ConversationV120DialogNodeCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"DialogNodeCollection"},"Structs/DialogNodeAction/ActionType.html#/s:14ConversationV116DialogNodeActionV0E4TypeO6clientA2EmF":{"name":"client","abstract":"

Undocumented

","parent_name":"ActionType"},"Structs/DialogNodeAction/ActionType.html#/s:14ConversationV116DialogNodeActionV0E4TypeO6serverA2EmF":{"name":"server","abstract":"

Undocumented

","parent_name":"ActionType"},"Structs/DialogNodeAction/ActionType.html":{"name":"ActionType","abstract":"

The type of action to invoke.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionV4nameSSvp":{"name":"name","abstract":"

The name of the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionV10actionTypeSSSgvp":{"name":"actionType","abstract":"

The type of action to invoke.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionV10parameterss10DictionaryVySSAA4JSONOGSgvp":{"name":"parameters","abstract":"

A map of key/value pairs to be provided to the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionV14resultVariableSSvp":{"name":"resultVariable","abstract":"

The location in the dialog context where the result of the action is stored.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionV11credentialsSSSgvp":{"name":"credentials","abstract":"

The name of the context variable that the client application will use to pass in credentials for the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionVACSS4name_SS14resultVariableSSSg10actionTypes10DictionaryVySSAA4JSONOGSg10parametersAF11credentialstcfc":{"name":"init(name:resultVariable:actionType:parameters:credentials:)","abstract":"

Initialize a DialogNodeAction with member variables.

","parent_name":"DialogNodeAction"},"Structs/DialogNode/DigressOutSlots.html#/s:14ConversationV110DialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOutSlots.html#/s:14ConversationV110DialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOutSlots.html#/s:14ConversationV110DialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOut.html#/s:14ConversationV110DialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressOut.html#/s:14ConversationV110DialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressOut.html#/s:14ConversationV110DialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressIn.html#/s:14ConversationV110DialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/DigressIn.html#/s:14ConversationV110DialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/DigressIn.html#/s:14ConversationV110DialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV06dialogD2IDSSvp":{"name":"dialogNodeID","abstract":"

The dialog node ID.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that triggers the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node. This property is not returned if the dialog node has no parent.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous sibling dialog node. This property is not returned if the dialog node has no previous sibling.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context (if defined) for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV8nextStepAA0cd4NextF0VSgvp":{"name":"nextStep","abstract":"

The next step to execute following this dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the most recent update to the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV7actionsSayAA0cD6ActionVGSgvp":{"name":"actions","abstract":"

The actions for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"DialogNode"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV4nameSSSgvp":{"name":"name","abstract":"

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV8languageSSSgvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV7intentsSayAA0C6IntentVGSgvp":{"name":"intents","abstract":"

An array of objects defining the intents for the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV8entitiesSayAA0C6EntityVGSgvp":{"name":"entities","abstract":"

An array of objects defining the entities for the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV11dialogNodesSayAA0C10DialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects defining the nodes in the workspace dialog.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV15counterexamplesSayAA0C14CounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of objects defining input examples that have been marked as irrelevant input.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that workspace training data is not to be used.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceVACSSSg4name_AD11descriptionAD8languageSayAA0C6IntentVGSg7intentsSayAA0C6EntityVGSg8entitiesSayAA0C10DialogNodeVGSg11dialogNodesSayAA0C14CounterexampleVGSg15counterexampless10DictionaryVySSAA4JSONOGSg8metadataSbSg14learningOptOuttcfc":{"name":"init(name:description:language:intents:entities:dialogNodes:counterexamples:metadata:learningOptOut:)","abstract":"

Initialize a CreateWorkspace with member variables.

","parent_name":"CreateWorkspace"},"Structs/CreateValue/ValueType.html#/s:14ConversationV111CreateValueV0D4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/CreateValue/ValueType.html#/s:14ConversationV111CreateValueV0D4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/CreateValue/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueV5valueSSvp":{"name":"value","abstract":"

The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A synonym must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type), but not both. A pattern is a regular expression no longer than 128 characters. For more information about how to specify a pattern, see the documentation.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueV9valueTypeSSSgvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueVACSS5value_s10DictionaryVySSAA4JSONOGSg8metadataSaySSGSg8synonymsAM8patternsSSSg0E4Typetcfc":{"name":"init(value:metadata:synonyms:patterns:valueType:)","abstract":"

Initialize a CreateValue with member variables.

","parent_name":"CreateValue"},"Structs/CreateSynonym.html#/s:14ConversationV113CreateSynonymV7synonymSSvp":{"name":"synonym","abstract":"

The text of the synonym. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 64 characters.

","parent_name":"CreateSynonym"},"Structs/CreateSynonym.html#/s:14ConversationV113CreateSynonymVACSS7synonym_tcfc":{"name":"init(synonym:)","abstract":"

Initialize a CreateSynonym with member variables.

","parent_name":"CreateSynonym"},"Structs/CreateIntent.html#/s:14ConversationV112CreateIntentV6intentSSvp":{"name":"intent","abstract":"

The name of the intent. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, hyphen, and dot characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 128 characters.

","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:14ConversationV112CreateIntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:14ConversationV112CreateIntentV8examplesSayAA0C7ExampleVGSgvp":{"name":"examples","abstract":"

An array of user input examples for the intent.

","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:14ConversationV112CreateIntentVACSS6intent_SSSg11descriptionSayAA0C7ExampleVGSg8examplestcfc":{"name":"init(intent:description:examples:)","abstract":"

Initialize a CreateIntent with member variables.

","parent_name":"CreateIntent"},"Structs/CreateExample.html#/s:14ConversationV113CreateExampleV4textSSvp":{"name":"text","abstract":"

The text of a user input example. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters. - It must be no longer than 1024 characters.

","parent_name":"CreateExample"},"Structs/CreateExample.html#/s:14ConversationV113CreateExampleVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a CreateExample with member variables.

","parent_name":"CreateExample"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityV6entitySSvp":{"name":"entity","abstract":"

The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix sys-. - It must be no longer than 64 characters.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the value.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityV6valuesSayAA0C5ValueVGSgvp":{"name":"values","abstract":"

An array of objects describing the entity values.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether to use fuzzy matching for the entity.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityVACSS6entity_SSSg11descriptions10DictionaryVySSAA4JSONOGSg8metadataSayAA0C5ValueVGSg6valuesSbSg10fuzzyMatchtcfc":{"name":"init(entity:description:metadata:values:fuzzyMatch:)","abstract":"

Initialize a CreateEntity with member variables.

","parent_name":"CreateEntity"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:14ConversationV116CreateDialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:14ConversationV116CreateDialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:14ConversationV116CreateDialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOut.html#/s:14ConversationV116CreateDialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressOut.html#/s:14ConversationV116CreateDialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressOut.html#/s:14ConversationV116CreateDialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressIn.html#/s:14ConversationV116CreateDialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/DigressIn.html#/s:14ConversationV116CreateDialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/DigressIn.html#/s:14ConversationV116CreateDialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV06dialogE0SSvp":{"name":"dialogNode","abstract":"

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 1024 characters.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node. For more information about how to specify dialog node output, see the documentation.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context for the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

The metadata for the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV8nextStepAA0de4NextG0VSgvp":{"name":"nextStep","abstract":"

The next step to be executed in dialog processing.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV7actionsSayAA0dE6ActionVGSgvp":{"name":"actions","abstract":"

An array of objects describing any actions to be invoked by the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters. - It must be no longer than 64 characters.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeVACSS06dialogE0_SSSg11descriptionAE10conditionsAE6parentAE15previousSiblings10DictionaryVySSAA4JSONOGSg6outputAO7contextAO8metadataAA0dE8NextStepVSg04nextR0SayAA0dE6ActionVGSg7actionsAE5titleAE8nodeTypeAE9eventNameAE8variableAE9digressInAE10digressOutAE15digressOutSlotstcfc":{"name":"init(dialogNode:description:conditions:parent:previousSibling:output:context:metadata:nextStep:actions:title:nodeType:eventName:variable:digressIn:digressOut:digressOutSlots:)","abstract":"

Initialize a CreateDialogNode with member variables.

","parent_name":"CreateDialogNode"},"Structs/CreateCounterexample.html#/s:14ConversationV120CreateCounterexampleV4textSSvp":{"name":"text","abstract":"

The text of a user input marked as irrelevant input. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters - It cannot consist of only whitespace characters - It must be no longer than 1024 characters.

","parent_name":"CreateCounterexample"},"Structs/CreateCounterexample.html#/s:14ConversationV120CreateCounterexampleVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a CreateCounterexample with member variables.

","parent_name":"CreateCounterexample"},"Structs/CounterexampleCollection.html#/s:14ConversationV124CounterexampleCollectionV15counterexamplesSayAA0C0VGvp":{"name":"counterexamples","abstract":"

An array of objects describing the examples marked as irrelevant input.

","parent_name":"CounterexampleCollection"},"Structs/CounterexampleCollection.html#/s:14ConversationV124CounterexampleCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"CounterexampleCollection"},"Structs/Counterexample.html#/s:14ConversationV114CounterexampleV4textSSvp":{"name":"text","abstract":"

The text of the counterexample.

","parent_name":"Counterexample"},"Structs/Counterexample.html#/s:14ConversationV114CounterexampleV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the counterexample.

","parent_name":"Counterexample"},"Structs/Counterexample.html#/s:14ConversationV114CounterexampleV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the counterexample.

","parent_name":"Counterexample"},"Structs/Context.html#/s:14ConversationV17ContextV14conversationIDSSSgvp":{"name":"conversationID","abstract":"

The unique identifier of the conversation.

","parent_name":"Context"},"Structs/Context.html#/s:14ConversationV17ContextV6systemAA14SystemResponseVSgvp":{"name":"system","abstract":"

For internal use only.

","parent_name":"Context"},"Structs/Context.html#/s:14ConversationV17ContextV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"Context"},"Structs/Context.html#/s:14ConversationV17ContextVACSSSg14conversationID_AA14SystemResponseVSg6systems10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(conversationID:system:additionalProperties:)","abstract":"

Initialize a Context with member variables.

","parent_name":"Context"},"Structs/Context.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"Context"},"Structs/Context.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"Context"},"Structs/CaptureGroup.html#/s:14ConversationV112CaptureGroupV5groupSSvp":{"name":"group","abstract":"

A recognized capture group for the entity.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html#/s:14ConversationV112CaptureGroupV8locationSaySiGSgvp":{"name":"location","abstract":"

Zero-based character offsets that indicate where the entity value begins and ends in the input text.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html#/s:14ConversationV112CaptureGroupVACSS5group_SaySiGSg8locationtcfc":{"name":"init(group:location:)","abstract":"

Initialize a CaptureGroup with member variables.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html":{"name":"CaptureGroup","abstract":"

CaptureGroup.

"},"Structs/Context.html":{"name":"Context","abstract":"

State information for the conversation. To maintain state, include the context from the previous response.

"},"Structs/Counterexample.html":{"name":"Counterexample","abstract":"

Counterexample.

"},"Structs/CounterexampleCollection.html":{"name":"CounterexampleCollection","abstract":"

CounterexampleCollection.

"},"Structs/CreateCounterexample.html":{"name":"CreateCounterexample","abstract":"

CreateCounterexample.

"},"Structs/CreateDialogNode.html":{"name":"CreateDialogNode","abstract":"

CreateDialogNode.

"},"Structs/CreateEntity.html":{"name":"CreateEntity","abstract":"

CreateEntity.

"},"Structs/CreateExample.html":{"name":"CreateExample","abstract":"

CreateExample.

"},"Structs/CreateIntent.html":{"name":"CreateIntent","abstract":"

CreateIntent.

"},"Structs/CreateSynonym.html":{"name":"CreateSynonym","abstract":"

CreateSynonym.

"},"Structs/CreateValue.html":{"name":"CreateValue","abstract":"

CreateValue.

"},"Structs/CreateWorkspace.html":{"name":"CreateWorkspace","abstract":"

CreateWorkspace.

"},"Structs/DialogNode.html":{"name":"DialogNode","abstract":"

DialogNode.

"},"Structs/DialogNodeAction.html":{"name":"DialogNodeAction","abstract":"

DialogNodeAction.

"},"Structs/DialogNodeCollection.html":{"name":"DialogNodeCollection","abstract":"

An array of dialog nodes.

"},"Structs/DialogNodeNextStep.html":{"name":"DialogNodeNextStep","abstract":"

The next step to execute following this dialog node.

"},"Structs/DialogNodeVisitedDetails.html":{"name":"DialogNodeVisitedDetails","abstract":"

DialogNodeVisitedDetails.

"},"Structs/Entity.html":{"name":"Entity","abstract":"

Entity.

"},"Structs/EntityCollection.html":{"name":"EntityCollection","abstract":"

An array of entities.

"},"Structs/EntityExport.html":{"name":"EntityExport","abstract":"

EntityExport.

"},"Structs/Example.html":{"name":"Example","abstract":"

Example.

"},"Structs/ExampleCollection.html":{"name":"ExampleCollection","abstract":"

ExampleCollection.

"},"Structs/InputData.html":{"name":"InputData","abstract":"

The user input.

"},"Structs/Intent.html":{"name":"Intent","abstract":"

Intent.

"},"Structs/IntentCollection.html":{"name":"IntentCollection","abstract":"

IntentCollection.

"},"Structs/IntentExport.html":{"name":"IntentExport","abstract":"

IntentExport.

"},"Structs/LogCollection.html":{"name":"LogCollection","abstract":"

LogCollection.

"},"Structs/LogExport.html":{"name":"LogExport","abstract":"

LogExport.

"},"Structs/LogMessage.html":{"name":"LogMessage","abstract":"

Log message details.

"},"Structs/LogPagination.html":{"name":"LogPagination","abstract":"

The pagination data for the returned objects.

"},"Structs/MessageInput.html":{"name":"MessageInput","abstract":"

The text of the user input.

"},"Structs/MessageRequest.html":{"name":"MessageRequest","abstract":"

A request formatted for the Conversation service.

"},"Structs/MessageResponse.html":{"name":"MessageResponse","abstract":"

A response from the Conversation service.

"},"Structs/OutputData.html":{"name":"OutputData","abstract":"

An output object that includes the response to the user, the nodes that were hit, and messages from the log.

"},"Structs/Pagination.html":{"name":"Pagination","abstract":"

The pagination data for the returned objects.

"},"Structs/RuntimeEntity.html":{"name":"RuntimeEntity","abstract":"

A term from the request that was identified as an entity.

"},"Structs/RuntimeIntent.html":{"name":"RuntimeIntent","abstract":"

An intent identified in the user input.

"},"Structs/Synonym.html":{"name":"Synonym","abstract":"

Synonym.

"},"Structs/SynonymCollection.html":{"name":"SynonymCollection","abstract":"

SynonymCollection.

"},"Structs/SystemResponse.html":{"name":"SystemResponse","abstract":"

For internal use only.

"},"Structs/UpdateCounterexample.html":{"name":"UpdateCounterexample","abstract":"

UpdateCounterexample.

"},"Structs/UpdateDialogNode.html":{"name":"UpdateDialogNode","abstract":"

UpdateDialogNode.

"},"Structs/UpdateEntity.html":{"name":"UpdateEntity","abstract":"

UpdateEntity.

"},"Structs/UpdateExample.html":{"name":"UpdateExample","abstract":"

UpdateExample.

"},"Structs/UpdateIntent.html":{"name":"UpdateIntent","abstract":"

UpdateIntent.

"},"Structs/UpdateSynonym.html":{"name":"UpdateSynonym","abstract":"

UpdateSynonym.

"},"Structs/UpdateValue.html":{"name":"UpdateValue","abstract":"

UpdateValue.

"},"Structs/UpdateWorkspace.html":{"name":"UpdateWorkspace","abstract":"

UpdateWorkspace.

"},"Structs/Value.html":{"name":"Value","abstract":"

Value.

"},"Structs/ValueCollection.html":{"name":"ValueCollection","abstract":"

ValueCollection.

"},"Structs/ValueExport.html":{"name":"ValueExport","abstract":"

ValueExport.

"},"Structs/Workspace.html":{"name":"Workspace","abstract":"

Workspace.

"},"Structs/WorkspaceCollection.html":{"name":"WorkspaceCollection","abstract":"

WorkspaceCollection.

"},"Structs/WorkspaceExport.html":{"name":"WorkspaceExport","abstract":"

WorkspaceExport.

"},"Structs.html#/s:14ConversationV111JSONWrapperV":{"name":"JSONWrapper","abstract":"

Used internally to serialize and deserialize JSON."},"Enums/RestError.html#/s:14ConversationV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO013serializationD0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO08encodingD0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO011fileManagerD0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:14ConversationV14JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/Conversation.html#/s:14ConversationV10A0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

Create a Conversation object.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a Conversation object.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a Conversation object.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C7messageySS11workspaceID_AA14MessageRequestVSg7requestSbSg19nodesVisitedDetailss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F8ResponseVc7successtF":{"name":"message(workspaceID:request:nodesVisitedDetails:headers:failure:success:)","abstract":"

Get response to user input.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C14listWorkspacesySiSg9pageLimit_SbSg12includeCountSSSg4sortAI6cursorAG0G5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA19WorkspaceCollectionVc7successtF":{"name":"listWorkspaces(pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List workspaces.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C15createWorkspaceyAA06CreateD0VSg10properties_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createWorkspace(properties:headers:failure:success:)","abstract":"

Create workspace.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12getWorkspaceySS11workspaceID_SbSg6exportAF12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getWorkspace(workspaceID:export:includeAudit:headers:failure:success:)","abstract":"

Get information about a workspace.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C15updateWorkspaceySS11workspaceID_AA06UpdateD0VSg10propertiesSbSg6appends10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateWorkspace(workspaceID:properties:append:headers:failure:success:)","abstract":"

Update workspace.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C15deleteWorkspaceySS11workspaceID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteWorkspace(workspaceID:headers:failure:success:)","abstract":"

Delete workspace.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11listIntentsySS11workspaceID_SbSg6exportSiSg9pageLimitAF12includeCountSSSg4sortAK6cursorAF0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA16IntentCollectionVc7successtF":{"name":"listIntents(workspaceID:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List intents.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12createIntentySS11workspaceID_SS6intentSSSg11descriptionSayAA13CreateExampleVGSg8exampless10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createIntent(workspaceID:intent:description:examples:headers:failure:success:)","abstract":"

Create intent.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C9getIntentySS11workspaceID_SS6intentSbSg6exportAG12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getIntent(workspaceID:intent:export:includeAudit:headers:failure:success:)","abstract":"

Get intent.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12updateIntentySS11workspaceID_SS6intentSSSg03newD0AG0H11DescriptionSayAA13CreateExampleVGSg0H8Exampless10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateIntent(workspaceID:intent:newIntent:newDescription:newExamples:headers:failure:success:)","abstract":"

Update intent.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12deleteIntentySS11workspaceID_SS6intents10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteIntent(workspaceID:intent:headers:failure:success:)","abstract":"

Delete intent.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12listExamplesySS11workspaceID_SS6intentSiSg9pageLimitSbSg12includeCountSSSg4sortAK6cursorAI0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA17ExampleCollectionVc7successtF":{"name":"listExamples(workspaceID:intent:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List user input examples.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13createExampleySS11workspaceID_SS6intentSS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createExample(workspaceID:intent:text:headers:failure:success:)","abstract":"

Create user input example.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C10getExampleySS11workspaceID_SS6intentSS4textSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getExample(workspaceID:intent:text:includeAudit:headers:failure:success:)","abstract":"

Get user input example.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13updateExampleySS11workspaceID_SS6intentSS4textSSSg7newTexts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateExample(workspaceID:intent:text:newText:headers:failure:success:)","abstract":"

Update user input example.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13deleteExampleySS11workspaceID_SS6intentSS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteExample(workspaceID:intent:text:headers:failure:success:)","abstract":"

Delete user input example.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C19listCounterexamplesySS11workspaceID_SiSg9pageLimitSbSg12includeCountSSSg4sortAJ6cursorAH0I5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA24CounterexampleCollectionVc7successtF":{"name":"listCounterexamples(workspaceID:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List counterexamples.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C20createCounterexampleySS11workspaceID_SS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createCounterexample(workspaceID:text:headers:failure:success:)","abstract":"

Create counterexample.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C17getCounterexampleySS11workspaceID_SS4textSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getCounterexample(workspaceID:text:includeAudit:headers:failure:success:)","abstract":"

Get counterexample.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C20updateCounterexampleySS11workspaceID_SS4textSSSg7newTexts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateCounterexample(workspaceID:text:newText:headers:failure:success:)","abstract":"

Update counterexample.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C20deleteCounterexampleySS11workspaceID_SS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteCounterexample(workspaceID:text:headers:failure:success:)","abstract":"

Delete counterexample.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12listEntitiesySS11workspaceID_SbSg6exportSiSg9pageLimitAF12includeCountSSSg4sortAK6cursorAF0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA16EntityCollectionVc7successtF":{"name":"listEntities(workspaceID:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entities.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12createEntityySS11workspaceID_AA06CreateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createEntity(workspaceID:properties:headers:failure:success:)","abstract":"

Create entity.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C9getEntityySS11workspaceID_SS6entitySbSg6exportAG12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getEntity(workspaceID:entity:export:includeAudit:headers:failure:success:)","abstract":"

Get entity.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12updateEntityySS11workspaceID_SS6entityAA06UpdateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateEntity(workspaceID:entity:properties:headers:failure:success:)","abstract":"

Update entity.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12deleteEntityySS11workspaceID_SS6entitys10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteEntity(workspaceID:entity:headers:failure:success:)","abstract":"

Delete entity.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C10listValuesySS11workspaceID_SS6entitySbSg6exportSiSg9pageLimitAG12includeCountSSSg4sortAL6cursorAG0K5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA15ValueCollectionVc7successtF":{"name":"listValues(workspaceID:entity:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entity values.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11createValueySS11workspaceID_SS6entityAA06CreateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createValue(workspaceID:entity:properties:headers:failure:success:)","abstract":"

Add entity value.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C8getValueySS11workspaceID_SS6entitySS5valueSbSg6exportAH12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getValue(workspaceID:entity:value:export:includeAudit:headers:failure:success:)","abstract":"

Get entity value.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11updateValueySS11workspaceID_SS6entitySS5valueAA06UpdateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateValue(workspaceID:entity:value:properties:headers:failure:success:)","abstract":"

Update entity value.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11deleteValueySS11workspaceID_SS6entitySS5values10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteValue(workspaceID:entity:value:headers:failure:success:)","abstract":"

Delete entity value.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12listSynonymsySS11workspaceID_SS6entitySS5valueSiSg9pageLimitSbSg12includeCountSSSg4sortAL6cursorAJ0K5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA17SynonymCollectionVc7successtF":{"name":"listSynonyms(workspaceID:entity:value:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entity value synonyms.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13createSynonymySS11workspaceID_SS6entitySS5valueSS7synonyms10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createSynonym(workspaceID:entity:value:synonym:headers:failure:success:)","abstract":"

Add entity value synonym.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C10getSynonymySS11workspaceID_SS6entitySS5valueSS7synonymSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getSynonym(workspaceID:entity:value:synonym:includeAudit:headers:failure:success:)","abstract":"

Get entity value synonym.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13updateSynonymySS11workspaceID_SS6entitySS5valueSS7synonymSSSg03newD0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateSynonym(workspaceID:entity:value:synonym:newSynonym:headers:failure:success:)","abstract":"

Update entity value synonym.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13deleteSynonymySS11workspaceID_SS6entitySS5valueSS7synonyms10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteSynonym(workspaceID:entity:value:synonym:headers:failure:success:)","abstract":"

Delete entity value synonym.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C15listDialogNodesySS11workspaceID_SiSg9pageLimitSbSg12includeCountSSSg4sortAJ6cursorAH0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D14NodeCollectionVc7successtF":{"name":"listDialogNodes(workspaceID:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List dialog nodes.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C16createDialogNodeySS11workspaceID_AA06CreatedE0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"createDialogNode(workspaceID:properties:headers:failure:success:)","abstract":"

Create dialog node.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13getDialogNodeySS11workspaceID_SS06dialogE0SbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"getDialogNode(workspaceID:dialogNode:includeAudit:headers:failure:success:)","abstract":"

Get dialog node.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C16updateDialogNodeySS11workspaceID_SS06dialogE0AA06UpdatedE0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"updateDialogNode(workspaceID:dialogNode:properties:headers:failure:success:)","abstract":"

Update dialog node.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C16deleteDialogNodeySS11workspaceID_SS06dialogE0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteDialogNode(workspaceID:dialogNode:headers:failure:success:)","abstract":"

Delete dialog node.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C8listLogsySS11workspaceID_SSSg4sortAF6filterSiSg9pageLimitAF6cursors10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA13LogCollectionVc7successtF":{"name":"listLogs(workspaceID:sort:filter:pageLimit:cursor:headers:failure:success:)","abstract":"

List log events in a workspace.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11listAllLogsySS6filter_SSSg4sortSiSg9pageLimitAF6cursors10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA13LogCollectionVc7successtF":{"name":"listAllLogs(filter:sort:pageLimit:cursor:headers:failure:success:)","abstract":"

List log events in all workspaces.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

Delete labeled data.

","parent_name":"Conversation"},"Classes/Conversation.html":{"name":"Conversation","abstract":"

The IBM Watson Conversation service combines machine learning, natural language understanding, and integrated dialog"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file +{"Structs/WorkspaceExport/Status.html#/s:14ConversationV115WorkspaceExportV6StatusO11nonExistentA2EmF":{"name":"nonExistent","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:14ConversationV115WorkspaceExportV6StatusO8trainingA2EmF":{"name":"training","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:14ConversationV115WorkspaceExportV6StatusO6failedA2EmF":{"name":"failed","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:14ConversationV115WorkspaceExportV6StatusO9availableA2EmF":{"name":"available","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html#/s:14ConversationV115WorkspaceExportV6StatusO11unavailableA2EmF":{"name":"unavailable","abstract":"

Undocumented

","parent_name":"Status"},"Structs/WorkspaceExport/Status.html":{"name":"Status","abstract":"

The current status of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV4nameSSvp":{"name":"name","abstract":"

The name of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV11descriptionSSvp":{"name":"description","abstract":"

The description of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV8languageSSvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV8metadatas10DictionaryVySSAA4JSONOGvp":{"name":"metadata","abstract":"

Any metadata that is required by the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The workspace ID.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV6statusSSvp":{"name":"status","abstract":"

The current status of the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV14learningOptOutSbvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV7intentsSayAA06IntentD0VGSgvp":{"name":"intents","abstract":"

An array of intents.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV8entitiesSayAA06EntityD0VGSgvp":{"name":"entities","abstract":"

An array of entities.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV15counterexamplesSayAA14CounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of counterexamples.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceExport.html#/s:14ConversationV115WorkspaceExportV11dialogNodesSayAA10DialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects describing the dialog nodes in the workspace.

","parent_name":"WorkspaceExport"},"Structs/WorkspaceCollection.html#/s:14ConversationV119WorkspaceCollectionV10workspacesSayAA0C0VGvp":{"name":"workspaces","abstract":"

An array of objects describing the workspaces associated with the service instance.

","parent_name":"WorkspaceCollection"},"Structs/WorkspaceCollection.html#/s:14ConversationV119WorkspaceCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

An object defining the pagination data for the returned objects.

","parent_name":"WorkspaceCollection"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV4nameSSvp":{"name":"name","abstract":"

The name of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV8languageSSvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The workspace ID.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"Workspace"},"Structs/Workspace.html#/s:14ConversationV19WorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for","parent_name":"Workspace"},"Structs/ValueExport/ValueType.html#/s:14ConversationV111ValueExportV0C4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/ValueExport/ValueType.html#/s:14ConversationV111ValueExportV0C4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/ValueExport/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV9valueTextSSvp":{"name":"valueText","abstract":"

The text of the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array containing any patterns for the entity value.

","parent_name":"ValueExport"},"Structs/ValueExport.html#/s:14ConversationV111ValueExportV9valueTypeSSvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"ValueExport"},"Structs/ValueCollection.html#/s:14ConversationV115ValueCollectionV6valuesSayAA0C6ExportVGvp":{"name":"values","abstract":"

An array of entity values.

","parent_name":"ValueCollection"},"Structs/ValueCollection.html#/s:14ConversationV115ValueCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

An object defining the pagination data for the returned objects.

","parent_name":"ValueCollection"},"Structs/Value/ValueType.html#/s:14ConversationV15ValueV0C4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/Value/ValueType.html#/s:14ConversationV15ValueV0C4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/Value/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV9valueTextSSvp":{"name":"valueText","abstract":"

The text of the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array containing any patterns for the entity value.

","parent_name":"Value"},"Structs/Value.html#/s:14ConversationV15ValueV9valueTypeSSvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"Value"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV4nameSSSgvp":{"name":"name","abstract":"

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV8languageSSSgvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV7intentsSayAA12CreateIntentVGSgvp":{"name":"intents","abstract":"

An array of objects defining the intents for the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV8entitiesSayAA12CreateEntityVGSgvp":{"name":"entities","abstract":"

An array of objects defining the entities for the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV11dialogNodesSayAA16CreateDialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects defining the nodes in the workspace dialog.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV15counterexamplesSayAA20CreateCounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of objects defining input examples that have been marked as irrelevant input.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that","parent_name":"UpdateWorkspace"},"Structs/UpdateWorkspace.html#/s:14ConversationV115UpdateWorkspaceVACSSSg4name_AD11descriptionAD8languageSayAA12CreateIntentVGSg7intentsSayAA0H6EntityVGSg8entitiesSayAA0H10DialogNodeVGSg11dialogNodesSayAA0H14CounterexampleVGSg15counterexampless10DictionaryVySSAA4JSONOGSg8metadataSbSg14learningOptOuttcfc":{"name":"init(name:description:language:intents:entities:dialogNodes:counterexamples:metadata:learningOptOut:)","abstract":"

Initialize a UpdateWorkspace with member variables.

","parent_name":"UpdateWorkspace"},"Structs/UpdateValue/ValueType.html#/s:14ConversationV111UpdateValueV0D4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/UpdateValue/ValueType.html#/s:14ConversationV111UpdateValueV0D4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/UpdateValue/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueV5valueSSSgvp":{"name":"value","abstract":"

The text of the entity value. This string must conform to the following restrictions:

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueV9valueTypeSSSgvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array of synonyms for the entity value. You can provide either synonyms or patterns (as indicated by type),","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type),","parent_name":"UpdateValue"},"Structs/UpdateValue.html#/s:14ConversationV111UpdateValueVACSSSg5value_s10DictionaryVySSAA4JSONOGSg8metadataAD0E4TypeSaySSGSg8synonymsAO8patternstcfc":{"name":"init(value:metadata:valueType:synonyms:patterns:)","abstract":"

Initialize a UpdateValue with member variables.

","parent_name":"UpdateValue"},"Structs/UpdateSynonym.html#/s:14ConversationV113UpdateSynonymV7synonymSSSgvp":{"name":"synonym","abstract":"

The text of the synonym. This string must conform to the following restrictions:

","parent_name":"UpdateSynonym"},"Structs/UpdateSynonym.html#/s:14ConversationV113UpdateSynonymVACSSSg7synonym_tcfc":{"name":"init(synonym:)","abstract":"

Initialize a UpdateSynonym with member variables.

","parent_name":"UpdateSynonym"},"Structs/UpdateIntent.html#/s:14ConversationV112UpdateIntentV6intentSSSgvp":{"name":"intent","abstract":"

The name of the intent. This string must conform to the following restrictions:

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:14ConversationV112UpdateIntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:14ConversationV112UpdateIntentV8examplesSayAA13CreateExampleVGSgvp":{"name":"examples","abstract":"

An array of user input examples for the intent.

","parent_name":"UpdateIntent"},"Structs/UpdateIntent.html#/s:14ConversationV112UpdateIntentVACSSSg6intent_AD11descriptionSayAA13CreateExampleVGSg8examplestcfc":{"name":"init(intent:description:examples:)","abstract":"

Initialize a UpdateIntent with member variables.

","parent_name":"UpdateIntent"},"Structs/UpdateExample.html#/s:14ConversationV113UpdateExampleV4textSSSgvp":{"name":"text","abstract":"

The text of the user input example. This string must conform to the following restrictions:

","parent_name":"UpdateExample"},"Structs/UpdateExample.html#/s:14ConversationV113UpdateExampleVACSSSg4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a UpdateExample with member variables.

","parent_name":"UpdateExample"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityV6entitySSSgvp":{"name":"entity","abstract":"

The name of the entity. This string must conform to the following restrictions:

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether to use fuzzy matching for the entity.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityV6valuesSayAA11CreateValueVGSgvp":{"name":"values","abstract":"

An array of entity values.

","parent_name":"UpdateEntity"},"Structs/UpdateEntity.html#/s:14ConversationV112UpdateEntityVACSSSg6entity_AD11descriptions10DictionaryVySSAA4JSONOGSg8metadataSbSg10fuzzyMatchSayAA11CreateValueVGSg6valuestcfc":{"name":"init(entity:description:metadata:fuzzyMatch:values:)","abstract":"

Initialize a UpdateEntity with member variables.

","parent_name":"UpdateEntity"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:14ConversationV116UpdateDialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:14ConversationV116UpdateDialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOutSlots.html#/s:14ConversationV116UpdateDialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/UpdateDialogNode/DigressOut.html#/s:14ConversationV116UpdateDialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressOut.html#/s:14ConversationV116UpdateDialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressOut.html#/s:14ConversationV116UpdateDialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/UpdateDialogNode/DigressIn.html#/s:14ConversationV116UpdateDialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/DigressIn.html#/s:14ConversationV116UpdateDialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/DigressIn.html#/s:14ConversationV116UpdateDialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/EventName.html#/s:14ConversationV116UpdateDialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html#/s:14ConversationV116UpdateDialogNodeV0E4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/UpdateDialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV06dialogE0SSSgvp":{"name":"dialogNode","abstract":"

The dialog node ID. This string must conform to the following restrictions:

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous sibling dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node. For more information about how to specify dialog node output, see the","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context for the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

The metadata for the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV8nextStepAA0de4NextG0VSgvp":{"name":"nextStep","abstract":"

The next step to be executed in dialog processing.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node. This string must conform to the following restrictions:

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV7actionsSayAA0dE6ActionVGSgvp":{"name":"actions","abstract":"

An array of objects describing any actions to be invoked by the dialog node.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"UpdateDialogNode"},"Structs/UpdateDialogNode.html#/s:14ConversationV116UpdateDialogNodeVACSSSg06dialogE0_AD11descriptionAD10conditionsAD6parentAD15previousSiblings10DictionaryVySSAA4JSONOGSg6outputAO7contextAO8metadataAA0dE8NextStepVSg04nextR0AD5titleAD8nodeTypeAD9eventNameAD8variableSayAA0dE6ActionVGSg7actionsAD9digressInAD10digressOutAD15digressOutSlotstcfc":{"name":"init(dialogNode:description:conditions:parent:previousSibling:output:context:metadata:nextStep:title:nodeType:eventName:variable:actions:digressIn:digressOut:digressOutSlots:)","abstract":"

Initialize a UpdateDialogNode with member variables.

","parent_name":"UpdateDialogNode"},"Structs/UpdateCounterexample.html#/s:14ConversationV120UpdateCounterexampleV4textSSSgvp":{"name":"text","abstract":"

The text of a user input counterexample.

","parent_name":"UpdateCounterexample"},"Structs/UpdateCounterexample.html#/s:14ConversationV120UpdateCounterexampleVACSSSg4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a UpdateCounterexample with member variables.

","parent_name":"UpdateCounterexample"},"Structs/SystemResponse.html#/s:14ConversationV114SystemResponseV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:14ConversationV114SystemResponseVACs10DictionaryVySSAA4JSONOG20additionalProperties_tcfc":{"name":"init(additionalProperties:)","abstract":"

Initialize a SystemResponse.

","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"SystemResponse"},"Structs/SystemResponse.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"SystemResponse"},"Structs/SynonymCollection.html#/s:14ConversationV117SynonymCollectionV8synonymsSayAA0C0VGvp":{"name":"synonyms","abstract":"

An array of synonyms.

","parent_name":"SynonymCollection"},"Structs/SynonymCollection.html#/s:14ConversationV117SynonymCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"SynonymCollection"},"Structs/Synonym.html#/s:14ConversationV17SynonymV11synonymTextSSvp":{"name":"synonymText","abstract":"

The text of the synonym.

","parent_name":"Synonym"},"Structs/Synonym.html#/s:14ConversationV17SynonymV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the synonym.

","parent_name":"Synonym"},"Structs/Synonym.html#/s:14ConversationV17SynonymV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the most recent update to the synonym.

","parent_name":"Synonym"},"Structs/RuntimeIntent.html#/s:14ConversationV113RuntimeIntentV6intentSSvp":{"name":"intent","abstract":"

The name of the recognized intent.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:14ConversationV113RuntimeIntentV10confidenceSdvp":{"name":"confidence","abstract":"

A decimal percentage that represents Watson’s confidence in the intent.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:14ConversationV113RuntimeIntentV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:14ConversationV113RuntimeIntentVACSS6intent_Sd10confidences10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(intent:confidence:additionalProperties:)","abstract":"

Initialize a RuntimeIntent with member variables.

","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"RuntimeIntent"},"Structs/RuntimeIntent.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"RuntimeIntent"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV6entitySSvp":{"name":"entity","abstract":"

An entity detected in the input.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV8locationSaySiGvp":{"name":"location","abstract":"

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV5valueSSvp":{"name":"value","abstract":"

The term in the input text that was recognized as an entity value.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV10confidenceSdSgvp":{"name":"confidence","abstract":"

A decimal percentage that represents Watson’s confidence in the entity.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata for the entity.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV6groupsSayAA12CaptureGroupVGSgvp":{"name":"groups","abstract":"

The recognized capture groups for the entity, as defined by the entity pattern.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:14ConversationV113RuntimeEntityVACSS6entity_SaySiG8locationSS5valueSdSg10confidences10DictionaryVySSAA4JSONOGSg8metadataSayAA12CaptureGroupVGSg6groupsAN20additionalPropertiestcfc":{"name":"init(entity:location:value:confidence:metadata:groups:additionalProperties:)","abstract":"

Initialize a RuntimeEntity with member variables.

","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"RuntimeEntity"},"Structs/RuntimeEntity.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"RuntimeEntity"},"Structs/Pagination.html#/s:14ConversationV110PaginationV10refreshUrlSSvp":{"name":"refreshUrl","abstract":"

The URL that will return the same page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:14ConversationV110PaginationV7nextUrlSSSgvp":{"name":"nextUrl","abstract":"

The URL that will return the next page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:14ConversationV110PaginationV5totalSiSgvp":{"name":"total","abstract":"

Reserved for future use.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:14ConversationV110PaginationV7matchedSiSgvp":{"name":"matched","abstract":"

Reserved for future use.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:14ConversationV110PaginationV13refreshCursorSSSgvp":{"name":"refreshCursor","abstract":"

A token identifying the current page of results.

","parent_name":"Pagination"},"Structs/Pagination.html#/s:14ConversationV110PaginationV10nextCursorSSSgvp":{"name":"nextCursor","abstract":"

A token identifying the next page of results.

","parent_name":"Pagination"},"Structs/OutputData.html#/s:14ConversationV110OutputDataV11logMessagesSayAA10LogMessageVGvp":{"name":"logMessages","abstract":"

An array of up to 50 messages logged with the request.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:14ConversationV110OutputDataV4textSaySSGvp":{"name":"text","abstract":"

An array of responses to the user.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:14ConversationV110OutputDataV12nodesVisitedSaySSGSgvp":{"name":"nodesVisited","abstract":"

An array of the nodes that were triggered to create the response, in the order in which they were visited. This","parent_name":"OutputData"},"Structs/OutputData.html#/s:14ConversationV110OutputDataV19nodesVisitedDetailsSayAA010DialogNodefG0VGSgvp":{"name":"nodesVisitedDetails","abstract":"

An array of objects containing detailed diagnostic information about the nodes that were triggered during","parent_name":"OutputData"},"Structs/OutputData.html#/s:14ConversationV110OutputDataV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:14ConversationV110OutputDataVACSayAA10LogMessageVG11logMessages_SaySSG4textAHSg12nodesVisitedSayAA010DialogNodeK7DetailsVGSg0jkN0s10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(logMessages:text:nodesVisited:nodesVisitedDetails:additionalProperties:)","abstract":"

Initialize a OutputData with member variables.

","parent_name":"OutputData"},"Structs/OutputData.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"OutputData"},"Structs/OutputData.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"OutputData"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV5inputAA0C5InputVSgvp":{"name":"input","abstract":"

The user input from the request.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV7intentsSayAA13RuntimeIntentVGvp":{"name":"intents","abstract":"

An array of intents recognized in the user input, sorted in descending order of confidence.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV8entitiesSayAA13RuntimeEntityVGvp":{"name":"entities","abstract":"

An array of entities identified in the user input.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV16alternateIntentsSbSgvp":{"name":"alternateIntents","abstract":"

Whether to return more than one intent. A value of true indicates that all matching intents are returned.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV7contextAA7ContextVvp":{"name":"context","abstract":"

State information for the conversation.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV6outputAA10OutputDataVvp":{"name":"output","abstract":"

Output from the dialog, including the response to the user, the nodes that were triggered, and log messages.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:14ConversationV115MessageResponseV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"MessageResponse"},"Structs/MessageResponse.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"MessageResponse"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV5inputAA9InputDataVSgvp":{"name":"input","abstract":"

An input object that includes the input text.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV16alternateIntentsSbSgvp":{"name":"alternateIntents","abstract":"

Whether to return more than one intent. Set to true to return all matching intents.

","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV7contextAA7ContextVSgvp":{"name":"context","abstract":"

State information for the conversation. Continue a conversation by including the context object from the previous","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV8entitiesSayAA13RuntimeEntityVGSgvp":{"name":"entities","abstract":"

Entities to use when evaluating the message. Include entities from the previous response to continue using those","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV7intentsSayAA13RuntimeIntentVGSgvp":{"name":"intents","abstract":"

Intents to use when evaluating the user input. Include intents from the previous response to continue using those","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestV6outputAA10OutputDataVSgvp":{"name":"output","abstract":"

System output. Include the output from the previous response to maintain intermediate information over multiple","parent_name":"MessageRequest"},"Structs/MessageRequest.html#/s:14ConversationV114MessageRequestVAcA9InputDataVSg5input_SbSg16alternateIntentsAA7ContextVSg7contextSayAA13RuntimeEntityVGSg8entitiesSayAA0L6IntentVGSg7intentsAA06OutputF0VSg6outputtcfc":{"name":"init(input:alternateIntents:context:entities:intents:output:)","abstract":"

Initialize a MessageRequest with member variables.

","parent_name":"MessageRequest"},"Structs/MessageInput.html#/s:14ConversationV112MessageInputV4textSSSgvp":{"name":"text","abstract":"

The user’s input.

","parent_name":"MessageInput"},"Structs/LogPagination.html#/s:14ConversationV113LogPaginationV7nextUrlSSSgvp":{"name":"nextUrl","abstract":"

The URL that will return the next page of results, if any.

","parent_name":"LogPagination"},"Structs/LogPagination.html#/s:14ConversationV113LogPaginationV7matchedSiSgvp":{"name":"matched","abstract":"

Reserved for future use.

","parent_name":"LogPagination"},"Structs/LogPagination.html#/s:14ConversationV113LogPaginationV10nextCursorSSSgvp":{"name":"nextCursor","abstract":"

A token identifying the next page of results.

","parent_name":"LogPagination"},"Structs/LogMessage/Level.html#/s:14ConversationV110LogMessageV5LevelO4infoA2EmF":{"name":"info","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html#/s:14ConversationV110LogMessageV5LevelO5errorA2EmF":{"name":"error","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html#/s:14ConversationV110LogMessageV5LevelO4warnA2EmF":{"name":"warn","abstract":"

Undocumented

","parent_name":"Level"},"Structs/LogMessage/Level.html":{"name":"Level","abstract":"

The severity of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:14ConversationV110LogMessageV5levelSSvp":{"name":"level","abstract":"

The severity of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:14ConversationV110LogMessageV3msgSSvp":{"name":"msg","abstract":"

The text of the log message.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:14ConversationV110LogMessageV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:14ConversationV110LogMessageVACSS5level_SS3msgs10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(level:msg:additionalProperties:)","abstract":"

Initialize a LogMessage with member variables.

","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"LogMessage"},"Structs/LogMessage.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"LogMessage"},"Structs/LogExport.html#/s:14ConversationV19LogExportV7requestAA14MessageRequestVvp":{"name":"request","abstract":"

A request received by the workspace, including the user input and context.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV8responseAA15MessageResponseVvp":{"name":"response","abstract":"

The response sent by the workspace, including the output text, detected intents and entities, and context.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV5logIDSSvp":{"name":"logID","abstract":"

A unique identifier for the logged event.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV16requestTimestampSSvp":{"name":"requestTimestamp","abstract":"

The timestamp for receipt of the message.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV17responseTimestampSSvp":{"name":"responseTimestamp","abstract":"

The timestamp for the system response to the message.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV11workspaceIDSSvp":{"name":"workspaceID","abstract":"

The unique identifier of the workspace where the request was made.

","parent_name":"LogExport"},"Structs/LogExport.html#/s:14ConversationV19LogExportV8languageSSvp":{"name":"language","abstract":"

The language of the workspace where the message request was made.

","parent_name":"LogExport"},"Structs/LogCollection.html#/s:14ConversationV113LogCollectionV4logsSayAA0C6ExportVGvp":{"name":"logs","abstract":"

An array of objects describing log events.

","parent_name":"LogCollection"},"Structs/LogCollection.html#/s:14ConversationV113LogCollectionV10paginationAA0C10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"LogCollection"},"Structs/IntentExport.html#/s:14ConversationV112IntentExportV10intentNameSSvp":{"name":"intentName","abstract":"

The name of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:14ConversationV112IntentExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:14ConversationV112IntentExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:14ConversationV112IntentExportV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"IntentExport"},"Structs/IntentExport.html#/s:14ConversationV112IntentExportV8examplesSayAA7ExampleVGSgvp":{"name":"examples","abstract":"

An array of objects describing the user input examples for the intent.

","parent_name":"IntentExport"},"Structs/IntentCollection.html#/s:14ConversationV116IntentCollectionV7intentsSayAA0C6ExportVGvp":{"name":"intents","abstract":"

An array of objects describing the intents defined for the workspace.

","parent_name":"IntentCollection"},"Structs/IntentCollection.html#/s:14ConversationV116IntentCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"IntentCollection"},"Structs/Intent.html#/s:14ConversationV16IntentV10intentNameSSvp":{"name":"intentName","abstract":"

The name of the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:14ConversationV16IntentV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:14ConversationV16IntentV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the intent.

","parent_name":"Intent"},"Structs/Intent.html#/s:14ConversationV16IntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent.

","parent_name":"Intent"},"Structs/InputData.html#/s:14ConversationV19InputDataV4textSSvp":{"name":"text","abstract":"

The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be","parent_name":"InputData"},"Structs/InputData.html#/s:14ConversationV19InputDataVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a InputData with member variables.

","parent_name":"InputData"},"Structs/ExampleCollection.html#/s:14ConversationV117ExampleCollectionV8examplesSayAA0C0VGvp":{"name":"examples","abstract":"

An array of objects describing the examples defined for the intent.

","parent_name":"ExampleCollection"},"Structs/ExampleCollection.html#/s:14ConversationV117ExampleCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"ExampleCollection"},"Structs/Example.html#/s:14ConversationV17ExampleV11exampleTextSSvp":{"name":"exampleText","abstract":"

The text of the user input example.

","parent_name":"Example"},"Structs/Example.html#/s:14ConversationV17ExampleV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the example.

","parent_name":"Example"},"Structs/Example.html#/s:14ConversationV17ExampleV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the example.

","parent_name":"Example"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV10entityNameSSvp":{"name":"entityName","abstract":"

The name of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether fuzzy matching is used for the entity.

","parent_name":"EntityExport"},"Structs/EntityExport.html#/s:14ConversationV112EntityExportV6valuesSayAA05ValueD0VGSgvp":{"name":"values","abstract":"

An array objects describing the entity values.

","parent_name":"EntityExport"},"Structs/EntityCollection.html#/s:14ConversationV116EntityCollectionV8entitiesSayAA0C6ExportVGvp":{"name":"entities","abstract":"

An array of objects describing the entities defined for the workspace.

","parent_name":"EntityCollection"},"Structs/EntityCollection.html#/s:14ConversationV116EntityCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"EntityCollection"},"Structs/Entity.html#/s:14ConversationV16EntityV10entityNameSSvp":{"name":"entityName","abstract":"

The name of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:14ConversationV16EntityV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:14ConversationV16EntityV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:14ConversationV16EntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:14ConversationV16EntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity.

","parent_name":"Entity"},"Structs/Entity.html#/s:14ConversationV16EntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether fuzzy matching is used for the entity.

","parent_name":"Entity"},"Structs/DialogNodeVisitedDetails.html#/s:14ConversationV124DialogNodeVisitedDetailsV06dialogD0SSSgvp":{"name":"dialogNode","abstract":"

A dialog node that was triggered during processing of the input message.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:14ConversationV124DialogNodeVisitedDetailsV5titleSSSgvp":{"name":"title","abstract":"

The title of the dialog node.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:14ConversationV124DialogNodeVisitedDetailsV10conditionsSSSgvp":{"name":"conditions","abstract":"

The conditions that trigger the dialog node.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeVisitedDetails.html#/s:14ConversationV124DialogNodeVisitedDetailsVACSSSg06dialogD0_AD5titleAD10conditionstcfc":{"name":"init(dialogNode:title:conditions:)","abstract":"

Initialize a DialogNodeVisitedDetails with member variables.

","parent_name":"DialogNodeVisitedDetails"},"Structs/DialogNodeNextStep/Selector.html#/s:14ConversationV118DialogNodeNextStepV8SelectorO9conditionA2EmF":{"name":"condition","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:14ConversationV118DialogNodeNextStepV8SelectorO6clientA2EmF":{"name":"client","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:14ConversationV118DialogNodeNextStepV8SelectorO9userInputA2EmF":{"name":"userInput","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Selector.html#/s:14ConversationV118DialogNodeNextStepV8SelectorO4bodyA2EmF":{"name":"body","abstract":"

Undocumented

","parent_name":"Selector"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO12getUserInputA2EmF":{"name":"getUserInput","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO13skipUserInputA2EmF":{"name":"skipUserInput","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO6jumpToA2EmF":{"name":"jumpTo","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO8repromptA2EmF":{"name":"reprompt","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO8skipSlotA2EmF":{"name":"skipSlot","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html#/s:14ConversationV118DialogNodeNextStepV8BehaviorO12skipAllSlotsA2EmF":{"name":"skipAllSlots","abstract":"

Undocumented

","parent_name":"Behavior"},"Structs/DialogNodeNextStep/Behavior.html":{"name":"Behavior","abstract":"

What happens after the dialog node completes. The valid values depend on the node type:

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep/Selector.html":{"name":"Selector","abstract":"

Which part of the dialog node to process next.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:14ConversationV118DialogNodeNextStepV8behaviorSSvp":{"name":"behavior","abstract":"

What happens after the dialog node completes. The valid values depend on the node type:

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:14ConversationV118DialogNodeNextStepV06dialogD0SSSgvp":{"name":"dialogNode","abstract":"

The ID of the dialog node to process next. This parameter is required if behavior=jump_to.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:14ConversationV118DialogNodeNextStepV8selectorSSSgvp":{"name":"selector","abstract":"

Which part of the dialog node to process next.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeNextStep.html#/s:14ConversationV118DialogNodeNextStepVACSS8behavior_SSSg06dialogD0AE8selectortcfc":{"name":"init(behavior:dialogNode:selector:)","abstract":"

Initialize a DialogNodeNextStep with member variables.

","parent_name":"DialogNodeNextStep"},"Structs/DialogNodeCollection.html#/s:14ConversationV120DialogNodeCollectionV11dialogNodesSayAA0cD0VGvp":{"name":"dialogNodes","abstract":"

An array of objects describing the dialog nodes defined for the workspace.

","parent_name":"DialogNodeCollection"},"Structs/DialogNodeCollection.html#/s:14ConversationV120DialogNodeCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"DialogNodeCollection"},"Structs/DialogNodeAction/ActionType.html#/s:14ConversationV116DialogNodeActionV0E4TypeO6clientA2EmF":{"name":"client","abstract":"

Undocumented

","parent_name":"ActionType"},"Structs/DialogNodeAction/ActionType.html#/s:14ConversationV116DialogNodeActionV0E4TypeO6serverA2EmF":{"name":"server","abstract":"

Undocumented

","parent_name":"ActionType"},"Structs/DialogNodeAction/ActionType.html":{"name":"ActionType","abstract":"

The type of action to invoke.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionV4nameSSvp":{"name":"name","abstract":"

The name of the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionV10actionTypeSSSgvp":{"name":"actionType","abstract":"

The type of action to invoke.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionV10parameterss10DictionaryVySSAA4JSONOGSgvp":{"name":"parameters","abstract":"

A map of key/value pairs to be provided to the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionV14resultVariableSSvp":{"name":"resultVariable","abstract":"

The location in the dialog context where the result of the action is stored.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionV11credentialsSSSgvp":{"name":"credentials","abstract":"

The name of the context variable that the client application will use to pass in credentials for the action.

","parent_name":"DialogNodeAction"},"Structs/DialogNodeAction.html#/s:14ConversationV116DialogNodeActionVACSS4name_SS14resultVariableSSSg10actionTypes10DictionaryVySSAA4JSONOGSg10parametersAF11credentialstcfc":{"name":"init(name:resultVariable:actionType:parameters:credentials:)","abstract":"

Initialize a DialogNodeAction with member variables.

","parent_name":"DialogNodeAction"},"Structs/DialogNode/DigressOutSlots.html#/s:14ConversationV110DialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOutSlots.html#/s:14ConversationV110DialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOutSlots.html#/s:14ConversationV110DialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/DialogNode/DigressOut.html#/s:14ConversationV110DialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressOut.html#/s:14ConversationV110DialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressOut.html#/s:14ConversationV110DialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/DialogNode/DigressIn.html#/s:14ConversationV110DialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/DigressIn.html#/s:14ConversationV110DialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/DigressIn.html#/s:14ConversationV110DialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/EventName.html#/s:14ConversationV110DialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html#/s:14ConversationV110DialogNodeV0D4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/DialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"DialogNode"},"Structs/DialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV06dialogD2IDSSvp":{"name":"dialogNodeID","abstract":"

The dialog node ID.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that triggers the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node. This property is not returned if the dialog node has no parent.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous sibling dialog node. This property is not returned if the dialog node has no previous","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context (if defined) for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV8nextStepAA0cd4NextF0VSgvp":{"name":"nextStep","abstract":"

The next step to execute following this dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the most recent update to the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV7actionsSayAA0cD6ActionVGSgvp":{"name":"actions","abstract":"

The actions for the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"DialogNode"},"Structs/DialogNode.html#/s:14ConversationV110DialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"DialogNode"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV4nameSSSgvp":{"name":"name","abstract":"

The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV8languageSSSgvp":{"name":"language","abstract":"

The language of the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV7intentsSayAA0C6IntentVGSgvp":{"name":"intents","abstract":"

An array of objects defining the intents for the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV8entitiesSayAA0C6EntityVGSgvp":{"name":"entities","abstract":"

An array of objects defining the entities for the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV11dialogNodesSayAA0C10DialogNodeVGSgvp":{"name":"dialogNodes","abstract":"

An array of objects defining the nodes in the workspace dialog.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV15counterexamplesSayAA0C14CounterexampleVGSgvp":{"name":"counterexamples","abstract":"

An array of objects defining input examples that have been marked as irrelevant input.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the workspace.

","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceV14learningOptOutSbSgvp":{"name":"learningOptOut","abstract":"

Whether training data from the workspace can be used by IBM for general service improvements. true indicates that","parent_name":"CreateWorkspace"},"Structs/CreateWorkspace.html#/s:14ConversationV115CreateWorkspaceVACSSSg4name_AD11descriptionAD8languageSayAA0C6IntentVGSg7intentsSayAA0C6EntityVGSg8entitiesSayAA0C10DialogNodeVGSg11dialogNodesSayAA0C14CounterexampleVGSg15counterexampless10DictionaryVySSAA4JSONOGSg8metadataSbSg14learningOptOuttcfc":{"name":"init(name:description:language:intents:entities:dialogNodes:counterexamples:metadata:learningOptOut:)","abstract":"

Initialize a CreateWorkspace with member variables.

","parent_name":"CreateWorkspace"},"Structs/CreateValue/ValueType.html#/s:14ConversationV111CreateValueV0D4TypeO8synonymsA2EmF":{"name":"synonyms","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/CreateValue/ValueType.html#/s:14ConversationV111CreateValueV0D4TypeO8patternsA2EmF":{"name":"patterns","abstract":"

Undocumented

","parent_name":"ValueType"},"Structs/CreateValue/ValueType.html":{"name":"ValueType","abstract":"

Specifies the type of value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueV5valueSSvp":{"name":"value","abstract":"

The text of the entity value. This string must conform to the following restrictions:

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the entity value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueV8synonymsSaySSGSgvp":{"name":"synonyms","abstract":"

An array containing any synonyms for the entity value. You can provide either synonyms or patterns (as indicated by","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueV8patternsSaySSGSgvp":{"name":"patterns","abstract":"

An array of patterns for the entity value. You can provide either synonyms or patterns (as indicated by type),","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueV9valueTypeSSSgvp":{"name":"valueType","abstract":"

Specifies the type of value.

","parent_name":"CreateValue"},"Structs/CreateValue.html#/s:14ConversationV111CreateValueVACSS5value_s10DictionaryVySSAA4JSONOGSg8metadataSaySSGSg8synonymsAM8patternsSSSg0E4Typetcfc":{"name":"init(value:metadata:synonyms:patterns:valueType:)","abstract":"

Initialize a CreateValue with member variables.

","parent_name":"CreateValue"},"Structs/CreateSynonym.html#/s:14ConversationV113CreateSynonymV7synonymSSvp":{"name":"synonym","abstract":"

The text of the synonym. This string must conform to the following restrictions:

","parent_name":"CreateSynonym"},"Structs/CreateSynonym.html#/s:14ConversationV113CreateSynonymVACSS7synonym_tcfc":{"name":"init(synonym:)","abstract":"

Initialize a CreateSynonym with member variables.

","parent_name":"CreateSynonym"},"Structs/CreateIntent.html#/s:14ConversationV112CreateIntentV6intentSSvp":{"name":"intent","abstract":"

The name of the intent. This string must conform to the following restrictions:

","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:14ConversationV112CreateIntentV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the intent. This string cannot contain carriage return, newline, or tab characters, and it must","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:14ConversationV112CreateIntentV8examplesSayAA0C7ExampleVGSgvp":{"name":"examples","abstract":"

An array of user input examples for the intent.

","parent_name":"CreateIntent"},"Structs/CreateIntent.html#/s:14ConversationV112CreateIntentVACSS6intent_SSSg11descriptionSayAA0C7ExampleVGSg8examplestcfc":{"name":"init(intent:description:examples:)","abstract":"

Initialize a CreateIntent with member variables.

","parent_name":"CreateIntent"},"Structs/CreateExample.html#/s:14ConversationV113CreateExampleV4textSSvp":{"name":"text","abstract":"

The text of a user input example. This string must conform to the following restrictions:

","parent_name":"CreateExample"},"Structs/CreateExample.html#/s:14ConversationV113CreateExampleVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a CreateExample with member variables.

","parent_name":"CreateExample"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityV6entitySSvp":{"name":"entity","abstract":"

The name of the entity. This string must conform to the following restrictions:

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the entity. This string cannot contain carriage return, newline, or tab characters, and it must","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Any metadata related to the value.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityV6valuesSayAA0C5ValueVGSgvp":{"name":"values","abstract":"

An array of objects describing the entity values.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityV10fuzzyMatchSbSgvp":{"name":"fuzzyMatch","abstract":"

Whether to use fuzzy matching for the entity.

","parent_name":"CreateEntity"},"Structs/CreateEntity.html#/s:14ConversationV112CreateEntityVACSS6entity_SSSg11descriptions10DictionaryVySSAA4JSONOGSg8metadataSayAA0C5ValueVGSg6valuesSbSg10fuzzyMatchtcfc":{"name":"init(entity:description:metadata:values:fuzzyMatch:)","abstract":"

Initialize a CreateEntity with member variables.

","parent_name":"CreateEntity"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:14ConversationV116CreateDialogNodeV15DigressOutSlotsO10notAllowedA2EmF":{"name":"notAllowed","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:14ConversationV116CreateDialogNodeV15DigressOutSlotsO14allowReturningA2EmF":{"name":"allowReturning","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOutSlots.html#/s:14ConversationV116CreateDialogNodeV15DigressOutSlotsO8allowAllA2EmF":{"name":"allowAll","abstract":"

Undocumented

","parent_name":"DigressOutSlots"},"Structs/CreateDialogNode/DigressOut.html#/s:14ConversationV116CreateDialogNodeV10DigressOutO9returningA2EmF":{"name":"returning","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressOut.html#/s:14ConversationV116CreateDialogNodeV10DigressOutO3allA2EmF":{"name":"all","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressOut.html#/s:14ConversationV116CreateDialogNodeV10DigressOutO14allNeverReturnA2EmF":{"name":"allNeverReturn","abstract":"

Undocumented

","parent_name":"DigressOut"},"Structs/CreateDialogNode/DigressIn.html#/s:14ConversationV116CreateDialogNodeV9DigressInO12notAvailableA2EmF":{"name":"notAvailable","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/DigressIn.html#/s:14ConversationV116CreateDialogNodeV9DigressInO7returnsA2EmF":{"name":"returns","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/DigressIn.html#/s:14ConversationV116CreateDialogNodeV9DigressInO13doesNotReturnA2EmF":{"name":"doesNotReturn","abstract":"

Undocumented

","parent_name":"DigressIn"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO5focusA2EmF":{"name":"focus","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO5inputA2EmF":{"name":"input","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO6filledA2EmF":{"name":"filled","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO8validateA2EmF":{"name":"validate","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO14filledMultipleA2EmF":{"name":"filledMultiple","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO7genericA2EmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO7nomatchA2EmF":{"name":"nomatch","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO24nomatchResponsesDepletedA2EmF":{"name":"nomatchResponsesDepleted","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/EventName.html#/s:14ConversationV116CreateDialogNodeV9EventNameO22digressionReturnPromptA2EmF":{"name":"digressionReturnPrompt","abstract":"

Undocumented

","parent_name":"EventName"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO8standardA2EmF":{"name":"standard","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO12eventHandlerA2EmF":{"name":"eventHandler","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO5frameA2EmF":{"name":"frame","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO4slotA2EmF":{"name":"slot","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO17responseConditionA2EmF":{"name":"responseCondition","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html#/s:14ConversationV116CreateDialogNodeV0E4TypeO6folderA2EmF":{"name":"folder","abstract":"

Undocumented

","parent_name":"NodeType"},"Structs/CreateDialogNode/NodeType.html":{"name":"NodeType","abstract":"

How the dialog node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/EventName.html":{"name":"EventName","abstract":"

How an event_handler node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressIn.html":{"name":"DigressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressOut.html":{"name":"DigressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode/DigressOutSlots.html":{"name":"DigressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV06dialogE0SSvp":{"name":"dialogNode","abstract":"

The dialog node ID. This string must conform to the following restrictions:

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the dialog node. This string cannot contain carriage return, newline, or tab characters, and it","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV10conditionsSSSgvp":{"name":"conditions","abstract":"

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV6parentSSSgvp":{"name":"parent","abstract":"

The ID of the parent dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV15previousSiblingSSSgvp":{"name":"previousSibling","abstract":"

The ID of the previous dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV6outputs10DictionaryVySSAA4JSONOGSgvp":{"name":"output","abstract":"

The output of the dialog node. For more information about how to specify dialog node output, see the","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV7contexts10DictionaryVySSAA4JSONOGSgvp":{"name":"context","abstract":"

The context for the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

The metadata for the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV8nextStepAA0de4NextG0VSgvp":{"name":"nextStep","abstract":"

The next step to be executed in dialog processing.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV7actionsSayAA0dE6ActionVGSgvp":{"name":"actions","abstract":"

An array of objects describing any actions to be invoked by the dialog node.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV5titleSSSgvp":{"name":"title","abstract":"

The alias used to identify the dialog node. This string must conform to the following restrictions:

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV8nodeTypeSSSgvp":{"name":"nodeType","abstract":"

How the dialog node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV9eventNameSSSgvp":{"name":"eventName","abstract":"

How an event_handler node is processed.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV8variableSSSgvp":{"name":"variable","abstract":"

The location in the dialog context where output is stored.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV9digressInSSSgvp":{"name":"digressIn","abstract":"

Whether this top-level dialog node can be digressed into.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV10digressOutSSSgvp":{"name":"digressOut","abstract":"

Whether this dialog node can be returned to after a digression.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeV15digressOutSlotsSSSgvp":{"name":"digressOutSlots","abstract":"

Whether the user can digress to top-level nodes while filling out slots.

","parent_name":"CreateDialogNode"},"Structs/CreateDialogNode.html#/s:14ConversationV116CreateDialogNodeVACSS06dialogE0_SSSg11descriptionAE10conditionsAE6parentAE15previousSiblings10DictionaryVySSAA4JSONOGSg6outputAO7contextAO8metadataAA0dE8NextStepVSg04nextR0SayAA0dE6ActionVGSg7actionsAE5titleAE8nodeTypeAE9eventNameAE8variableAE9digressInAE10digressOutAE15digressOutSlotstcfc":{"name":"init(dialogNode:description:conditions:parent:previousSibling:output:context:metadata:nextStep:actions:title:nodeType:eventName:variable:digressIn:digressOut:digressOutSlots:)","abstract":"

Initialize a CreateDialogNode with member variables.

","parent_name":"CreateDialogNode"},"Structs/CreateCounterexample.html#/s:14ConversationV120CreateCounterexampleV4textSSvp":{"name":"text","abstract":"

The text of a user input marked as irrelevant input. This string must conform to the following restrictions:

","parent_name":"CreateCounterexample"},"Structs/CreateCounterexample.html#/s:14ConversationV120CreateCounterexampleVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a CreateCounterexample with member variables.

","parent_name":"CreateCounterexample"},"Structs/CounterexampleCollection.html#/s:14ConversationV124CounterexampleCollectionV15counterexamplesSayAA0C0VGvp":{"name":"counterexamples","abstract":"

An array of objects describing the examples marked as irrelevant input.

","parent_name":"CounterexampleCollection"},"Structs/CounterexampleCollection.html#/s:14ConversationV124CounterexampleCollectionV10paginationAA10PaginationVvp":{"name":"pagination","abstract":"

The pagination data for the returned objects.

","parent_name":"CounterexampleCollection"},"Structs/Counterexample.html#/s:14ConversationV114CounterexampleV4textSSvp":{"name":"text","abstract":"

The text of the counterexample.

","parent_name":"Counterexample"},"Structs/Counterexample.html#/s:14ConversationV114CounterexampleV7createdSSSgvp":{"name":"created","abstract":"

The timestamp for creation of the counterexample.

","parent_name":"Counterexample"},"Structs/Counterexample.html#/s:14ConversationV114CounterexampleV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp for the last update to the counterexample.

","parent_name":"Counterexample"},"Structs/Context.html#/s:14ConversationV17ContextV14conversationIDSSSgvp":{"name":"conversationID","abstract":"

The unique identifier of the conversation.

","parent_name":"Context"},"Structs/Context.html#/s:14ConversationV17ContextV6systemAA14SystemResponseVSgvp":{"name":"system","abstract":"

For internal use only.

","parent_name":"Context"},"Structs/Context.html#/s:14ConversationV17ContextV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"Context"},"Structs/Context.html#/s:14ConversationV17ContextVACSSSg14conversationID_AA14SystemResponseVSg6systems10DictionaryVySSAA4JSONOG20additionalPropertiestcfc":{"name":"init(conversationID:system:additionalProperties:)","abstract":"

Initialize a Context with member variables.

","parent_name":"Context"},"Structs/Context.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"Context"},"Structs/Context.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"Context"},"Structs/CaptureGroup.html#/s:14ConversationV112CaptureGroupV5groupSSvp":{"name":"group","abstract":"

A recognized capture group for the entity.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html#/s:14ConversationV112CaptureGroupV8locationSaySiGSgvp":{"name":"location","abstract":"

Zero-based character offsets that indicate where the entity value begins and ends in the input text.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html#/s:14ConversationV112CaptureGroupVACSS5group_SaySiGSg8locationtcfc":{"name":"init(group:location:)","abstract":"

Initialize a CaptureGroup with member variables.

","parent_name":"CaptureGroup"},"Structs/CaptureGroup.html":{"name":"CaptureGroup","abstract":"

CaptureGroup.

"},"Structs/Context.html":{"name":"Context","abstract":"

State information for the conversation. To maintain state, include the context from the previous response.

"},"Structs/Counterexample.html":{"name":"Counterexample","abstract":"

Counterexample.

"},"Structs/CounterexampleCollection.html":{"name":"CounterexampleCollection","abstract":"

CounterexampleCollection.

"},"Structs/CreateCounterexample.html":{"name":"CreateCounterexample","abstract":"

CreateCounterexample.

"},"Structs/CreateDialogNode.html":{"name":"CreateDialogNode","abstract":"

CreateDialogNode.

"},"Structs/CreateEntity.html":{"name":"CreateEntity","abstract":"

CreateEntity.

"},"Structs/CreateExample.html":{"name":"CreateExample","abstract":"

CreateExample.

"},"Structs/CreateIntent.html":{"name":"CreateIntent","abstract":"

CreateIntent.

"},"Structs/CreateSynonym.html":{"name":"CreateSynonym","abstract":"

CreateSynonym.

"},"Structs/CreateValue.html":{"name":"CreateValue","abstract":"

CreateValue.

"},"Structs/CreateWorkspace.html":{"name":"CreateWorkspace","abstract":"

CreateWorkspace.

"},"Structs/DialogNode.html":{"name":"DialogNode","abstract":"

DialogNode.

"},"Structs/DialogNodeAction.html":{"name":"DialogNodeAction","abstract":"

DialogNodeAction.

"},"Structs/DialogNodeCollection.html":{"name":"DialogNodeCollection","abstract":"

An array of dialog nodes.

"},"Structs/DialogNodeNextStep.html":{"name":"DialogNodeNextStep","abstract":"

The next step to execute following this dialog node.

"},"Structs/DialogNodeVisitedDetails.html":{"name":"DialogNodeVisitedDetails","abstract":"

DialogNodeVisitedDetails.

"},"Structs/Entity.html":{"name":"Entity","abstract":"

Entity.

"},"Structs/EntityCollection.html":{"name":"EntityCollection","abstract":"

An array of entities.

"},"Structs/EntityExport.html":{"name":"EntityExport","abstract":"

EntityExport.

"},"Structs/Example.html":{"name":"Example","abstract":"

Example.

"},"Structs/ExampleCollection.html":{"name":"ExampleCollection","abstract":"

ExampleCollection.

"},"Structs/InputData.html":{"name":"InputData","abstract":"

The user input.

"},"Structs/Intent.html":{"name":"Intent","abstract":"

Intent.

"},"Structs/IntentCollection.html":{"name":"IntentCollection","abstract":"

IntentCollection.

"},"Structs/IntentExport.html":{"name":"IntentExport","abstract":"

IntentExport.

"},"Structs/LogCollection.html":{"name":"LogCollection","abstract":"

LogCollection.

"},"Structs/LogExport.html":{"name":"LogExport","abstract":"

LogExport.

"},"Structs/LogMessage.html":{"name":"LogMessage","abstract":"

Log message details.

"},"Structs/LogPagination.html":{"name":"LogPagination","abstract":"

The pagination data for the returned objects.

"},"Structs/MessageInput.html":{"name":"MessageInput","abstract":"

The text of the user input.

"},"Structs/MessageRequest.html":{"name":"MessageRequest","abstract":"

A request formatted for the Conversation service.

"},"Structs/MessageResponse.html":{"name":"MessageResponse","abstract":"

A response from the Conversation service.

"},"Structs/OutputData.html":{"name":"OutputData","abstract":"

An output object that includes the response to the user, the nodes that were hit, and messages from the log.

"},"Structs/Pagination.html":{"name":"Pagination","abstract":"

The pagination data for the returned objects.

"},"Structs/RuntimeEntity.html":{"name":"RuntimeEntity","abstract":"

A term from the request that was identified as an entity.

"},"Structs/RuntimeIntent.html":{"name":"RuntimeIntent","abstract":"

An intent identified in the user input.

"},"Structs/Synonym.html":{"name":"Synonym","abstract":"

Synonym.

"},"Structs/SynonymCollection.html":{"name":"SynonymCollection","abstract":"

SynonymCollection.

"},"Structs/SystemResponse.html":{"name":"SystemResponse","abstract":"

For internal use only.

"},"Structs/UpdateCounterexample.html":{"name":"UpdateCounterexample","abstract":"

UpdateCounterexample.

"},"Structs/UpdateDialogNode.html":{"name":"UpdateDialogNode","abstract":"

UpdateDialogNode.

"},"Structs/UpdateEntity.html":{"name":"UpdateEntity","abstract":"

UpdateEntity.

"},"Structs/UpdateExample.html":{"name":"UpdateExample","abstract":"

UpdateExample.

"},"Structs/UpdateIntent.html":{"name":"UpdateIntent","abstract":"

UpdateIntent.

"},"Structs/UpdateSynonym.html":{"name":"UpdateSynonym","abstract":"

UpdateSynonym.

"},"Structs/UpdateValue.html":{"name":"UpdateValue","abstract":"

UpdateValue.

"},"Structs/UpdateWorkspace.html":{"name":"UpdateWorkspace","abstract":"

UpdateWorkspace.

"},"Structs/Value.html":{"name":"Value","abstract":"

Value.

"},"Structs/ValueCollection.html":{"name":"ValueCollection","abstract":"

ValueCollection.

"},"Structs/ValueExport.html":{"name":"ValueExport","abstract":"

ValueExport.

"},"Structs/Workspace.html":{"name":"Workspace","abstract":"

Workspace.

"},"Structs/WorkspaceCollection.html":{"name":"WorkspaceCollection","abstract":"

WorkspaceCollection.

"},"Structs/WorkspaceExport.html":{"name":"WorkspaceExport","abstract":"

WorkspaceExport.

"},"Enums/RestError.html#/s:14ConversationV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO013serializationD0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO08encodingD0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO011fileManagerD0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:14ConversationV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:14ConversationV14JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:14ConversationV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/Conversation.html#/s:14ConversationV10A0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

Create a Conversation object.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a Conversation object.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a Conversation object.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C7messageySS11workspaceID_AA14MessageRequestVSg7requestSbSg19nodesVisitedDetailss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F8ResponseVc7successtF":{"name":"message(workspaceID:request:nodesVisitedDetails:headers:failure:success:)","abstract":"

Get response to user input.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C14listWorkspacesySiSg9pageLimit_SbSg12includeCountSSSg4sortAI6cursorAG0G5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA19WorkspaceCollectionVc7successtF":{"name":"listWorkspaces(pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List workspaces.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C15createWorkspaceyAA06CreateD0VSg10properties_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createWorkspace(properties:headers:failure:success:)","abstract":"

Create workspace.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12getWorkspaceySS11workspaceID_SbSg6exportAF12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getWorkspace(workspaceID:export:includeAudit:headers:failure:success:)","abstract":"

Get information about a workspace.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C15updateWorkspaceySS11workspaceID_AA06UpdateD0VSg10propertiesSbSg6appends10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateWorkspace(workspaceID:properties:append:headers:failure:success:)","abstract":"

Update workspace.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C15deleteWorkspaceySS11workspaceID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteWorkspace(workspaceID:headers:failure:success:)","abstract":"

Delete workspace.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11listIntentsySS11workspaceID_SbSg6exportSiSg9pageLimitAF12includeCountSSSg4sortAK6cursorAF0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA16IntentCollectionVc7successtF":{"name":"listIntents(workspaceID:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List intents.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12createIntentySS11workspaceID_SS6intentSSSg11descriptionSayAA13CreateExampleVGSg8exampless10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createIntent(workspaceID:intent:description:examples:headers:failure:success:)","abstract":"

Create intent.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C9getIntentySS11workspaceID_SS6intentSbSg6exportAG12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getIntent(workspaceID:intent:export:includeAudit:headers:failure:success:)","abstract":"

Get intent.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12updateIntentySS11workspaceID_SS6intentSSSg03newD0AG0H11DescriptionSayAA13CreateExampleVGSg0H8Exampless10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateIntent(workspaceID:intent:newIntent:newDescription:newExamples:headers:failure:success:)","abstract":"

Update intent.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12deleteIntentySS11workspaceID_SS6intents10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteIntent(workspaceID:intent:headers:failure:success:)","abstract":"

Delete intent.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12listExamplesySS11workspaceID_SS6intentSiSg9pageLimitSbSg12includeCountSSSg4sortAK6cursorAI0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA17ExampleCollectionVc7successtF":{"name":"listExamples(workspaceID:intent:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List user input examples.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13createExampleySS11workspaceID_SS6intentSS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createExample(workspaceID:intent:text:headers:failure:success:)","abstract":"

Create user input example.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C10getExampleySS11workspaceID_SS6intentSS4textSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getExample(workspaceID:intent:text:includeAudit:headers:failure:success:)","abstract":"

Get user input example.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13updateExampleySS11workspaceID_SS6intentSS4textSSSg7newTexts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateExample(workspaceID:intent:text:newText:headers:failure:success:)","abstract":"

Update user input example.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13deleteExampleySS11workspaceID_SS6intentSS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteExample(workspaceID:intent:text:headers:failure:success:)","abstract":"

Delete user input example.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C19listCounterexamplesySS11workspaceID_SiSg9pageLimitSbSg12includeCountSSSg4sortAJ6cursorAH0I5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA24CounterexampleCollectionVc7successtF":{"name":"listCounterexamples(workspaceID:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List counterexamples.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C20createCounterexampleySS11workspaceID_SS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createCounterexample(workspaceID:text:headers:failure:success:)","abstract":"

Create counterexample.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C17getCounterexampleySS11workspaceID_SS4textSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getCounterexample(workspaceID:text:includeAudit:headers:failure:success:)","abstract":"

Get counterexample.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C20updateCounterexampleySS11workspaceID_SS4textSSSg7newTexts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateCounterexample(workspaceID:text:newText:headers:failure:success:)","abstract":"

Update counterexample.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C20deleteCounterexampleySS11workspaceID_SS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteCounterexample(workspaceID:text:headers:failure:success:)","abstract":"

Delete counterexample.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12listEntitiesySS11workspaceID_SbSg6exportSiSg9pageLimitAF12includeCountSSSg4sortAK6cursorAF0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA16EntityCollectionVc7successtF":{"name":"listEntities(workspaceID:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entities.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12createEntityySS11workspaceID_AA06CreateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createEntity(workspaceID:properties:headers:failure:success:)","abstract":"

Create entity.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C9getEntityySS11workspaceID_SS6entitySbSg6exportAG12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getEntity(workspaceID:entity:export:includeAudit:headers:failure:success:)","abstract":"

Get entity.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12updateEntityySS11workspaceID_SS6entityAA06UpdateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateEntity(workspaceID:entity:properties:headers:failure:success:)","abstract":"

Update entity.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12deleteEntityySS11workspaceID_SS6entitys10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteEntity(workspaceID:entity:headers:failure:success:)","abstract":"

Delete entity.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C10listValuesySS11workspaceID_SS6entitySbSg6exportSiSg9pageLimitAG12includeCountSSSg4sortAL6cursorAG0K5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA15ValueCollectionVc7successtF":{"name":"listValues(workspaceID:entity:export:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entity values.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11createValueySS11workspaceID_SS6entityAA06CreateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createValue(workspaceID:entity:properties:headers:failure:success:)","abstract":"

Add entity value.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C8getValueySS11workspaceID_SS6entitySS5valueSbSg6exportAH12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D6ExportVc7successtF":{"name":"getValue(workspaceID:entity:value:export:includeAudit:headers:failure:success:)","abstract":"

Get entity value.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11updateValueySS11workspaceID_SS6entitySS5valueAA06UpdateD0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateValue(workspaceID:entity:value:properties:headers:failure:success:)","abstract":"

Update entity value.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11deleteValueySS11workspaceID_SS6entitySS5values10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteValue(workspaceID:entity:value:headers:failure:success:)","abstract":"

Delete entity value.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C12listSynonymsySS11workspaceID_SS6entitySS5valueSiSg9pageLimitSbSg12includeCountSSSg4sortAL6cursorAJ0K5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA17SynonymCollectionVc7successtF":{"name":"listSynonyms(workspaceID:entity:value:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List entity value synonyms.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13createSynonymySS11workspaceID_SS6entitySS5valueSS7synonyms10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createSynonym(workspaceID:entity:value:synonym:headers:failure:success:)","abstract":"

Add entity value synonym.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C10getSynonymySS11workspaceID_SS6entitySS5valueSS7synonymSbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getSynonym(workspaceID:entity:value:synonym:includeAudit:headers:failure:success:)","abstract":"

Get entity value synonym.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13updateSynonymySS11workspaceID_SS6entitySS5valueSS7synonymSSSg03newD0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateSynonym(workspaceID:entity:value:synonym:newSynonym:headers:failure:success:)","abstract":"

Update entity value synonym.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13deleteSynonymySS11workspaceID_SS6entitySS5valueSS7synonyms10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteSynonym(workspaceID:entity:value:synonym:headers:failure:success:)","abstract":"

Delete entity value synonym.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C15listDialogNodesySS11workspaceID_SiSg9pageLimitSbSg12includeCountSSSg4sortAJ6cursorAH0J5Audits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D14NodeCollectionVc7successtF":{"name":"listDialogNodes(workspaceID:pageLimit:includeCount:sort:cursor:includeAudit:headers:failure:success:)","abstract":"

List dialog nodes.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C16createDialogNodeySS11workspaceID_AA06CreatedE0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"createDialogNode(workspaceID:properties:headers:failure:success:)","abstract":"

Create dialog node.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C13getDialogNodeySS11workspaceID_SS06dialogE0SbSg12includeAudits10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"getDialogNode(workspaceID:dialogNode:includeAudit:headers:failure:success:)","abstract":"

Get dialog node.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C16updateDialogNodeySS11workspaceID_SS06dialogE0AA06UpdatedE0V10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"updateDialogNode(workspaceID:dialogNode:properties:headers:failure:success:)","abstract":"

Update dialog node.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C16deleteDialogNodeySS11workspaceID_SS06dialogE0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteDialogNode(workspaceID:dialogNode:headers:failure:success:)","abstract":"

Delete dialog node.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C8listLogsySS11workspaceID_SSSg4sortAF6filterSiSg9pageLimitAF6cursors10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA13LogCollectionVc7successtF":{"name":"listLogs(workspaceID:sort:filter:pageLimit:cursor:headers:failure:success:)","abstract":"

List log events in a workspace.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C11listAllLogsySS6filter_SSSg4sortSiSg9pageLimitAF6cursors10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA13LogCollectionVc7successtF":{"name":"listAllLogs(filter:sort:pageLimit:cursor:headers:failure:success:)","abstract":"

List log events in all workspaces.

","parent_name":"Conversation"},"Classes/Conversation.html#/s:14ConversationV10A0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

Delete labeled data.

","parent_name":"Conversation"},"Classes/Conversation.html":{"name":"Conversation","abstract":"

The IBM Watson™ Conversation service combines machine learning, natural language understanding, and integrated"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file diff --git a/docs/swift-api/services/ConversationV1/undocumented.json b/docs/swift-api/services/ConversationV1/undocumented.json index 22cbb0567..113c71280 100644 --- a/docs/swift-api/services/ConversationV1/undocumented.json +++ b/docs/swift-api/services/ConversationV1/undocumented.json @@ -9,700 +9,700 @@ }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 24, + "line": 26, "symbol": "CreateDialogNode.NodeType.standard", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 25, + "line": 27, "symbol": "CreateDialogNode.NodeType.eventHandler", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 26, + "line": 28, "symbol": "CreateDialogNode.NodeType.frame", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 27, + "line": 29, "symbol": "CreateDialogNode.NodeType.slot", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 28, + "line": 30, "symbol": "CreateDialogNode.NodeType.responseCondition", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 29, + "line": 31, "symbol": "CreateDialogNode.NodeType.folder", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 34, + "line": 38, "symbol": "CreateDialogNode.EventName.focus", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 35, + "line": 39, "symbol": "CreateDialogNode.EventName.input", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 36, + "line": 40, "symbol": "CreateDialogNode.EventName.filled", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 37, + "line": 41, "symbol": "CreateDialogNode.EventName.validate", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 38, + "line": 42, "symbol": "CreateDialogNode.EventName.filledMultiple", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 39, + "line": 43, "symbol": "CreateDialogNode.EventName.generic", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 40, + "line": 44, "symbol": "CreateDialogNode.EventName.nomatch", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 41, + "line": 45, "symbol": "CreateDialogNode.EventName.nomatchResponsesDepleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 42, + "line": 46, "symbol": "CreateDialogNode.EventName.digressionReturnPrompt", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 47, + "line": 53, "symbol": "CreateDialogNode.DigressIn.notAvailable", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 48, + "line": 54, "symbol": "CreateDialogNode.DigressIn.returns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 49, + "line": 55, "symbol": "CreateDialogNode.DigressIn.doesNotReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 54, + "line": 62, "symbol": "CreateDialogNode.DigressOut.returning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 55, + "line": 63, "symbol": "CreateDialogNode.DigressOut.all", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 56, + "line": 64, "symbol": "CreateDialogNode.DigressOut.allNeverReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 61, + "line": 71, "symbol": "CreateDialogNode.DigressOutSlots.notAllowed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 62, + "line": 72, "symbol": "CreateDialogNode.DigressOutSlots.allowReturning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 63, + "line": 73, "symbol": "CreateDialogNode.DigressOutSlots.allowAll", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateValue.swift", - "line": 24, + "line": 26, "symbol": "CreateValue.ValueType.synonyms", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateValue.swift", - "line": 25, + "line": 27, "symbol": "CreateValue.ValueType.patterns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 24, + "line": 26, "symbol": "DialogNode.NodeType.standard", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 25, + "line": 27, "symbol": "DialogNode.NodeType.eventHandler", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 26, + "line": 28, "symbol": "DialogNode.NodeType.frame", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 27, + "line": 29, "symbol": "DialogNode.NodeType.slot", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 28, + "line": 30, "symbol": "DialogNode.NodeType.responseCondition", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 29, + "line": 31, "symbol": "DialogNode.NodeType.folder", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 34, + "line": 38, "symbol": "DialogNode.EventName.focus", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 35, + "line": 39, "symbol": "DialogNode.EventName.input", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 36, + "line": 40, "symbol": "DialogNode.EventName.filled", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 37, + "line": 41, "symbol": "DialogNode.EventName.validate", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 38, + "line": 42, "symbol": "DialogNode.EventName.filledMultiple", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 39, + "line": 43, "symbol": "DialogNode.EventName.generic", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 40, + "line": 44, "symbol": "DialogNode.EventName.nomatch", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 41, + "line": 45, "symbol": "DialogNode.EventName.nomatchResponsesDepleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 42, + "line": 46, "symbol": "DialogNode.EventName.digressionReturnPrompt", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 47, + "line": 53, "symbol": "DialogNode.DigressIn.notAvailable", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 48, + "line": 54, "symbol": "DialogNode.DigressIn.returns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 49, + "line": 55, "symbol": "DialogNode.DigressIn.doesNotReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 54, + "line": 62, "symbol": "DialogNode.DigressOut.returning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 55, + "line": 63, "symbol": "DialogNode.DigressOut.all", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 56, + "line": 64, "symbol": "DialogNode.DigressOut.allNeverReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 61, + "line": 71, "symbol": "DialogNode.DigressOutSlots.notAllowed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 62, + "line": 72, "symbol": "DialogNode.DigressOutSlots.allowReturning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 63, + "line": 73, "symbol": "DialogNode.DigressOutSlots.allowAll", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeAction.swift", - "line": 24, + "line": 26, "symbol": "DialogNodeAction.ActionType.client", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeAction.swift", - "line": 25, + "line": 27, "symbol": "DialogNodeAction.ActionType.server", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeNextStep.swift", - "line": 24, + "line": 44, "symbol": "DialogNodeNextStep.Behavior.getUserInput", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeNextStep.swift", - "line": 25, + "line": 45, "symbol": "DialogNodeNextStep.Behavior.skipUserInput", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeNextStep.swift", - "line": 26, + "line": 46, "symbol": "DialogNodeNextStep.Behavior.jumpTo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeNextStep.swift", - "line": 27, + "line": 47, "symbol": "DialogNodeNextStep.Behavior.reprompt", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeNextStep.swift", - "line": 28, + "line": 48, "symbol": "DialogNodeNextStep.Behavior.skipSlot", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeNextStep.swift", - "line": 29, + "line": 49, "symbol": "DialogNodeNextStep.Behavior.skipAllSlots", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeNextStep.swift", - "line": 34, + "line": 56, "symbol": "DialogNodeNextStep.Selector.condition", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeNextStep.swift", - "line": 35, + "line": 57, "symbol": "DialogNodeNextStep.Selector.client", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeNextStep.swift", - "line": 36, + "line": 58, "symbol": "DialogNodeNextStep.Selector.userInput", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeNextStep.swift", - "line": 37, + "line": 59, "symbol": "DialogNodeNextStep.Selector.body", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/LogMessage.swift", - "line": 24, + "line": 26, "symbol": "LogMessage.Level.info", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/LogMessage.swift", - "line": 25, + "line": 27, "symbol": "LogMessage.Level.error", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/LogMessage.swift", - "line": 26, + "line": 28, "symbol": "LogMessage.Level.warn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 24, + "line": 26, "symbol": "UpdateDialogNode.NodeType.standard", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 25, + "line": 27, "symbol": "UpdateDialogNode.NodeType.eventHandler", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 26, + "line": 28, "symbol": "UpdateDialogNode.NodeType.frame", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 27, + "line": 29, "symbol": "UpdateDialogNode.NodeType.slot", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 28, + "line": 30, "symbol": "UpdateDialogNode.NodeType.responseCondition", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 29, + "line": 31, "symbol": "UpdateDialogNode.NodeType.folder", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 34, + "line": 38, "symbol": "UpdateDialogNode.EventName.focus", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 35, + "line": 39, "symbol": "UpdateDialogNode.EventName.input", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 36, + "line": 40, "symbol": "UpdateDialogNode.EventName.filled", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 37, + "line": 41, "symbol": "UpdateDialogNode.EventName.validate", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 38, + "line": 42, "symbol": "UpdateDialogNode.EventName.filledMultiple", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 39, + "line": 43, "symbol": "UpdateDialogNode.EventName.generic", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 40, + "line": 44, "symbol": "UpdateDialogNode.EventName.nomatch", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 41, + "line": 45, "symbol": "UpdateDialogNode.EventName.nomatchResponsesDepleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 42, + "line": 46, "symbol": "UpdateDialogNode.EventName.digressionReturnPrompt", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 47, + "line": 53, "symbol": "UpdateDialogNode.DigressIn.notAvailable", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 48, + "line": 54, "symbol": "UpdateDialogNode.DigressIn.returns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 49, + "line": 55, "symbol": "UpdateDialogNode.DigressIn.doesNotReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 54, + "line": 62, "symbol": "UpdateDialogNode.DigressOut.returning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 55, + "line": 63, "symbol": "UpdateDialogNode.DigressOut.all", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 56, + "line": 64, "symbol": "UpdateDialogNode.DigressOut.allNeverReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 61, + "line": 71, "symbol": "UpdateDialogNode.DigressOutSlots.notAllowed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 62, + "line": 72, "symbol": "UpdateDialogNode.DigressOutSlots.allowReturning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 63, + "line": 73, "symbol": "UpdateDialogNode.DigressOutSlots.allowAll", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateValue.swift", - "line": 24, + "line": 26, "symbol": "UpdateValue.ValueType.synonyms", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateValue.swift", - "line": 25, + "line": 27, "symbol": "UpdateValue.ValueType.patterns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/Value.swift", - "line": 24, + "line": 26, "symbol": "Value.ValueType.synonyms", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/Value.swift", - "line": 25, + "line": 27, "symbol": "Value.ValueType.patterns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/ValueExport.swift", - "line": 24, + "line": 26, "symbol": "ValueExport.ValueType.synonyms", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/ValueExport.swift", - "line": 25, + "line": 27, "symbol": "ValueExport.ValueType.patterns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/WorkspaceExport.swift", - "line": 24, + "line": 26, "symbol": "WorkspaceExport.Status.nonExistent", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/WorkspaceExport.swift", - "line": 25, + "line": 27, "symbol": "WorkspaceExport.Status.training", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/WorkspaceExport.swift", - "line": 26, + "line": 28, "symbol": "WorkspaceExport.Status.failed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/WorkspaceExport.swift", - "line": 27, + "line": 29, "symbol": "WorkspaceExport.Status.available", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/WorkspaceExport.swift", - "line": 28, + "line": 30, "symbol": "WorkspaceExport.Status.unavailable", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" diff --git a/docs/swift-api/services/DiscoveryV1/Classes.html b/docs/swift-api/services/DiscoveryV1/Classes.html index 48d20eed4..b09ad66ca 100644 --- a/docs/swift-api/services/DiscoveryV1/Classes.html +++ b/docs/swift-api/services/DiscoveryV1/Classes.html @@ -179,9 +179,6 @@ - @@ -380,10 +377,10 @@

Classes

-

The IBM Watson Discovery Service is a cognitive search and content analytics engine that you can add to applications to -identify patterns, trends and actionable insights to drive better decision-making. Securely unify structured and -unstructured data with pre-enriched content, and use a simplified query language to eliminate the need for manual -filtering of results.

+

The IBM Watson™ Discovery Service is a cognitive search and content analytics engine that you can add to +applications to identify patterns, trends and actionable insights to drive better decision-making. Securely unify +structured and unstructured data with pre-enriched content, and use a simplified query language to eliminate the need +for manual filtering of results.

See more
@@ -403,7 +400,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Classes/Discovery.html b/docs/swift-api/services/DiscoveryV1/Classes/Discovery.html index f5e91c7af..5ec0fdc65 100644 --- a/docs/swift-api/services/DiscoveryV1/Classes/Discovery.html +++ b/docs/swift-api/services/DiscoveryV1/Classes/Discovery.html @@ -179,9 +179,6 @@ - @@ -367,10 +364,10 @@

Discovery

-

The IBM Watson Discovery Service is a cognitive search and content analytics engine that you can add to applications to -identify patterns, trends and actionable insights to drive better decision-making. Securely unify structured and -unstructured data with pre-enriched content, and use a simplified query language to eliminate the need for manual -filtering of results.

+

The IBM Watson™ Discovery Service is a cognitive search and content analytics engine that you can add to +applications to identify patterns, trends and actionable insights to drive better decision-making. Securely unify +structured and unstructured data with pre-enriched content, and use a simplified query language to eliminate the need +for manual filtering of results.

@@ -1265,12 +1262,13 @@

Parameters

Add configuration.

-

Creates a new configuration. If the input configuration contains the configuration_id, created, or updated -properties, then they are ignored and overridden by the system, and an error is not returned so that the overridden -fields do not need to be removed when copying a configuration. The configuration can contain unrecognized JSON -fields. Any such fields are ignored and do not generate an error. This makes it easier to use newer configuration -files with older versions of the API and the service. It also makes it possible for the tooling to add additional -metadata and information to the configuration.

+

Creates a new configuration. +If the input configuration contains the configuration_id, created, or updated properties, then they are +ignored and overridden by the system, and an error is not returned so that the overridden fields do not need to be +removed when copying a configuration. +The configuration can contain unrecognized JSON fields. Any such fields are ignored and do not generate an error. +This makes it easier to use newer configuration files with older versions of the API and the service. It also makes +it possible for the tooling to add additional metadata and information to the configuration.

@@ -1311,13 +1309,14 @@

Parameters

Input an object that enables you to customize how your content is ingested and what enrichments are added to your -data. name is required and must be unique within the current environment. All other properties are optional. +data. +name is required and must be unique within the current environment. All other properties are optional. If the input configuration contains the configuration_id, created, or updated properties, then they will be ignored and overridden by the system (an error is not returned so that the overridden fields do not need to be -removed when copying a configuration). The configuration can contain unrecognized JSON fields. Any such fields -will be ignored and will not generate an error. This makes it easier to use newer configuration files with older -versions of the API and the service. It also makes it possible for the tooling to add additional metadata and -information to the configuration.

+removed when copying a configuration). +The configuration can contain unrecognized JSON fields. Any such fields will be ignored and will not generate an +error. This makes it easier to use newer configuration files with older versions of the API and the service. It +also makes it possible for the tooling to add additional metadata and information to the configuration.

@@ -1578,11 +1577,16 @@

Parameters

Update a configuration.

-

Replaces an existing configuration. * Completely replaces the original configuration. * The configuration_id, -updated, and created fields are accepted in the request, but they are ignored, and an error is not generated. -It is also acceptable for users to submit an updated configuration with none of the three properties. * Documents -are processed with a snapshot of the configuration as it was at the time the document was submitted to be ingested. -This means that already submitted documents will not see any updates made to the configuration.

+

Replaces an existing configuration.

+ +
    +
  • Completely replaces the original configuration.
  • +
  • The configuration_id, updated, and created fields are accepted in the request, but they are ignored, and +an error is not generated. It is also acceptable for users to submit an updated configuration with none of the +three properties.
  • +
  • Documents are processed with a snapshot of the configuration as it was at the time the document was submitted +to be ingested. This means that already submitted documents will not see any updates made to the configuration.

  • +
@@ -1636,14 +1640,15 @@

Parameters

Input an object that enables you to update and customize how your data is ingested and what enrichments are added -to your data. The name parameter is required and must be unique within the current environment. All other -properties are optional, but if they are omitted the default values replace the current value of each omitted -property. If the input configuration contains the configuration_id, created, or updated properties, they are -ignored and overridden by the system, and an error is not returned so that the overridden fields do not need to be -removed when updating a configuration. The configuration can contain unrecognized JSON fields. Any such fields -are ignored and do not generate an error. This makes it easier to use newer configuration files with older versions -of the API and the service. It also makes it possible for the tooling to add additional metadata and information to -the configuration.

+to your data. +The name parameter is required and must be unique within the current environment. All other properties are +optional, but if they are omitted the default values replace the current value of each omitted property. +If the input configuration contains the configuration_id, created, or updated properties, they are ignored +and overridden by the system, and an error is not returned so that the overridden fields do not need to be +removed when updating a configuration. +The configuration can contain unrecognized JSON fields. Any such fields are ignored and do not generate an error. +This makes it easier to use newer configuration files with older versions of the API and the service. It also +makes it possible for the tooling to add additional metadata and information to the configuration.

@@ -1854,10 +1859,11 @@

Parameters

-

The configuration to use to process the document. If this part is provided, then the provided configuration is used -to process the document. If the configuration_id is also provided (both are present at the same time), then -request is rejected. The maximum supported configuration size is 1 MB. Configuration parts larger than 1 MB are -rejected. See the GET /configurations/{configuration_id} operation for an example configuration.

+

The configuration to use to process the document. If this part is provided, then the provided configuration is +used to process the document. If the configuration_id is also provided (both are present at the same time), +then request is rejected. The maximum supported configuration size is 1 MB. Configuration parts larger than 1 MB +are rejected. +See the GET /configurations/{configuration_id} operation for an example configuration.

@@ -1882,8 +1888,8 @@

Parameters

-

The ID of the configuration to use to process the document. If the configuration form part is also provided (both -are present at the same time), then request will be rejected.

+

The ID of the configuration to use to process the document. If the configuration form part is also provided +(both are present at the same time), then request will be rejected.

@@ -1909,8 +1915,12 @@

Parameters

If you’re using the Data Crawler to upload your documents, you can test a document against the type of metadata -that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB -are rejected. Example: { \"Creator\": \"Johnny Appleseed\", \"Subject\": \"Apples\" }.

+that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 +MB are rejected. +Example: { +\"Creator\": \"Johnny Appleseed\", +\"Subject\": \"Apples\" +}.

@@ -2723,15 +2733,8 @@

Parameters

Create or update expansion list.

Create or replace the Expansion list for this collection. The maximum number of expanded terms per collection is -500. The current expansion list is replaced with the uploaded content.

- -
    -
  • uni-directional. To create a bi-directional expansion specify an expanded_terms array. When found in a query, -all items in the expanded_terms array are then expanded to the other items in the same array. To create a -uni-directional expansion, specify both an array of input_terms and an array of expanded_terms. When items in -the input_terms array are present in a query, they are expanded using the items listed in the expanded_terms -array.
  • -
+500. +The current expansion list is replaced with the uploaded content.

@@ -2784,9 +2787,15 @@

Parameters

-

An array of query expansion definitions. Each object in the expansions array represents a term or set of terms -that will be expanded into other terms. Each expansion object can be configured so that all terms are expanded to -all other terms in the object - bi-directional, or a set list of terms can be expanded into a second list of terms

+

An array of query expansion definitions. +Each object in the expansions array represents a term or set of terms that will be expanded into other terms. +Each expansion object can be configured so that all terms are expanded to all other terms in the object - +bi-directional, or a set list of terms can be expanded into a second list of terms - uni-directional. +To create a bi-directional expansion specify an expanded_terms array. When found in a query, all items in the +expanded_terms array are then expanded to the other items in the same array. +To create a uni-directional expansion, specify both an array of input_terms and an array of expanded_terms. +When items in the input_terms array are present in a query, they are expanded using the items listed in the +expanded_terms array.

@@ -2949,16 +2958,20 @@

Parameters

Add a document.

-

Add a document to a collection with optional metadata. * The version query parameter is still required. * -Returns immediately after the system has accepted the document for processing. * The user must provide document -content, metadata, or both. If the request is missing both document content and metadata, it is rejected. * The -user can set the Content-Type parameter on the file part to indicate the media type of the document. If the -Content-Type parameter is missing or is one of the generic media types (for example, application/octet-stream), -then the service attempts to automatically detect the document’s media type. * The following field names are -reserved and will be filtered out if present after normalization: id, score, highlight, and any field with -the prefix of: _, +, or - * Fields with empty name values after normalization are filtered out before -indexing. * Fields containing the following characters after normalization are filtered out before indexing: # -and ,.

+

Add a document to a collection with optional metadata.

+ +
    +
  • The version query parameter is still required.
  • +
  • The user must provide document content, metadata, or both. If the request is missing both document content and +metadata, it is rejected.
  • +
  • The user can set the Content-Type parameter on the file part to indicate the media type of the document. If +the Content-Type parameter is missing or is one of the generic media types (for example, +application/octet-stream), then the service attempts to automatically detect the document’s media type.
  • +
  • The following field names are reserved and will be filtered out if present after normalization: id, score, +highlight, and any field with the prefix of: _, +, or -
  • +
  • Fields with empty name values after normalization are filtered out before indexing.
  • +
  • Fields containing the following characters after normalization are filtered out before indexing: # and ,.

  • +
@@ -3027,8 +3040,12 @@

Parameters

If you’re using the Data Crawler to upload your documents, you can test a document against the type of metadata -that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB -are rejected. Example: { \"Creator\": \"Johnny Appleseed\", \"Subject\": \"Apples\" }.

+that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 +MB are rejected. +Example: { +\"Creator\": \"Johnny Appleseed\", +\"Subject\": \"Apples\" +}.

@@ -3299,8 +3316,12 @@

Parameters

If you’re using the Data Crawler to upload your documents, you can test a document against the type of metadata -that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB -are rejected. Example: { \"Creator\": \"Johnny Appleseed\", \"Subject\": \"Apples\" }.

+that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 +MB are rejected. +Example: { +\"Creator\": \"Johnny Appleseed\", +\"Subject\": \"Apples\" +}.

@@ -3560,9 +3581,9 @@

Parameters

-

A cacheable query that limits the documents returned to exclude any documents that don’t mention the query content. -Filter searches are better for metadata type searches and when you are trying to get a sense of concepts in the -data set.

+

A cacheable query that limits the documents returned to exclude any documents that don’t mention the query +content. Filter searches are better for metadata type searches and when you are trying to get a sense of concepts +in the data set.

@@ -3614,8 +3635,8 @@

Parameters

An aggregation search uses combinations of filters and query search to return an exact answer. Aggregations are -useful for building applications, because you can use them to build lists, tables, and time series. For a full list -of possible aggregrations, see the Query reference.

+useful for building applications, because you can use them to build lists, tables, and time series. For a full +list of possible aggregrations, see the Query reference.

@@ -3651,8 +3672,8 @@

Parameters

-

The number of query results to skip at the beginning. For example, if the total number of results that are returned -is 10, and the offset is 8, it returns the last two results.

+

The number of query results to skip at the beginning. For example, if the total number of results that are +returned is 10, and the offset is 8, it returns the last two results.

@@ -3691,8 +3712,8 @@

Parameters

-

A comma-separated list of fields that passages are drawn from. If this parameter not specified, then all top-level -fields are included.

+

A comma-separated list of fields that passages are drawn from. If this parameter not specified, then all +top-level fields are included.

@@ -3717,8 +3738,8 @@

Parameters

-

The approximate number of characters that any one passage will have. The default is 400. The minimum is 50. The -maximum is 2000.

+

The approximate number of characters that any one passage will have. The default is 400. The minimum is 50. +The maximum is 2000.

@@ -3731,8 +3752,8 @@

Parameters

When true and used with a Watson Discovery News collection, duplicate results (based on the contents of the -title field) are removed. Duplicate comparison is limited to the current query only, offset is not considered. -Defaults to false. This parameter is currently Beta functionality.

+title field) are removed. Duplicate comparison is limited to the current query only, offset is not +considered. Defaults to false. This parameter is currently Beta functionality.

@@ -3771,10 +3792,10 @@

Parameters

-

A comma-separated list of document IDs that will be used to find similar documents. Note: If the -natural_language_query parameter is also specified, it will be used to expand the scope of the document -similarity search to include the natural language query. Other query parameters, such as filter and query are -subsequently applied and reduce the query scope.

+

A comma-separated list of document IDs that will be used to find similar documents. +Note: If the natural_language_query parameter is also specified, it will be used to expand the scope of the +document similarity search to include the natural language query. Other query parameters, such as filter and +query are subsequently applied and reduce the query scope.

@@ -3786,8 +3807,8 @@

Parameters

-

A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If -not specified, the entire document is used for comparison.

+

A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. +If not specified, the entire document is used for comparison.

@@ -3920,9 +3941,9 @@

Parameters

-

A cacheable query that limits the documents returned to exclude any documents that don’t mention the query content. -Filter searches are better for metadata type searches and when you are trying to get a sense of concepts in the -data set.

+

A cacheable query that limits the documents returned to exclude any documents that don’t mention the query +content. Filter searches are better for metadata type searches and when you are trying to get a sense of concepts +in the data set.

@@ -3974,8 +3995,8 @@

Parameters

An aggregation search uses combinations of filters and query search to return an exact answer. Aggregations are -useful for building applications, because you can use them to build lists, tables, and time series. For a full list -of possible aggregrations, see the Query reference.

+useful for building applications, because you can use them to build lists, tables, and time series. For a full +list of possible aggregrations, see the Query reference.

@@ -4011,8 +4032,8 @@

Parameters

-

The number of query results to skip at the beginning. For example, if the total number of results that are returned -is 10, and the offset is 8, it returns the last two results.

+

The number of query results to skip at the beginning. For example, if the total number of results that are +returned is 10, and the offset is 8, it returns the last two results.

@@ -4051,8 +4072,8 @@

Parameters

-

A comma-separated list of fields that passages are drawn from. If this parameter not specified, then all top-level -fields are included.

+

A comma-separated list of fields that passages are drawn from. If this parameter not specified, then all +top-level fields are included.

@@ -4077,8 +4098,8 @@

Parameters

-

The approximate number of characters that any one passage will have. The default is 400. The minimum is 50. The -maximum is 2000.

+

The approximate number of characters that any one passage will have. The default is 400. The minimum is 50. +The maximum is 2000.

@@ -4117,10 +4138,10 @@

Parameters

-

A comma-separated list of document IDs that will be used to find similar documents. Note: If the -natural_language_query parameter is also specified, it will be used to expand the scope of the document -similarity search to include the natural language query. Other query parameters, such as filter and query are -subsequently applied and reduce the query scope.

+

A comma-separated list of document IDs that will be used to find similar documents. +Note: If the natural_language_query parameter is also specified, it will be used to expand the scope of the +document similarity search to include the natural language query. Other query parameters, such as filter and +query are subsequently applied and reduce the query scope.

@@ -4132,8 +4153,8 @@

Parameters

-

A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If -not specified, the entire document is used for comparison.

+

A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. +If not specified, the entire document is used for comparison.

@@ -4261,9 +4282,9 @@

Parameters

-

A cacheable query that limits the documents returned to exclude any documents that don’t mention the query content. -Filter searches are better for metadata type searches and when you are trying to get a sense of concepts in the -data set.

+

A cacheable query that limits the documents returned to exclude any documents that don’t mention the query +content. Filter searches are better for metadata type searches and when you are trying to get a sense of concepts +in the data set.

@@ -4303,8 +4324,8 @@

Parameters

An aggregation search uses combinations of filters and query search to return an exact answer. Aggregations are -useful for building applications, because you can use them to build lists, tables, and time series. For a full list -of possible aggregrations, see the Query reference.

+useful for building applications, because you can use them to build lists, tables, and time series. For a full +list of possible aggregrations, see the Query reference.

@@ -4340,8 +4361,8 @@

Parameters

-

The number of query results to skip at the beginning. For example, if the total number of results that are returned -is 10, and the offset is 8, it returns the last two results.

+

The number of query results to skip at the beginning. For example, if the total number of results that are +returned is 10, and the offset is 8, it returns the last two results.

@@ -4381,8 +4402,8 @@

Parameters

When true and used with a Watson Discovery News collection, duplicate results (based on the contents of the -title field) are removed. Duplicate comparison is limited to the current query only, offset is not considered. -Defaults to false. This parameter is currently Beta functionality.

+title field) are removed. Duplicate comparison is limited to the current query only, offset is not +considered. Defaults to false. This parameter is currently Beta functionality.

@@ -4421,10 +4442,10 @@

Parameters

-

A comma-separated list of document IDs that will be used to find similar documents. Note: If the -natural_language_query parameter is also specified, it will be used to expand the scope of the document -similarity search to include the natural language query. Other query parameters, such as filter and query are -subsequently applied and reduce the query scope.

+

A comma-separated list of document IDs that will be used to find similar documents. +Note: If the natural_language_query parameter is also specified, it will be used to expand the scope of the +document similarity search to include the natural language query. Other query parameters, such as filter and +query are subsequently applied and reduce the query scope.

@@ -4436,8 +4457,8 @@

Parameters

-

A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If -not specified, the entire document is used for comparison.

+

A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. +If not specified, the entire document is used for comparison.

@@ -4566,9 +4587,9 @@

Parameters

-

A cacheable query that limits the documents returned to exclude any documents that don’t mention the query content. -Filter searches are better for metadata type searches and when you are trying to get a sense of concepts in the -data set.

+

A cacheable query that limits the documents returned to exclude any documents that don’t mention the query +content. Filter searches are better for metadata type searches and when you are trying to get a sense of concepts +in the data set.

@@ -4608,8 +4629,8 @@

Parameters

An aggregation search uses combinations of filters and query search to return an exact answer. Aggregations are -useful for building applications, because you can use them to build lists, tables, and time series. For a full list -of possible aggregrations, see the Query reference.

+useful for building applications, because you can use them to build lists, tables, and time series. For a full +list of possible aggregrations, see the Query reference.

@@ -4645,8 +4666,8 @@

Parameters

-

The number of query results to skip at the beginning. For example, if the total number of results that are returned -is 10, and the offset is 8, it returns the last two results.

+

The number of query results to skip at the beginning. For example, if the total number of results that are +returned is 10, and the offset is 8, it returns the last two results.

@@ -4712,10 +4733,10 @@

Parameters

-

A comma-separated list of document IDs that will be used to find similar documents. Note: If the -natural_language_query parameter is also specified, it will be used to expand the scope of the document -similarity search to include the natural language query. Other query parameters, such as filter and query are -subsequently applied and reduce the query scope.

+

A comma-separated list of document IDs that will be used to find similar documents. +Note: If the natural_language_query parameter is also specified, it will be used to expand the scope of the +document similarity search to include the natural language query. Other query parameters, such as filter and +query are subsequently applied and reduce the query scope.

@@ -4727,8 +4748,8 @@

Parameters

-

A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If -not specified, the entire document is used for comparison.

+

A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. +If not specified, the entire document is used for comparison.

@@ -6264,8 +6285,9 @@

Parameters

Delete labeled data.

Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with -the customer ID. You associate a customer ID with data by passing the X-Watson-Metadata header with a request -that passes data. For more information about personal data and customer IDs, see Information +the customer ID. +You associate a customer ID with data by passing the X-Watson-Metadata header with a request that passes data. +For more information about personal data and customer IDs, see Information security.

@@ -6344,7 +6366,7 @@

Parameters

diff --git a/docs/swift-api/services/DiscoveryV1/Enums.html b/docs/swift-api/services/DiscoveryV1/Enums.html index 3473a8f85..a2bdd7e1a 100644 --- a/docs/swift-api/services/DiscoveryV1/Enums.html +++ b/docs/swift-api/services/DiscoveryV1/Enums.html @@ -179,9 +179,6 @@ - @@ -464,7 +461,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Enums/JSON.html b/docs/swift-api/services/DiscoveryV1/Enums/JSON.html index 045e5aade..6678f797c 100644 --- a/docs/swift-api/services/DiscoveryV1/Enums/JSON.html +++ b/docs/swift-api/services/DiscoveryV1/Enums/JSON.html @@ -179,9 +179,6 @@ - @@ -702,7 +699,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Enums/QueryAggregation.html b/docs/swift-api/services/DiscoveryV1/Enums/QueryAggregation.html index 4843ff01a..9cf33da81 100644 --- a/docs/swift-api/services/DiscoveryV1/Enums/QueryAggregation.html +++ b/docs/swift-api/services/DiscoveryV1/Enums/QueryAggregation.html @@ -179,9 +179,6 @@ - @@ -728,7 +725,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Enums/RestError.html b/docs/swift-api/services/DiscoveryV1/Enums/RestError.html index bfcfc7a6d..5b93ebcaa 100644 --- a/docs/swift-api/services/DiscoveryV1/Enums/RestError.html +++ b/docs/swift-api/services/DiscoveryV1/Enums/RestError.html @@ -179,9 +179,6 @@ - @@ -569,7 +566,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs.html b/docs/swift-api/services/DiscoveryV1/Structs.html index d28408795..952079bc2 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs.html +++ b/docs/swift-api/services/DiscoveryV1/Structs.html @@ -179,9 +179,6 @@ - @@ -1340,7 +1337,15 @@

Declaration

-

The list of fetched fields. The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations. * Fields which contain nested JSON objects are assigned a type of nested. * Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity). * Fields returned from the News collection are prefixed with v{N}-fullnews-t3-{YEAR}.mappings (for example, v5-fullnews-t3-2016.mappings.text.properties.author).

+

The list of fetched fields.

+ +

The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations.

+ +
    +
  • Fields which contain nested JSON objects are assigned a type of nested.

  • +
  • Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity).

  • +
  • Fields returned from the News collection are prefixed with v{N}-fullnews-t3-{YEAR}.mappings (for example, v5-fullnews-t3-2016.mappings.text.properties.author).

  • +
See more
@@ -3021,49 +3026,10 @@

Declaration

-
-
- - - -

JSON

-
-
-
    -
  • -
    - - - - JSONWrapper - -
    -
    -
    -
    -
    -
    -

    Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct JSONWrapper
    - -
    -
    -
    -
    -
  • -
-
diff --git a/docs/swift-api/services/DiscoveryV1/Structs/AggregationResult.html b/docs/swift-api/services/DiscoveryV1/Structs/AggregationResult.html index 8e0cf80de..d0a43c638 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/AggregationResult.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/AggregationResult.html @@ -179,9 +179,6 @@ - @@ -485,7 +482,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/Calculation.html b/docs/swift-api/services/DiscoveryV1/Structs/Calculation.html index 756709f1a..5703dc018 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/Calculation.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/Calculation.html @@ -179,9 +179,6 @@ - @@ -540,7 +537,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/Collection.html b/docs/swift-api/services/DiscoveryV1/Structs/Collection.html index 1ee9e8539..a577148e0 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/Collection.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/Collection.html @@ -179,9 +179,6 @@ - @@ -603,7 +600,8 @@

Declaration

-

The language of the documents stored in the collection. Permitted values include en (English), de (German), and es (Spanish).

+

The language of the documents stored in the collection. Permitted values include en (English), de (German), and +es (Spanish).

@@ -630,7 +628,8 @@

Declaration

-

The object providing information about the documents in the collection. Present only when retrieving details of a collection.

+

The object providing information about the documents in the collection. Present only when retrieving details of a +collection.

@@ -657,7 +656,8 @@

Declaration

-

The object providing information about the disk usage of the collection. Present only when retrieving details of a collection.

+

The object providing information about the disk usage of the collection. Present only when retrieving details of a +collection.

@@ -703,7 +703,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/Collection/Status.html b/docs/swift-api/services/DiscoveryV1/Structs/Collection/Status.html index feead2d75..003d335a5 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/Collection/Status.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/Collection/Status.html @@ -179,9 +179,6 @@ - @@ -459,7 +456,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/CollectionDiskUsage.html b/docs/swift-api/services/DiscoveryV1/Structs/CollectionDiskUsage.html index 005f0c562..40bef967b 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/CollectionDiskUsage.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/CollectionDiskUsage.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/CollectionUsage.html b/docs/swift-api/services/DiscoveryV1/Structs/CollectionUsage.html index a878a5c91..3e10a15e9 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/CollectionUsage.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/CollectionUsage.html @@ -179,9 +179,6 @@ - @@ -432,7 +429,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/Configuration.html b/docs/swift-api/services/DiscoveryV1/Structs/Configuration.html index f6777566c..7145ede81 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/Configuration.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/Configuration.html @@ -179,9 +179,6 @@ - @@ -575,7 +572,8 @@

Declaration

-

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are executed in the order that they appear in the array.

+

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are +executed in the order that they appear in the array.

@@ -609,7 +607,16 @@

Declaration

Declaration

Swift

-
public init(name: String, configurationID: String? = nil, created: String? = nil, updated: String? = nil, description: String? = nil, conversions: Conversions? = nil, enrichments: [Enrichment]? = nil, normalizations: [NormalizationOperation]? = nil)
+
public init(
+    name: String,
+    configurationID: String? = nil,
+    created: String? = nil,
+    updated: String? = nil,
+    description: String? = nil,
+    conversions: Conversions? = nil,
+    enrichments: [Enrichment]? = nil,
+    normalizations: [NormalizationOperation]? = nil
+)
@@ -709,7 +716,8 @@

Parameters

-

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are executed in the order that they appear in the array.

+

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are +executed in the order that they appear in the array.

@@ -728,7 +736,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/Conversions.html b/docs/swift-api/services/DiscoveryV1/Structs/Conversions.html index 7dd48d267..754fa8aa2 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/Conversions.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/Conversions.html @@ -179,9 +179,6 @@ - @@ -494,7 +491,8 @@

Declaration

-

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are executed in the order that they appear in the array.

+

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are +executed in the order that they appear in the array.

@@ -528,7 +526,13 @@

Declaration

Declaration

Swift

-
public init(pdf: PdfSettings? = nil, word: WordSettings? = nil, html: HtmlSettings? = nil, segment: SegmentSettings? = nil, jsonNormalizations: [NormalizationOperation]? = nil)
+
public init(
+    pdf: PdfSettings? = nil,
+    word: WordSettings? = nil,
+    html: HtmlSettings? = nil,
+    segment: SegmentSettings? = nil,
+    jsonNormalizations: [NormalizationOperation]? = nil
+)
@@ -592,7 +596,8 @@

Parameters

-

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are executed in the order that they appear in the array.

+

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are +executed in the order that they appear in the array.

@@ -611,7 +616,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/CreateCollectionRequest.html b/docs/swift-api/services/DiscoveryV1/Structs/CreateCollectionRequest.html index 7a1fe48ab..e0ccf6866 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/CreateCollectionRequest.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/CreateCollectionRequest.html @@ -179,9 +179,6 @@ - @@ -529,7 +526,12 @@

Declaration

Declaration

Swift

-
public init(name: String, description: String? = nil, configurationID: String? = nil, language: String? = nil)
+
public init(
+    name: String,
+    description: String? = nil,
+    configurationID: String? = nil,
+    language: String? = nil
+)
@@ -600,7 +602,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/CreateCollectionRequest/Language.html b/docs/swift-api/services/DiscoveryV1/Structs/CreateCollectionRequest/Language.html index eec13c02a..6ce7464ea 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/CreateCollectionRequest/Language.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/CreateCollectionRequest/Language.html @@ -179,9 +179,6 @@ - @@ -621,7 +618,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/DeleteCollectionResponse.html b/docs/swift-api/services/DiscoveryV1/Structs/DeleteCollectionResponse.html index 29ae63c0f..ad2c2f108 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/DeleteCollectionResponse.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/DeleteCollectionResponse.html @@ -179,9 +179,6 @@ - @@ -460,7 +457,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/DeleteCollectionResponse/Status.html b/docs/swift-api/services/DiscoveryV1/Structs/DeleteCollectionResponse/Status.html index 3881ae7d5..62cceaf03 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/DeleteCollectionResponse/Status.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/DeleteCollectionResponse/Status.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/DeleteConfigurationResponse.html b/docs/swift-api/services/DiscoveryV1/Structs/DeleteConfigurationResponse.html index 10b33350d..d0c60bfa4 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/DeleteConfigurationResponse.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/DeleteConfigurationResponse.html @@ -179,9 +179,6 @@ - @@ -487,7 +484,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/DeleteConfigurationResponse/Status.html b/docs/swift-api/services/DiscoveryV1/Structs/DeleteConfigurationResponse/Status.html index 1b293a46c..5ed1a16cd 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/DeleteConfigurationResponse/Status.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/DeleteConfigurationResponse/Status.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/DeleteDocumentResponse.html b/docs/swift-api/services/DiscoveryV1/Structs/DeleteDocumentResponse.html index 3a2e446db..8b408d275 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/DeleteDocumentResponse.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/DeleteDocumentResponse.html @@ -179,9 +179,6 @@ - @@ -460,7 +457,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/DeleteDocumentResponse/Status.html b/docs/swift-api/services/DiscoveryV1/Structs/DeleteDocumentResponse/Status.html index e61f519e2..7e3c73133 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/DeleteDocumentResponse/Status.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/DeleteDocumentResponse/Status.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/DeleteEnvironmentResponse.html b/docs/swift-api/services/DiscoveryV1/Structs/DeleteEnvironmentResponse.html index 9c0aef8e5..bdcca893a 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/DeleteEnvironmentResponse.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/DeleteEnvironmentResponse.html @@ -179,9 +179,6 @@ - @@ -460,7 +457,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/DeleteEnvironmentResponse/Status.html b/docs/swift-api/services/DiscoveryV1/Structs/DeleteEnvironmentResponse/Status.html index 5257cdb1b..f26156040 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/DeleteEnvironmentResponse/Status.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/DeleteEnvironmentResponse/Status.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/DiskUsage.html b/docs/swift-api/services/DiscoveryV1/Structs/DiskUsage.html index f185be050..c02b48c12 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/DiskUsage.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/DiskUsage.html @@ -179,9 +179,6 @@ - @@ -540,7 +537,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/DocumentAccepted.html b/docs/swift-api/services/DiscoveryV1/Structs/DocumentAccepted.html index db6ce3efc..169ddeb1e 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/DocumentAccepted.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/DocumentAccepted.html @@ -179,9 +179,6 @@ - @@ -487,7 +484,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/DocumentAccepted/Status.html b/docs/swift-api/services/DiscoveryV1/Structs/DocumentAccepted/Status.html index 6a1408c20..0a62dbba4 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/DocumentAccepted/Status.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/DocumentAccepted/Status.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/DocumentCounts.html b/docs/swift-api/services/DiscoveryV1/Structs/DocumentCounts.html index 7dee855a6..621f1a0fb 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/DocumentCounts.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/DocumentCounts.html @@ -179,9 +179,6 @@ - @@ -459,7 +456,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/DocumentSnapshot.html b/docs/swift-api/services/DiscoveryV1/Structs/DocumentSnapshot.html index 3484bfd3f..92a3c543f 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/DocumentSnapshot.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/DocumentSnapshot.html @@ -179,9 +179,6 @@ - @@ -460,7 +457,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/DocumentSnapshot/Step.html b/docs/swift-api/services/DiscoveryV1/Structs/DocumentSnapshot/Step.html index 01b55b3ed..f3d32c85b 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/DocumentSnapshot/Step.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/DocumentSnapshot/Step.html @@ -179,9 +179,6 @@ - @@ -540,7 +537,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/DocumentStatus.html b/docs/swift-api/services/DiscoveryV1/Structs/DocumentStatus.html index 0da0f7343..1871c4521 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/DocumentStatus.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/DocumentStatus.html @@ -179,9 +179,6 @@ - @@ -704,7 +701,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/DocumentStatus/FileType.html b/docs/swift-api/services/DiscoveryV1/Structs/DocumentStatus/FileType.html index 837f218a2..c6c0b9ba3 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/DocumentStatus/FileType.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/DocumentStatus/FileType.html @@ -179,9 +179,6 @@ - @@ -486,7 +483,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/DocumentStatus/Status.html b/docs/swift-api/services/DiscoveryV1/Structs/DocumentStatus/Status.html index e4bbbb907..51de8e6cf 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/DocumentStatus/Status.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/DocumentStatus/Status.html @@ -179,9 +179,6 @@ - @@ -486,7 +483,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/Enrichment.html b/docs/swift-api/services/DiscoveryV1/Structs/Enrichment.html index d09fd7f98..1ce135de8 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/Enrichment.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/Enrichment.html @@ -179,9 +179,6 @@ - @@ -413,7 +410,9 @@

Declaration

-

Field where enrichments will be stored. This field must already exist or be at most 1 level deeper than an existing field. For example, if text is a top-level field with no sub-fields, text.foo is a valid destination but text.foo.bar is not.

+

Field where enrichments will be stored. This field must already exist or be at most 1 level deeper than an existing +field. For example, if text is a top-level field with no sub-fields, text.foo is a valid destination but +text.foo.bar is not.

@@ -494,7 +493,13 @@

Declaration

-

Name of the enrichment service to call. Current options are natural_language_understanding and elements. When using natual_language_understanding, the options object must contain Natural Language Understanding Options. When using elements the options object must contain Element Classification options. Additionally, when using the elements enrichment the configuration specified and files ingested must meet all the criteria specified in the documentation Previous API versions also supported alchemy_language.

+

Name of the enrichment service to call. Current options are natural_language_understanding and elements. + When using natual_language_understanding, the options object must contain Natural Language Understanding +Options. + When using elements the options object must contain Element Classification options. Additionally, when using +the elements enrichment the configuration specified and files ingested must meet all the criteria specified in +the documentation + Previous API versions also supported alchemy_language.

@@ -521,7 +526,8 @@

Declaration

-

If true, then most errors generated during the enrichment process will be treated as warnings and will not cause the document to fail processing.

+

If true, then most errors generated during the enrichment process will be treated as warnings and will not cause +the document to fail processing.

@@ -582,7 +588,15 @@

Declaration

Declaration

Swift

-
public init(destinationField: String, sourceField: String, enrichmentName: String, description: String? = nil, overwrite: Bool? = nil, ignoreDownstreamErrors: Bool? = nil, options: EnrichmentOptions? = nil)
+
public init(
+    destinationField: String,
+    sourceField: String,
+    enrichmentName: String,
+    description: String? = nil,
+    overwrite: Bool? = nil,
+    ignoreDownstreamErrors: Bool? = nil,
+    options: EnrichmentOptions? = nil
+)
@@ -598,7 +612,9 @@

Parameters

-

Field where enrichments will be stored. This field must already exist or be at most 1 level deeper than an existing field. For example, if text is a top-level field with no sub-fields, text.foo is a valid destination but text.foo.bar is not.

+

Field where enrichments will be stored. This field must already exist or be at most 1 level deeper than an +existing field. For example, if text is a top-level field with no sub-fields, text.foo is a valid destination +but text.foo.bar is not.

@@ -622,7 +638,13 @@

Parameters

-

Name of the enrichment service to call. Current options are natural_language_understanding and elements. When using natual_language_understanding, the options object must contain Natural Language Understanding Options. When using elements the options object must contain Element Classification options. Additionally, when using the elements enrichment the configuration specified and files ingested must meet all the criteria specified in the documentation Previous API versions also supported alchemy_language.

+

Name of the enrichment service to call. Current options are natural_language_understanding and elements. +When using natual_language_understanding, the options object must contain Natural Language Understanding +Options. +When using elements the options object must contain Element Classification options. Additionally, when using +the elements enrichment the configuration specified and files ingested must meet all the criteria specified in +the documentation +Previous API versions also supported alchemy_language.

@@ -658,7 +680,8 @@

Parameters

-

If true, then most errors generated during the enrichment process will be treated as warnings and will not cause the document to fail processing.

+

If true, then most errors generated during the enrichment process will be treated as warnings and will not cause +the document to fail processing.

@@ -689,7 +712,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/EnrichmentOptions.html b/docs/swift-api/services/DiscoveryV1/Structs/EnrichmentOptions.html index 260f81719..b0eeee2e9 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/EnrichmentOptions.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/EnrichmentOptions.html @@ -179,9 +179,6 @@ - @@ -447,7 +444,10 @@

Declaration

Declaration

Swift

-
public init(features: NluEnrichmentFeatures? = nil, model: String? = nil)
+
public init(
+    features: NluEnrichmentFeatures? = nil,
+    model: String? = nil
+)
@@ -475,7 +475,8 @@

Parameters

-

For use with elements enrichments only. The element extraction model to use. Models available are: contract.

+

For use with elements enrichments only. The element extraction model to use. Models available are: +contract.

@@ -494,7 +495,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/Environment.html b/docs/swift-api/services/DiscoveryV1/Structs/Environment.html index 02e369d2e..2f31dbf99 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/Environment.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/Environment.html @@ -179,9 +179,6 @@ - @@ -649,7 +646,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/Environment/Status.html b/docs/swift-api/services/DiscoveryV1/Structs/Environment/Status.html index 3ac726f73..4b5e53118 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/Environment/Status.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/Environment/Status.html @@ -179,9 +179,6 @@ - @@ -459,7 +456,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/EnvironmentDocuments.html b/docs/swift-api/services/DiscoveryV1/Structs/EnvironmentDocuments.html index 5bb0d52cc..fe9a64359 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/EnvironmentDocuments.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/EnvironmentDocuments.html @@ -179,9 +179,6 @@ - @@ -432,7 +429,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/Expansion.html b/docs/swift-api/services/DiscoveryV1/Structs/Expansion.html index 6ffbf74c4..2b3ca88b7 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/Expansion.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/Expansion.html @@ -179,9 +179,6 @@ - @@ -413,7 +410,8 @@

Declaration

-

A list of terms that this expansion will be expanded to. If specified without input_terms, it also functions as the input term list.

+

A list of terms that this expansion will be expanded to. If specified without input_terms, it also functions as +the input term list.

@@ -447,7 +445,10 @@

Declaration

Declaration

Swift

-
public init(expandedTerms: [String], inputTerms: [String]? = nil)
+
public init(
+    expandedTerms: [String],
+    inputTerms: [String]? = nil
+)
@@ -463,7 +464,8 @@

Parameters

-

A list of terms that this expansion will be expanded to. If specified without input_terms, it also functions as the input term list.

+

A list of terms that this expansion will be expanded to. If specified without input_terms, it also functions as +the input term list.

@@ -494,7 +496,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/Expansions.html b/docs/swift-api/services/DiscoveryV1/Structs/Expansions.html index 039315fdf..45bf6d363 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/Expansions.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/Expansions.html @@ -179,9 +179,6 @@ - @@ -386,7 +383,15 @@

Expansions

-

An array of query expansion definitions. Each object in the expansions array represents a term or set of terms that will be expanded into other terms. Each expansion object can be configured so that all terms are expanded to all other terms in the object - bi-directional, or a set list of terms can be expanded into a second list of terms - uni-directional. To create a bi-directional expansion specify an expanded_terms array. When found in a query, all items in the expanded_terms array are then expanded to the other items in the same array. To create a uni-directional expansion, specify both an array of input_terms and an array of expanded_terms. When items in the input_terms array are present in a query, they are expanded using the items listed in the expanded_terms array.

+

An array of query expansion definitions. + Each object in the expansions array represents a term or set of terms that will be expanded into other terms. +Each expansion object can be configured so that all terms are expanded to all other terms in the object - +bi-directional, or a set list of terms can be expanded into a second list of terms - uni-directional. + To create a bi-directional expansion specify an expanded_terms array. When found in a query, all items in the +expanded_terms array are then expanded to the other items in the same array. + To create a uni-directional expansion, specify both an array of input_terms and an array of expanded_terms. +When items in the input_terms array are present in a query, they are expanded using the items listed in the +expanded_terms array.

@@ -420,7 +425,9 @@

Declaration

Declaration

Swift

-
public init(expansions: [Expansion])
+
public init(
+    expansions: [Expansion]
+)
@@ -436,7 +443,15 @@

Parameters

-

An array of query expansion definitions. Each object in the expansions array represents a term or set of terms that will be expanded into other terms. Each expansion object can be configured so that all terms are expanded to all other terms in the object - bi-directional, or a set list of terms can be expanded into a second list of terms - uni-directional. To create a bi-directional expansion specify an expanded_terms array. When found in a query, all items in the expanded_terms array are then expanded to the other items in the same array. To create a uni-directional expansion, specify both an array of input_terms and an array of expanded_terms. When items in the input_terms array are present in a query, they are expanded using the items listed in the expanded_terms array.

+

An array of query expansion definitions. +Each object in the expansions array represents a term or set of terms that will be expanded into other terms. +Each expansion object can be configured so that all terms are expanded to all other terms in the object - +bi-directional, or a set list of terms can be expanded into a second list of terms - uni-directional. +To create a bi-directional expansion specify an expanded_terms array. When found in a query, all items in the +expanded_terms array are then expanded to the other items in the same array. +To create a uni-directional expansion, specify both an array of input_terms and an array of expanded_terms. +When items in the input_terms array are present in a query, they are expanded using the items listed in the +expanded_terms array.

@@ -455,7 +470,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/Field.html b/docs/swift-api/services/DiscoveryV1/Structs/Field.html index a2fa19a91..fc62cd8f4 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/Field.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/Field.html @@ -179,9 +179,6 @@ - @@ -460,7 +457,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/Field/FieldType.html b/docs/swift-api/services/DiscoveryV1/Structs/Field/FieldType.html index d45587c72..a3d68a6a9 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/Field/FieldType.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/Field/FieldType.html @@ -179,9 +179,6 @@ - @@ -675,7 +672,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/Filter.html b/docs/swift-api/services/DiscoveryV1/Structs/Filter.html index 4ab045324..2fce17691 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/Filter.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/Filter.html @@ -179,9 +179,6 @@ - @@ -513,7 +510,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/FontSetting.html b/docs/swift-api/services/DiscoveryV1/Structs/FontSetting.html index 2c10d0e68..cab35e7a5 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/FontSetting.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/FontSetting.html @@ -179,9 +179,6 @@ - @@ -555,7 +552,14 @@

Declaration

Declaration

Swift

-
public init(level: Int? = nil, minSize: Int? = nil, maxSize: Int? = nil, bold: Bool? = nil, italic: Bool? = nil, name: String? = nil)
+
public init(
+    level: Int? = nil,
+    minSize: Int? = nil,
+    maxSize: Int? = nil,
+    bold: Bool? = nil,
+    italic: Bool? = nil,
+    name: String? = nil
+)
@@ -650,7 +654,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/GenericQueryAggregation.html b/docs/swift-api/services/DiscoveryV1/Structs/GenericQueryAggregation.html index d4eb5c29a..ffaa31d7f 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/GenericQueryAggregation.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/GenericQueryAggregation.html @@ -179,9 +179,6 @@ - @@ -486,7 +483,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/Histogram.html b/docs/swift-api/services/DiscoveryV1/Structs/Histogram.html index b8104eceb..f60d55096 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/Histogram.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/Histogram.html @@ -179,9 +179,6 @@ - @@ -540,7 +537,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/HtmlSettings.html b/docs/swift-api/services/DiscoveryV1/Structs/HtmlSettings.html index 8170be84c..582cc8271 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/HtmlSettings.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/HtmlSettings.html @@ -179,9 +179,6 @@ - @@ -555,7 +552,14 @@

Declaration

Declaration

Swift

-
public init(excludeTagsCompletely: [String]? = nil, excludeTagsKeepContent: [String]? = nil, keepContent: XPathPatterns? = nil, excludeContent: XPathPatterns? = nil, keepTagAttributes: [String]? = nil, excludeTagAttributes: [String]? = nil)
+
public init(
+    excludeTagsCompletely: [String]? = nil,
+    excludeTagsKeepContent: [String]? = nil,
+    keepContent: XPathPatterns? = nil,
+    excludeContent: XPathPatterns? = nil,
+    keepTagAttributes: [String]? = nil,
+    excludeTagAttributes: [String]? = nil
+)
@@ -650,7 +654,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/IndexCapacity.html b/docs/swift-api/services/DiscoveryV1/Structs/IndexCapacity.html index 0c0af7115..bb5b2d9c6 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/IndexCapacity.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/IndexCapacity.html @@ -179,9 +179,6 @@ - @@ -486,7 +483,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/ListCollectionFieldsResponse.html b/docs/swift-api/services/DiscoveryV1/Structs/ListCollectionFieldsResponse.html index 8b0b5c07a..b49b9f445 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/ListCollectionFieldsResponse.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/ListCollectionFieldsResponse.html @@ -179,9 +179,6 @@ - @@ -367,7 +364,15 @@

ListCollectionFieldsResponse

-

The list of fetched fields. The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations. * Fields which contain nested JSON objects are assigned a type of nested. * Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity). * Fields returned from the News collection are prefixed with v{N}-fullnews-t3-{YEAR}.mappings (for example, v5-fullnews-t3-2016.mappings.text.properties.author).

+

The list of fetched fields.

+ +

The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations.

+ +
    +
  • Fields which contain nested JSON objects are assigned a type of nested.

  • +
  • Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity).

  • +
  • Fields returned from the News collection are prefixed with v{N}-fullnews-t3-{YEAR}.mappings (for example, v5-fullnews-t3-2016.mappings.text.properties.author).

  • +
@@ -405,7 +410,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/ListCollectionsResponse.html b/docs/swift-api/services/DiscoveryV1/Structs/ListCollectionsResponse.html index 684af1ae9..c5fd0c705 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/ListCollectionsResponse.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/ListCollectionsResponse.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/ListConfigurationsResponse.html b/docs/swift-api/services/DiscoveryV1/Structs/ListConfigurationsResponse.html index f8d1f8ce5..ff405a79f 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/ListConfigurationsResponse.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/ListConfigurationsResponse.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/ListEnvironmentsResponse.html b/docs/swift-api/services/DiscoveryV1/Structs/ListEnvironmentsResponse.html index 98112c960..f0fb856b0 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/ListEnvironmentsResponse.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/ListEnvironmentsResponse.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/MemoryUsage.html b/docs/swift-api/services/DiscoveryV1/Structs/MemoryUsage.html index 837384c86..03c5c2a11 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/MemoryUsage.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/MemoryUsage.html @@ -179,9 +179,6 @@ - @@ -513,7 +510,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/Nested.html b/docs/swift-api/services/DiscoveryV1/Structs/Nested.html index b8ffa0383..933ad94e1 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/Nested.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/Nested.html @@ -179,9 +179,6 @@ - @@ -513,7 +510,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentCategories.html b/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentCategories.html index 0bb0a0b58..6ed5493d0 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentCategories.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentCategories.html @@ -179,9 +179,6 @@ - @@ -420,7 +417,9 @@

Declaration

Declaration

Swift

-
public init(additionalProperties: [String: JSON] = [:])
+
public init(
+    additionalProperties: [String: JSON] = [:]
+)
@@ -488,7 +487,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentEmotion.html b/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentEmotion.html index 4de53ce36..2c9d76890 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentEmotion.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentEmotion.html @@ -179,9 +179,6 @@ - @@ -447,7 +444,10 @@

Declaration

Declaration

Swift

-
public init(document: Bool? = nil, targets: [String]? = nil)
+
public init(
+    document: Bool? = nil,
+    targets: [String]? = nil
+)
@@ -494,7 +494,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentEntities.html b/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentEntities.html index c0c460c1b..b14047241 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentEntities.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentEntities.html @@ -179,9 +179,6 @@ - @@ -521,7 +518,8 @@

Declaration

-

When true, a list of sentence locations for each instance of each identified entity is recorded. The default is false.

+

When true, a list of sentence locations for each instance of each identified entity is recorded. The default is +false.

@@ -548,7 +546,8 @@

Declaration

-

The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge Graph en-news, or the default public model alchemy.

+

The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge Studio, the +public model for use with Knowledge Graph en-news, or the default public model alchemy.

@@ -582,7 +581,15 @@

Declaration

Declaration

Swift

-
public init(sentiment: Bool? = nil, emotion: Bool? = nil, limit: Int? = nil, mentions: Bool? = nil, mentionTypes: Bool? = nil, sentenceLocation: Bool? = nil, model: String? = nil)
+
public init(
+    sentiment: Bool? = nil,
+    emotion: Bool? = nil,
+    limit: Int? = nil,
+    mentions: Bool? = nil,
+    mentionTypes: Bool? = nil,
+    sentenceLocation: Bool? = nil,
+    model: String? = nil
+)
@@ -658,7 +665,8 @@

Parameters

-

When true, a list of sentence locations for each instance of each identified entity is recorded. The default is false.

+

When true, a list of sentence locations for each instance of each identified entity is recorded. The default is +false.

@@ -670,7 +678,8 @@

Parameters

-

The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge Graph en-news, or the default public model alchemy.

+

The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge Studio, +the public model for use with Knowledge Graph en-news, or the default public model alchemy.

@@ -689,7 +698,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentFeatures.html b/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentFeatures.html index 816f700ba..e791806ed 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentFeatures.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentFeatures.html @@ -179,9 +179,6 @@ - @@ -582,7 +579,15 @@

Declaration

Declaration

Swift

-
public init(keywords: NluEnrichmentKeywords? = nil, entities: NluEnrichmentEntities? = nil, sentiment: NluEnrichmentSentiment? = nil, emotion: NluEnrichmentEmotion? = nil, categories: NluEnrichmentCategories? = nil, semanticRoles: NluEnrichmentSemanticRoles? = nil, relations: NluEnrichmentRelations? = nil)
+
public init(
+    keywords: NluEnrichmentKeywords? = nil,
+    entities: NluEnrichmentEntities? = nil,
+    sentiment: NluEnrichmentSentiment? = nil,
+    emotion: NluEnrichmentEmotion? = nil,
+    categories: NluEnrichmentCategories? = nil,
+    semanticRoles: NluEnrichmentSemanticRoles? = nil,
+    relations: NluEnrichmentRelations? = nil
+)
@@ -689,7 +694,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentKeywords.html b/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentKeywords.html index 2bbf0e006..373d4808d 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentKeywords.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentKeywords.html @@ -179,9 +179,6 @@ - @@ -474,7 +471,11 @@

Declaration

Declaration

Swift

-
public init(sentiment: Bool? = nil, emotion: Bool? = nil, limit: Int? = nil)
+
public init(
+    sentiment: Bool? = nil,
+    emotion: Bool? = nil,
+    limit: Int? = nil
+)
@@ -533,7 +534,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentRelations.html b/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentRelations.html index 01b4fed44..930a1c9a0 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentRelations.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentRelations.html @@ -179,9 +179,6 @@ - @@ -386,7 +383,9 @@

NluEnrichmentRelations

-

For use with natural_language_understanding enrichments only.* The enrichement model to use with relationship extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge Graph en-news, the default isen-news.

+

For use with natural_language_understanding enrichments only. The enrichement model to use with relationship +extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge +Graph en-news, the default isen-news.

@@ -420,7 +419,9 @@

Declaration

Declaration

Swift

-
public init(model: String? = nil)
+
public init(
+    model: String? = nil
+)
@@ -436,7 +437,9 @@

Parameters

-

For use with natural_language_understanding enrichments only. The enrichement model to use with relationship extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge Graph en-news, the default isen-news.

+

For use with natural_language_understanding enrichments only. The enrichement model to use with relationship +extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge +Graph en-news, the default isen-news.

@@ -455,7 +458,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentSemanticRoles.html b/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentSemanticRoles.html index 59703f9aa..4eadcbfa3 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentSemanticRoles.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentSemanticRoles.html @@ -179,9 +179,6 @@ - @@ -474,7 +471,11 @@

Declaration

Declaration

Swift

-
public init(entities: Bool? = nil, keywords: Bool? = nil, limit: Int? = nil)
+
public init(
+    entities: Bool? = nil,
+    keywords: Bool? = nil,
+    limit: Int? = nil
+)
@@ -533,7 +534,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentSentiment.html b/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentSentiment.html index 75cb62887..9db59b5a3 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentSentiment.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/NluEnrichmentSentiment.html @@ -179,9 +179,6 @@ - @@ -447,7 +444,10 @@

Declaration

Declaration

Swift

-
public init(document: Bool? = nil, targets: [String]? = nil)
+
public init(
+    document: Bool? = nil,
+    targets: [String]? = nil
+)
@@ -494,7 +494,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/NormalizationOperation.html b/docs/swift-api/services/DiscoveryV1/Structs/NormalizationOperation.html index fff86ed01..f49285747 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/NormalizationOperation.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/NormalizationOperation.html @@ -179,9 +179,6 @@ - @@ -387,11 +384,22 @@

NormalizationOperation

Identifies what type of operation to perform. -copy - Copies the value of the source_field to the destination_field field. If the destination_field already exists, then the value of the source_field overwrites the original value of the destination_field. -move - Renames (moves) the source_field to the destination_field. If the destination_field already exists, then the value of the source_field overwrites the original value of the destination_field. Rename is identical to copy, except that the source_field is removed after the value has been copied to the destination_field (it is the same as a copy followed by a remove). -merge - Merges the value of the source_field with the value of the destination_field. The destination_field is converted into an array if it is not already an array, and the value of the source_field is appended to the array. This operation removes the source_field after the merge. If the source_field does not exist in the current document, then the destination_field is still converted into an array (if it is not an array already). This is ensures the type for destination_field is consistent across all documents. +copy - Copies the value of the source_field to the destination_field field. If the destination_field +already exists, then the value of the source_field overwrites the original value of the destination_field. +move - Renames (moves) the source_field to the destination_field. If the destination_field already +exists, then the value of the source_field overwrites the original value of the destination_field. Rename is +identical to copy, except that the source_field is removed after the value has been copied to the +destination_field (it is the same as a copy followed by a remove). +merge - Merges the value of the source_field with the value of the destination_field. The +destination_field is converted into an array if it is not already an array, and the value of the source_field +is appended to the array. This operation removes the source_field after the merge. If the source_field does not +exist in the current document, then the destination_field is still converted into an array (if it is not an array +already). This is ensures the type for destination_field is consistent across all documents. remove - Deletes the source_field field. The destination_field is ignored for this operation. -remove_nulls - Removes all nested null (blank) leif values from the JSON tree. source_field and destination_field are ignored by this operation because remove_nulls operates on the entire JSON tree. Typically, remove_nulls is invoked as the last normalization operation (if it is inoked at all, it can be time-expensive).

+remove_nulls - Removes all nested null (blank) leif values from the JSON tree. source_field and +destination_field are ignored by this operation because remove_nulls operates on the entire JSON tree. +Typically, remove_nulls is invoked as the last normalization operation (if it is inoked at all, it can be +time-expensive).

See more
@@ -419,7 +427,23 @@

Declaration

-

Identifies what type of operation to perform.

+

Identifies what type of operation to perform. +copy - Copies the value of the source_field to the destination_field field. If the destination_field +already exists, then the value of the source_field overwrites the original value of the destination_field. +move - Renames (moves) the source_field to the destination_field. If the destination_field already +exists, then the value of the source_field overwrites the original value of the destination_field. Rename is +identical to copy, except that the source_field is removed after the value has been copied to the +destination_field (it is the same as a copy followed by a remove). +merge - Merges the value of the source_field with the value of the destination_field. The +destination_field is converted into an array if it is not already an array, and the value of the source_field +is appended to the array. This operation removes the source_field after the merge. If the source_field does not +exist in the current document, then the destination_field is still converted into an array (if it is not an array +already). This is ensures the type for destination_field is consistent across all documents. +remove - Deletes the source_field field. The destination_field is ignored for this operation. +remove_nulls - Removes all nested null (blank) leif values from the JSON tree. source_field and +destination_field are ignored by this operation because remove_nulls operates on the entire JSON tree. +Typically, remove_nulls is invoked as the last normalization operation (if it is inoked at all, it can be +time-expensive).

@@ -507,7 +531,11 @@

Declaration

Declaration

Swift

-
public init(operation: String? = nil, sourceField: String? = nil, destinationField: String? = nil)
+
public init(
+    operation: String? = nil,
+    sourceField: String? = nil,
+    destinationField: String? = nil
+)
@@ -523,7 +551,23 @@

Parameters

-

Identifies what type of operation to perform.

+

Identifies what type of operation to perform. +copy - Copies the value of the source_field to the destination_field field. If the destination_field +already exists, then the value of the source_field overwrites the original value of the destination_field. +move - Renames (moves) the source_field to the destination_field. If the destination_field already +exists, then the value of the source_field overwrites the original value of the destination_field. Rename is +identical to copy, except that the source_field is removed after the value has been copied to the +destination_field (it is the same as a copy followed by a remove). +merge - Merges the value of the source_field with the value of the destination_field. The +destination_field is converted into an array if it is not already an array, and the value of the source_field +is appended to the array. This operation removes the source_field after the merge. If the source_field does +not exist in the current document, then the destination_field is still converted into an array (if it is not an +array already). This is ensures the type for destination_field is consistent across all documents. +remove - Deletes the source_field field. The destination_field is ignored for this operation. +remove_nulls - Removes all nested null (blank) leif values from the JSON tree. source_field and +destination_field are ignored by this operation because remove_nulls operates on the entire JSON tree. +Typically, remove_nulls is invoked as the last normalization operation (if it is inoked at all, it can be +time-expensive).

@@ -566,7 +610,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/NormalizationOperation/Operation.html b/docs/swift-api/services/DiscoveryV1/Structs/NormalizationOperation/Operation.html index 752a520f9..a21e0bc67 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/NormalizationOperation/Operation.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/NormalizationOperation/Operation.html @@ -179,9 +179,6 @@ - @@ -368,11 +365,22 @@

Operation

Identifies what type of operation to perform. -copy - Copies the value of the source_field to the destination_field field. If the destination_field already exists, then the value of the source_field overwrites the original value of the destination_field. -move - Renames (moves) the source_field to the destination_field. If the destination_field already exists, then the value of the source_field overwrites the original value of the destination_field. Rename is identical to copy, except that the source_field is removed after the value has been copied to the destination_field (it is the same as a copy followed by a remove). -merge - Merges the value of the source_field with the value of the destination_field. The destination_field is converted into an array if it is not already an array, and the value of the source_field is appended to the array. This operation removes the source_field after the merge. If the source_field does not exist in the current document, then the destination_field is still converted into an array (if it is not an array already). This is ensures the type for destination_field is consistent across all documents. +copy - Copies the value of the source_field to the destination_field field. If the destination_field +already exists, then the value of the source_field overwrites the original value of the destination_field. +move - Renames (moves) the source_field to the destination_field. If the destination_field already +exists, then the value of the source_field overwrites the original value of the destination_field. Rename is +identical to copy, except that the source_field is removed after the value has been copied to the +destination_field (it is the same as a copy followed by a remove). +merge - Merges the value of the source_field with the value of the destination_field. The +destination_field is converted into an array if it is not already an array, and the value of the source_field +is appended to the array. This operation removes the source_field after the merge. If the source_field does not +exist in the current document, then the destination_field is still converted into an array (if it is not an array +already). This is ensures the type for destination_field is consistent across all documents. remove - Deletes the source_field field. The destination_field is ignored for this operation. -remove_nulls - Removes all nested null (blank) leif values from the JSON tree. source_field and destination_field are ignored by this operation because remove_nulls operates on the entire JSON tree. Typically, remove_nulls is invoked as the last normalization operation (if it is inoked at all, it can be time-expensive).

+remove_nulls - Removes all nested null (blank) leif values from the JSON tree. source_field and +destination_field are ignored by this operation because remove_nulls operates on the entire JSON tree. +Typically, remove_nulls is invoked as the last normalization operation (if it is inoked at all, it can be +time-expensive).

@@ -518,7 +526,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/Notice.html b/docs/swift-api/services/DiscoveryV1/Structs/Notice.html index 680b09355..a424a6476 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/Notice.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/Notice.html @@ -179,9 +179,6 @@ - @@ -414,7 +411,8 @@

Declaration

-

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.

+

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.

@@ -595,7 +593,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/Notice/Severity.html b/docs/swift-api/services/DiscoveryV1/Structs/Notice/Severity.html index dbe0659e9..a7202cc72 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/Notice/Severity.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/Notice/Severity.html @@ -179,9 +179,6 @@ - @@ -432,7 +429,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/PdfHeadingDetection.html b/docs/swift-api/services/DiscoveryV1/Structs/PdfHeadingDetection.html index 92fb95e54..26ff41750 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/PdfHeadingDetection.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/PdfHeadingDetection.html @@ -179,9 +179,6 @@ - @@ -420,7 +417,9 @@

Declaration

Declaration

Swift

-
public init(fonts: [FontSetting]? = nil)
+
public init(
+    fonts: [FontSetting]? = nil
+)
@@ -455,7 +454,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/PdfSettings.html b/docs/swift-api/services/DiscoveryV1/Structs/PdfSettings.html index 281357896..246a2b6a6 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/PdfSettings.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/PdfSettings.html @@ -179,9 +179,6 @@ - @@ -420,7 +417,9 @@

Declaration

Declaration

Swift

-
public init(heading: PdfHeadingDetection? = nil)
+
public init(
+    heading: PdfHeadingDetection? = nil
+)
@@ -455,7 +454,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryEntities.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryEntities.html index d10a5094f..c89e2c7a9 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryEntities.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryEntities.html @@ -179,9 +179,6 @@ - @@ -440,7 +437,8 @@

Declaration

-

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

+

Entity text to provide context for the queried entity and rank based on that association. For example, if you +wanted to query the city of London in England your query would look for London with the context of England.

@@ -494,7 +492,8 @@

Declaration

-

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items per query is 10,000.

+

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items +per query is 10,000.

@@ -528,7 +527,13 @@

Declaration

Declaration

Swift

-
public init(feature: String? = nil, entity: QueryEntitiesEntity? = nil, context: QueryEntitiesContext? = nil, count: Int? = nil, evidenceCount: Int? = nil)
+
public init(
+    feature: String? = nil,
+    entity: QueryEntitiesEntity? = nil,
+    context: QueryEntitiesContext? = nil,
+    count: Int? = nil,
+    evidenceCount: Int? = nil
+)
@@ -568,7 +573,8 @@

Parameters

-

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

+

Entity text to provide context for the queried entity and rank based on that association. For example, if you +wanted to query the city of London in England your query would look for London with the context of England.

@@ -592,7 +598,8 @@

Parameters

-

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items per query is 10,000.

+

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items +per query is 10,000.

@@ -611,7 +618,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryEntitiesContext.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryEntitiesContext.html index 69df677d3..3134691e2 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryEntitiesContext.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryEntitiesContext.html @@ -179,9 +179,6 @@ - @@ -386,7 +383,8 @@

QueryEntitiesContext

-

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

+

Entity text to provide context for the queried entity and rank based on that association. For example, if you +wanted to query the city of London in England your query would look for London with the context of England.

@@ -420,7 +418,9 @@

Declaration

Declaration

Swift

-
public init(text: String? = nil)
+
public init(
+    text: String? = nil
+)
@@ -436,7 +436,8 @@

Parameters

-

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

+

Entity text to provide context for the queried entity and rank based on that association. For example, if you +wanted to query the city of London in England your query would look for London with the context of England.

@@ -455,7 +456,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryEntitiesEntity.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryEntitiesEntity.html index 7b38caa5d..5aed4a642 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryEntitiesEntity.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryEntitiesEntity.html @@ -179,9 +179,6 @@ - @@ -447,7 +444,10 @@

Declaration

Declaration

Swift

-
public init(text: String? = nil, type: String? = nil)
+
public init(
+    text: String? = nil,
+    type: String? = nil
+)
@@ -494,7 +494,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryEntitiesResponse.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryEntitiesResponse.html index 53264dda5..16ab73810 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryEntitiesResponse.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryEntitiesResponse.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryEntitiesResponseItem.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryEntitiesResponseItem.html index af4306477..6d91e9c3a 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryEntitiesResponseItem.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryEntitiesResponseItem.html @@ -179,9 +179,6 @@ - @@ -459,7 +456,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryEvidence.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryEvidence.html index 4050b0bc8..f1bd50c97 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryEvidence.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryEvidence.html @@ -179,9 +179,6 @@ - @@ -513,7 +510,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryEvidenceEntity.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryEvidenceEntity.html index 6ba44a2b1..70ab0f1fa 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryEvidenceEntity.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryEvidenceEntity.html @@ -179,9 +179,6 @@ - @@ -486,7 +483,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryFilterType.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryFilterType.html index db46e167c..96d9c9c65 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryFilterType.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryFilterType.html @@ -179,9 +179,6 @@ - @@ -447,7 +444,10 @@

Declaration

Declaration

Swift

-
public init(exclude: [String]? = nil, include: [String]? = nil)
+
public init(
+    exclude: [String]? = nil,
+    include: [String]? = nil
+)
@@ -494,7 +494,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryNoticesResponse.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryNoticesResponse.html index ff28f99fd..0b891113c 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryNoticesResponse.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryNoticesResponse.html @@ -179,9 +179,6 @@ - @@ -513,7 +510,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryNoticesResult.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryNoticesResult.html index f002c52c3..48864704d 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryNoticesResult.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryNoticesResult.html @@ -179,9 +179,6 @@ - @@ -549,7 +546,8 @@

Declaration

-

The internal status code returned by the ingestion subsystem indicating the overall result of ingesting the source document.

+

The internal status code returned by the ingestion subsystem indicating the overall result of ingesting the source +document.

@@ -729,7 +727,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryNoticesResult/FileType.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryNoticesResult/FileType.html index 52ebb6550..1428919e0 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryNoticesResult/FileType.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryNoticesResult/FileType.html @@ -179,9 +179,6 @@ - @@ -486,7 +483,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryPassages.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryPassages.html index 840827b42..b67914f1d 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryPassages.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryPassages.html @@ -179,9 +179,6 @@ - @@ -540,7 +537,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryRelations.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryRelations.html index 2c2f2a08c..4e779baf7 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryRelations.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryRelations.html @@ -179,9 +179,6 @@ - @@ -386,7 +383,8 @@

QueryRelations

-

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times each entity is identified. The default is score.

+

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times +each entity is identified. The default is score.

See more
@@ -441,7 +439,8 @@

Declaration

-

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

+

Entity text to provide context for the queried entity and rank based on that association. For example, if you +wanted to query the city of London in England your query would look for London with the context of England.

@@ -468,7 +467,8 @@

Declaration

-

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times each entity is identified. The default is score.

+

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times +each entity is identified. The default is score.

@@ -549,7 +549,8 @@

Declaration

-

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items per query is 10,000.

+

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items +per query is 10,000.

@@ -583,7 +584,14 @@

Declaration

Declaration

Swift

-
public init(entities: [QueryRelationsEntity]? = nil, context: QueryEntitiesContext? = nil, sort: String? = nil, filter: QueryRelationsFilter? = nil, count: Int? = nil, evidenceCount: Int? = nil)
+
public init(
+    entities: [QueryRelationsEntity]? = nil,
+    context: QueryEntitiesContext? = nil,
+    sort: String? = nil,
+    filter: QueryRelationsFilter? = nil,
+    count: Int? = nil,
+    evidenceCount: Int? = nil
+)
@@ -611,7 +619,8 @@

Parameters

-

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

+

Entity text to provide context for the queried entity and rank based on that association. For example, if you +wanted to query the city of London in England your query would look for London with the context of England.

@@ -623,7 +632,8 @@

Parameters

-

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times each entity is identified. The default is score.

+

The sorting method for the relationships, can be score or frequency. frequency is the number of unique +times each entity is identified. The default is score.

@@ -659,7 +669,8 @@

Parameters

-

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items per query is 10,000.

+

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items +per query is 10,000.

@@ -678,7 +689,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryRelations/Sort.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryRelations/Sort.html index ec10bc123..9e710633c 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryRelations/Sort.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryRelations/Sort.html @@ -179,9 +179,6 @@ - @@ -367,7 +364,8 @@

Sort

-

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times each entity is identified. The default is score.

+

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times +each entity is identified. The default is score.

@@ -432,7 +430,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryRelationsArgument.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryRelationsArgument.html index 50799b1c8..7ecbc6b7c 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryRelationsArgument.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryRelationsArgument.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryRelationsEntity.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryRelationsEntity.html index 66f8ab468..d1042ab22 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryRelationsEntity.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryRelationsEntity.html @@ -179,9 +179,6 @@ - @@ -474,7 +471,11 @@

Declaration

Declaration

Swift

-
public init(text: String? = nil, type: String? = nil, exact: Bool? = nil)
+
public init(
+    text: String? = nil,
+    type: String? = nil,
+    exact: Bool? = nil
+)
@@ -533,7 +534,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryRelationsFilter.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryRelationsFilter.html index 7c87c53f5..b27565ee3 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryRelationsFilter.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryRelationsFilter.html @@ -179,9 +179,6 @@ - @@ -474,7 +471,11 @@

Declaration

Declaration

Swift

-
public init(relationTypes: QueryFilterType? = nil, entityTypes: QueryFilterType? = nil, documentIds: [String]? = nil)
+
public init(
+    relationTypes: QueryFilterType? = nil,
+    entityTypes: QueryFilterType? = nil,
+    documentIds: [String]? = nil
+)
@@ -533,7 +534,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryRelationsRelationship.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryRelationsRelationship.html index 8736906e0..88adf0f15 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryRelationsRelationship.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryRelationsRelationship.html @@ -179,9 +179,6 @@ - @@ -486,7 +483,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryRelationsResponse.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryRelationsResponse.html index ddc451018..be21eb529 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryRelationsResponse.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryRelationsResponse.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryResponse.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryResponse.html index da4967ece..385b52a81 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryResponse.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryResponse.html @@ -179,9 +179,6 @@ - @@ -513,7 +510,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryResult.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryResult.html index f0b70f40f..d0c693842 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryResult.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryResult.html @@ -179,9 +179,6 @@ - @@ -566,7 +563,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/QueryResultMetadata.html b/docs/swift-api/services/DiscoveryV1/Structs/QueryResultMetadata.html index 949f6808b..cf5f46cca 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/QueryResultMetadata.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/QueryResultMetadata.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/SegmentSettings.html b/docs/swift-api/services/DiscoveryV1/Structs/SegmentSettings.html index 9e943b112..201479b2d 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/SegmentSettings.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/SegmentSettings.html @@ -179,9 +179,6 @@ - @@ -447,7 +444,10 @@

Declaration

Declaration

Swift

-
public init(enabled: Bool? = nil, selectorTags: [String]? = nil)
+
public init(
+    enabled: Bool? = nil,
+    selectorTags: [String]? = nil
+)
@@ -494,7 +494,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/Term.html b/docs/swift-api/services/DiscoveryV1/Structs/Term.html index 04e9e8195..e727a5fa4 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/Term.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/Term.html @@ -179,9 +179,6 @@ - @@ -540,7 +537,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/TestDocument.html b/docs/swift-api/services/DiscoveryV1/Structs/TestDocument.html index b2f0497cb..47bcb0613 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/TestDocument.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/TestDocument.html @@ -179,9 +179,6 @@ - @@ -440,7 +437,8 @@

Declaration

-

The number of 10-kB chunks of field data that were enriched. This can be used to estimate the cost of running a real ingestion.

+

The number of 10-kB chunks of field data that were enriched. This can be used to estimate the cost of running a +real ingestion.

@@ -540,7 +538,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/Timeslice.html b/docs/swift-api/services/DiscoveryV1/Structs/Timeslice.html index f6e191c4a..2345fbfa0 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/Timeslice.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/Timeslice.html @@ -179,9 +179,6 @@ - @@ -521,7 +518,8 @@

Declaration

-

Interval of the aggregation. Valid date interval values are second/seconds minute/minutes, hour/hours, day/days, week/weeks, month/months, and year/years.

+

Interval of the aggregation. Valid date interval values are second/seconds minute/minutes, hour/hours, day/days, +week/weeks, month/months, and year/years.

@@ -548,7 +546,8 @@

Declaration

-

Used to inducate that anomaly detection should be performed. Anomaly detection is used to locate unusual datapoints within a time series.

+

Used to inducate that anomaly detection should be performed. Anomaly detection is used to locate unusual datapoints +within a time series.

@@ -567,7 +566,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/TopHits.html b/docs/swift-api/services/DiscoveryV1/Structs/TopHits.html index 226bd5b35..a98904ad5 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/TopHits.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/TopHits.html @@ -179,9 +179,6 @@ - @@ -540,7 +537,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/TopHitsResults.html b/docs/swift-api/services/DiscoveryV1/Structs/TopHitsResults.html index c51177bf1..592a90108 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/TopHitsResults.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/TopHitsResults.html @@ -179,9 +179,6 @@ - @@ -432,7 +429,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/TrainingDataSet.html b/docs/swift-api/services/DiscoveryV1/Structs/TrainingDataSet.html index 089dae03c..6b2addf82 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/TrainingDataSet.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/TrainingDataSet.html @@ -179,9 +179,6 @@ - @@ -459,7 +456,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/TrainingExample.html b/docs/swift-api/services/DiscoveryV1/Structs/TrainingExample.html index 6b649383e..1e004eafd 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/TrainingExample.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/TrainingExample.html @@ -179,9 +179,6 @@ - @@ -474,7 +471,11 @@

Declaration

Declaration

Swift

-
public init(documentID: String? = nil, crossReference: String? = nil, relevance: Int? = nil)
+
public init(
+    documentID: String? = nil,
+    crossReference: String? = nil,
+    relevance: Int? = nil
+)
@@ -533,7 +534,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/TrainingExampleList.html b/docs/swift-api/services/DiscoveryV1/Structs/TrainingExampleList.html index 1e06885fd..2e4737549 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/TrainingExampleList.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/TrainingExampleList.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/TrainingQuery.html b/docs/swift-api/services/DiscoveryV1/Structs/TrainingQuery.html index 2af6ce3d4..f2a746ffd 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/TrainingQuery.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/TrainingQuery.html @@ -179,9 +179,6 @@ - @@ -486,7 +483,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/TrainingStatus.html b/docs/swift-api/services/DiscoveryV1/Structs/TrainingStatus.html index 4126c13f8..76654d8a9 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/TrainingStatus.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/TrainingStatus.html @@ -179,9 +179,6 @@ - @@ -621,7 +618,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/WordHeadingDetection.html b/docs/swift-api/services/DiscoveryV1/Structs/WordHeadingDetection.html index 3cb26d067..14d7d80dd 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/WordHeadingDetection.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/WordHeadingDetection.html @@ -179,9 +179,6 @@ - @@ -447,7 +444,10 @@

Declaration

Declaration

Swift

-
public init(fonts: [FontSetting]? = nil, styles: [WordStyle]? = nil)
+
public init(
+    fonts: [FontSetting]? = nil,
+    styles: [WordStyle]? = nil
+)
@@ -494,7 +494,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/WordSettings.html b/docs/swift-api/services/DiscoveryV1/Structs/WordSettings.html index f67a5268f..51352e05b 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/WordSettings.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/WordSettings.html @@ -179,9 +179,6 @@ - @@ -420,7 +417,9 @@

Declaration

Declaration

Swift

-
public init(heading: WordHeadingDetection? = nil)
+
public init(
+    heading: WordHeadingDetection? = nil
+)
@@ -455,7 +454,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/WordStyle.html b/docs/swift-api/services/DiscoveryV1/Structs/WordStyle.html index aeea62f07..567159239 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/WordStyle.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/WordStyle.html @@ -179,9 +179,6 @@ - @@ -447,7 +444,10 @@

Declaration

Declaration

Swift

-
public init(level: Int? = nil, names: [String]? = nil)
+
public init(
+    level: Int? = nil,
+    names: [String]? = nil
+)
@@ -494,7 +494,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/Structs/XPathPatterns.html b/docs/swift-api/services/DiscoveryV1/Structs/XPathPatterns.html index a05ea9e9c..650088213 100644 --- a/docs/swift-api/services/DiscoveryV1/Structs/XPathPatterns.html +++ b/docs/swift-api/services/DiscoveryV1/Structs/XPathPatterns.html @@ -179,9 +179,6 @@ - @@ -420,7 +417,9 @@

Declaration

Declaration

Swift

-
public init(xpaths: [String]? = nil)
+
public init(
+    xpaths: [String]? = nil
+)
@@ -455,7 +454,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Classes.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Classes.html index 48d20eed4..b09ad66ca 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Classes.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Classes.html @@ -179,9 +179,6 @@ - @@ -380,10 +377,10 @@

Classes

-

The IBM Watson Discovery Service is a cognitive search and content analytics engine that you can add to applications to -identify patterns, trends and actionable insights to drive better decision-making. Securely unify structured and -unstructured data with pre-enriched content, and use a simplified query language to eliminate the need for manual -filtering of results.

+

The IBM Watson™ Discovery Service is a cognitive search and content analytics engine that you can add to +applications to identify patterns, trends and actionable insights to drive better decision-making. Securely unify +structured and unstructured data with pre-enriched content, and use a simplified query language to eliminate the need +for manual filtering of results.

See more
@@ -403,7 +400,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Classes/Discovery.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Classes/Discovery.html index f5e91c7af..5ec0fdc65 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Classes/Discovery.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Classes/Discovery.html @@ -179,9 +179,6 @@ - @@ -367,10 +364,10 @@

Discovery

-

The IBM Watson Discovery Service is a cognitive search and content analytics engine that you can add to applications to -identify patterns, trends and actionable insights to drive better decision-making. Securely unify structured and -unstructured data with pre-enriched content, and use a simplified query language to eliminate the need for manual -filtering of results.

+

The IBM Watson™ Discovery Service is a cognitive search and content analytics engine that you can add to +applications to identify patterns, trends and actionable insights to drive better decision-making. Securely unify +structured and unstructured data with pre-enriched content, and use a simplified query language to eliminate the need +for manual filtering of results.

@@ -1265,12 +1262,13 @@

Parameters

Add configuration.

-

Creates a new configuration. If the input configuration contains the configuration_id, created, or updated -properties, then they are ignored and overridden by the system, and an error is not returned so that the overridden -fields do not need to be removed when copying a configuration. The configuration can contain unrecognized JSON -fields. Any such fields are ignored and do not generate an error. This makes it easier to use newer configuration -files with older versions of the API and the service. It also makes it possible for the tooling to add additional -metadata and information to the configuration.

+

Creates a new configuration. +If the input configuration contains the configuration_id, created, or updated properties, then they are +ignored and overridden by the system, and an error is not returned so that the overridden fields do not need to be +removed when copying a configuration. +The configuration can contain unrecognized JSON fields. Any such fields are ignored and do not generate an error. +This makes it easier to use newer configuration files with older versions of the API and the service. It also makes +it possible for the tooling to add additional metadata and information to the configuration.

@@ -1311,13 +1309,14 @@

Parameters

Input an object that enables you to customize how your content is ingested and what enrichments are added to your -data. name is required and must be unique within the current environment. All other properties are optional. +data. +name is required and must be unique within the current environment. All other properties are optional. If the input configuration contains the configuration_id, created, or updated properties, then they will be ignored and overridden by the system (an error is not returned so that the overridden fields do not need to be -removed when copying a configuration). The configuration can contain unrecognized JSON fields. Any such fields -will be ignored and will not generate an error. This makes it easier to use newer configuration files with older -versions of the API and the service. It also makes it possible for the tooling to add additional metadata and -information to the configuration.

+removed when copying a configuration). +The configuration can contain unrecognized JSON fields. Any such fields will be ignored and will not generate an +error. This makes it easier to use newer configuration files with older versions of the API and the service. It +also makes it possible for the tooling to add additional metadata and information to the configuration.

@@ -1578,11 +1577,16 @@

Parameters

Update a configuration.

-

Replaces an existing configuration. * Completely replaces the original configuration. * The configuration_id, -updated, and created fields are accepted in the request, but they are ignored, and an error is not generated. -It is also acceptable for users to submit an updated configuration with none of the three properties. * Documents -are processed with a snapshot of the configuration as it was at the time the document was submitted to be ingested. -This means that already submitted documents will not see any updates made to the configuration.

+

Replaces an existing configuration.

+ +
    +
  • Completely replaces the original configuration.
  • +
  • The configuration_id, updated, and created fields are accepted in the request, but they are ignored, and +an error is not generated. It is also acceptable for users to submit an updated configuration with none of the +three properties.
  • +
  • Documents are processed with a snapshot of the configuration as it was at the time the document was submitted +to be ingested. This means that already submitted documents will not see any updates made to the configuration.

  • +
@@ -1636,14 +1640,15 @@

Parameters

Input an object that enables you to update and customize how your data is ingested and what enrichments are added -to your data. The name parameter is required and must be unique within the current environment. All other -properties are optional, but if they are omitted the default values replace the current value of each omitted -property. If the input configuration contains the configuration_id, created, or updated properties, they are -ignored and overridden by the system, and an error is not returned so that the overridden fields do not need to be -removed when updating a configuration. The configuration can contain unrecognized JSON fields. Any such fields -are ignored and do not generate an error. This makes it easier to use newer configuration files with older versions -of the API and the service. It also makes it possible for the tooling to add additional metadata and information to -the configuration.

+to your data. +The name parameter is required and must be unique within the current environment. All other properties are +optional, but if they are omitted the default values replace the current value of each omitted property. +If the input configuration contains the configuration_id, created, or updated properties, they are ignored +and overridden by the system, and an error is not returned so that the overridden fields do not need to be +removed when updating a configuration. +The configuration can contain unrecognized JSON fields. Any such fields are ignored and do not generate an error. +This makes it easier to use newer configuration files with older versions of the API and the service. It also +makes it possible for the tooling to add additional metadata and information to the configuration.

@@ -1854,10 +1859,11 @@

Parameters

-

The configuration to use to process the document. If this part is provided, then the provided configuration is used -to process the document. If the configuration_id is also provided (both are present at the same time), then -request is rejected. The maximum supported configuration size is 1 MB. Configuration parts larger than 1 MB are -rejected. See the GET /configurations/{configuration_id} operation for an example configuration.

+

The configuration to use to process the document. If this part is provided, then the provided configuration is +used to process the document. If the configuration_id is also provided (both are present at the same time), +then request is rejected. The maximum supported configuration size is 1 MB. Configuration parts larger than 1 MB +are rejected. +See the GET /configurations/{configuration_id} operation for an example configuration.

@@ -1882,8 +1888,8 @@

Parameters

-

The ID of the configuration to use to process the document. If the configuration form part is also provided (both -are present at the same time), then request will be rejected.

+

The ID of the configuration to use to process the document. If the configuration form part is also provided +(both are present at the same time), then request will be rejected.

@@ -1909,8 +1915,12 @@

Parameters

If you’re using the Data Crawler to upload your documents, you can test a document against the type of metadata -that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB -are rejected. Example: { \"Creator\": \"Johnny Appleseed\", \"Subject\": \"Apples\" }.

+that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 +MB are rejected. +Example: { +\"Creator\": \"Johnny Appleseed\", +\"Subject\": \"Apples\" +}.

@@ -2723,15 +2733,8 @@

Parameters

Create or update expansion list.

Create or replace the Expansion list for this collection. The maximum number of expanded terms per collection is -500. The current expansion list is replaced with the uploaded content.

- -
    -
  • uni-directional. To create a bi-directional expansion specify an expanded_terms array. When found in a query, -all items in the expanded_terms array are then expanded to the other items in the same array. To create a -uni-directional expansion, specify both an array of input_terms and an array of expanded_terms. When items in -the input_terms array are present in a query, they are expanded using the items listed in the expanded_terms -array.
  • -
+500. +The current expansion list is replaced with the uploaded content.

@@ -2784,9 +2787,15 @@

Parameters

-

An array of query expansion definitions. Each object in the expansions array represents a term or set of terms -that will be expanded into other terms. Each expansion object can be configured so that all terms are expanded to -all other terms in the object - bi-directional, or a set list of terms can be expanded into a second list of terms

+

An array of query expansion definitions. +Each object in the expansions array represents a term or set of terms that will be expanded into other terms. +Each expansion object can be configured so that all terms are expanded to all other terms in the object - +bi-directional, or a set list of terms can be expanded into a second list of terms - uni-directional. +To create a bi-directional expansion specify an expanded_terms array. When found in a query, all items in the +expanded_terms array are then expanded to the other items in the same array. +To create a uni-directional expansion, specify both an array of input_terms and an array of expanded_terms. +When items in the input_terms array are present in a query, they are expanded using the items listed in the +expanded_terms array.

@@ -2949,16 +2958,20 @@

Parameters

Add a document.

-

Add a document to a collection with optional metadata. * The version query parameter is still required. * -Returns immediately after the system has accepted the document for processing. * The user must provide document -content, metadata, or both. If the request is missing both document content and metadata, it is rejected. * The -user can set the Content-Type parameter on the file part to indicate the media type of the document. If the -Content-Type parameter is missing or is one of the generic media types (for example, application/octet-stream), -then the service attempts to automatically detect the document’s media type. * The following field names are -reserved and will be filtered out if present after normalization: id, score, highlight, and any field with -the prefix of: _, +, or - * Fields with empty name values after normalization are filtered out before -indexing. * Fields containing the following characters after normalization are filtered out before indexing: # -and ,.

+

Add a document to a collection with optional metadata.

+ +
    +
  • The version query parameter is still required.
  • +
  • The user must provide document content, metadata, or both. If the request is missing both document content and +metadata, it is rejected.
  • +
  • The user can set the Content-Type parameter on the file part to indicate the media type of the document. If +the Content-Type parameter is missing or is one of the generic media types (for example, +application/octet-stream), then the service attempts to automatically detect the document’s media type.
  • +
  • The following field names are reserved and will be filtered out if present after normalization: id, score, +highlight, and any field with the prefix of: _, +, or -
  • +
  • Fields with empty name values after normalization are filtered out before indexing.
  • +
  • Fields containing the following characters after normalization are filtered out before indexing: # and ,.

  • +
@@ -3027,8 +3040,12 @@

Parameters

If you’re using the Data Crawler to upload your documents, you can test a document against the type of metadata -that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB -are rejected. Example: { \"Creator\": \"Johnny Appleseed\", \"Subject\": \"Apples\" }.

+that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 +MB are rejected. +Example: { +\"Creator\": \"Johnny Appleseed\", +\"Subject\": \"Apples\" +}.

@@ -3299,8 +3316,12 @@

Parameters

If you’re using the Data Crawler to upload your documents, you can test a document against the type of metadata -that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB -are rejected. Example: { \"Creator\": \"Johnny Appleseed\", \"Subject\": \"Apples\" }.

+that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 +MB are rejected. +Example: { +\"Creator\": \"Johnny Appleseed\", +\"Subject\": \"Apples\" +}.

@@ -3560,9 +3581,9 @@

Parameters

-

A cacheable query that limits the documents returned to exclude any documents that don’t mention the query content. -Filter searches are better for metadata type searches and when you are trying to get a sense of concepts in the -data set.

+

A cacheable query that limits the documents returned to exclude any documents that don’t mention the query +content. Filter searches are better for metadata type searches and when you are trying to get a sense of concepts +in the data set.

@@ -3614,8 +3635,8 @@

Parameters

An aggregation search uses combinations of filters and query search to return an exact answer. Aggregations are -useful for building applications, because you can use them to build lists, tables, and time series. For a full list -of possible aggregrations, see the Query reference.

+useful for building applications, because you can use them to build lists, tables, and time series. For a full +list of possible aggregrations, see the Query reference.

@@ -3651,8 +3672,8 @@

Parameters

-

The number of query results to skip at the beginning. For example, if the total number of results that are returned -is 10, and the offset is 8, it returns the last two results.

+

The number of query results to skip at the beginning. For example, if the total number of results that are +returned is 10, and the offset is 8, it returns the last two results.

@@ -3691,8 +3712,8 @@

Parameters

-

A comma-separated list of fields that passages are drawn from. If this parameter not specified, then all top-level -fields are included.

+

A comma-separated list of fields that passages are drawn from. If this parameter not specified, then all +top-level fields are included.

@@ -3717,8 +3738,8 @@

Parameters

-

The approximate number of characters that any one passage will have. The default is 400. The minimum is 50. The -maximum is 2000.

+

The approximate number of characters that any one passage will have. The default is 400. The minimum is 50. +The maximum is 2000.

@@ -3731,8 +3752,8 @@

Parameters

When true and used with a Watson Discovery News collection, duplicate results (based on the contents of the -title field) are removed. Duplicate comparison is limited to the current query only, offset is not considered. -Defaults to false. This parameter is currently Beta functionality.

+title field) are removed. Duplicate comparison is limited to the current query only, offset is not +considered. Defaults to false. This parameter is currently Beta functionality.

@@ -3771,10 +3792,10 @@

Parameters

-

A comma-separated list of document IDs that will be used to find similar documents. Note: If the -natural_language_query parameter is also specified, it will be used to expand the scope of the document -similarity search to include the natural language query. Other query parameters, such as filter and query are -subsequently applied and reduce the query scope.

+

A comma-separated list of document IDs that will be used to find similar documents. +Note: If the natural_language_query parameter is also specified, it will be used to expand the scope of the +document similarity search to include the natural language query. Other query parameters, such as filter and +query are subsequently applied and reduce the query scope.

@@ -3786,8 +3807,8 @@

Parameters

-

A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If -not specified, the entire document is used for comparison.

+

A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. +If not specified, the entire document is used for comparison.

@@ -3920,9 +3941,9 @@

Parameters

-

A cacheable query that limits the documents returned to exclude any documents that don’t mention the query content. -Filter searches are better for metadata type searches and when you are trying to get a sense of concepts in the -data set.

+

A cacheable query that limits the documents returned to exclude any documents that don’t mention the query +content. Filter searches are better for metadata type searches and when you are trying to get a sense of concepts +in the data set.

@@ -3974,8 +3995,8 @@

Parameters

An aggregation search uses combinations of filters and query search to return an exact answer. Aggregations are -useful for building applications, because you can use them to build lists, tables, and time series. For a full list -of possible aggregrations, see the Query reference.

+useful for building applications, because you can use them to build lists, tables, and time series. For a full +list of possible aggregrations, see the Query reference.

@@ -4011,8 +4032,8 @@

Parameters

-

The number of query results to skip at the beginning. For example, if the total number of results that are returned -is 10, and the offset is 8, it returns the last two results.

+

The number of query results to skip at the beginning. For example, if the total number of results that are +returned is 10, and the offset is 8, it returns the last two results.

@@ -4051,8 +4072,8 @@

Parameters

-

A comma-separated list of fields that passages are drawn from. If this parameter not specified, then all top-level -fields are included.

+

A comma-separated list of fields that passages are drawn from. If this parameter not specified, then all +top-level fields are included.

@@ -4077,8 +4098,8 @@

Parameters

-

The approximate number of characters that any one passage will have. The default is 400. The minimum is 50. The -maximum is 2000.

+

The approximate number of characters that any one passage will have. The default is 400. The minimum is 50. +The maximum is 2000.

@@ -4117,10 +4138,10 @@

Parameters

-

A comma-separated list of document IDs that will be used to find similar documents. Note: If the -natural_language_query parameter is also specified, it will be used to expand the scope of the document -similarity search to include the natural language query. Other query parameters, such as filter and query are -subsequently applied and reduce the query scope.

+

A comma-separated list of document IDs that will be used to find similar documents. +Note: If the natural_language_query parameter is also specified, it will be used to expand the scope of the +document similarity search to include the natural language query. Other query parameters, such as filter and +query are subsequently applied and reduce the query scope.

@@ -4132,8 +4153,8 @@

Parameters

-

A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If -not specified, the entire document is used for comparison.

+

A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. +If not specified, the entire document is used for comparison.

@@ -4261,9 +4282,9 @@

Parameters

-

A cacheable query that limits the documents returned to exclude any documents that don’t mention the query content. -Filter searches are better for metadata type searches and when you are trying to get a sense of concepts in the -data set.

+

A cacheable query that limits the documents returned to exclude any documents that don’t mention the query +content. Filter searches are better for metadata type searches and when you are trying to get a sense of concepts +in the data set.

@@ -4303,8 +4324,8 @@

Parameters

An aggregation search uses combinations of filters and query search to return an exact answer. Aggregations are -useful for building applications, because you can use them to build lists, tables, and time series. For a full list -of possible aggregrations, see the Query reference.

+useful for building applications, because you can use them to build lists, tables, and time series. For a full +list of possible aggregrations, see the Query reference.

@@ -4340,8 +4361,8 @@

Parameters

-

The number of query results to skip at the beginning. For example, if the total number of results that are returned -is 10, and the offset is 8, it returns the last two results.

+

The number of query results to skip at the beginning. For example, if the total number of results that are +returned is 10, and the offset is 8, it returns the last two results.

@@ -4381,8 +4402,8 @@

Parameters

When true and used with a Watson Discovery News collection, duplicate results (based on the contents of the -title field) are removed. Duplicate comparison is limited to the current query only, offset is not considered. -Defaults to false. This parameter is currently Beta functionality.

+title field) are removed. Duplicate comparison is limited to the current query only, offset is not +considered. Defaults to false. This parameter is currently Beta functionality.

@@ -4421,10 +4442,10 @@

Parameters

-

A comma-separated list of document IDs that will be used to find similar documents. Note: If the -natural_language_query parameter is also specified, it will be used to expand the scope of the document -similarity search to include the natural language query. Other query parameters, such as filter and query are -subsequently applied and reduce the query scope.

+

A comma-separated list of document IDs that will be used to find similar documents. +Note: If the natural_language_query parameter is also specified, it will be used to expand the scope of the +document similarity search to include the natural language query. Other query parameters, such as filter and +query are subsequently applied and reduce the query scope.

@@ -4436,8 +4457,8 @@

Parameters

-

A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If -not specified, the entire document is used for comparison.

+

A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. +If not specified, the entire document is used for comparison.

@@ -4566,9 +4587,9 @@

Parameters

-

A cacheable query that limits the documents returned to exclude any documents that don’t mention the query content. -Filter searches are better for metadata type searches and when you are trying to get a sense of concepts in the -data set.

+

A cacheable query that limits the documents returned to exclude any documents that don’t mention the query +content. Filter searches are better for metadata type searches and when you are trying to get a sense of concepts +in the data set.

@@ -4608,8 +4629,8 @@

Parameters

An aggregation search uses combinations of filters and query search to return an exact answer. Aggregations are -useful for building applications, because you can use them to build lists, tables, and time series. For a full list -of possible aggregrations, see the Query reference.

+useful for building applications, because you can use them to build lists, tables, and time series. For a full +list of possible aggregrations, see the Query reference.

@@ -4645,8 +4666,8 @@

Parameters

-

The number of query results to skip at the beginning. For example, if the total number of results that are returned -is 10, and the offset is 8, it returns the last two results.

+

The number of query results to skip at the beginning. For example, if the total number of results that are +returned is 10, and the offset is 8, it returns the last two results.

@@ -4712,10 +4733,10 @@

Parameters

-

A comma-separated list of document IDs that will be used to find similar documents. Note: If the -natural_language_query parameter is also specified, it will be used to expand the scope of the document -similarity search to include the natural language query. Other query parameters, such as filter and query are -subsequently applied and reduce the query scope.

+

A comma-separated list of document IDs that will be used to find similar documents. +Note: If the natural_language_query parameter is also specified, it will be used to expand the scope of the +document similarity search to include the natural language query. Other query parameters, such as filter and +query are subsequently applied and reduce the query scope.

@@ -4727,8 +4748,8 @@

Parameters

-

A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If -not specified, the entire document is used for comparison.

+

A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. +If not specified, the entire document is used for comparison.

@@ -6264,8 +6285,9 @@

Parameters

Delete labeled data.

Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with -the customer ID. You associate a customer ID with data by passing the X-Watson-Metadata header with a request -that passes data. For more information about personal data and customer IDs, see Information +the customer ID. +You associate a customer ID with data by passing the X-Watson-Metadata header with a request that passes data. +For more information about personal data and customer IDs, see Information security.

@@ -6344,7 +6366,7 @@

Parameters

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Enums.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Enums.html index 3473a8f85..a2bdd7e1a 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Enums.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Enums.html @@ -179,9 +179,6 @@ - @@ -464,7 +461,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html index 045e5aade..6678f797c 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html @@ -179,9 +179,6 @@ - @@ -702,7 +699,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Enums/QueryAggregation.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Enums/QueryAggregation.html index 4843ff01a..9cf33da81 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Enums/QueryAggregation.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Enums/QueryAggregation.html @@ -179,9 +179,6 @@ - @@ -728,7 +725,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html index bfcfc7a6d..5b93ebcaa 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html @@ -179,9 +179,6 @@ - @@ -569,7 +566,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs.html index d28408795..952079bc2 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs.html @@ -179,9 +179,6 @@ - @@ -1340,7 +1337,15 @@

Declaration

-

The list of fetched fields. The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations. * Fields which contain nested JSON objects are assigned a type of nested. * Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity). * Fields returned from the News collection are prefixed with v{N}-fullnews-t3-{YEAR}.mappings (for example, v5-fullnews-t3-2016.mappings.text.properties.author).

+

The list of fetched fields.

+ +

The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations.

+ +
    +
  • Fields which contain nested JSON objects are assigned a type of nested.

  • +
  • Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity).

  • +
  • Fields returned from the News collection are prefixed with v{N}-fullnews-t3-{YEAR}.mappings (for example, v5-fullnews-t3-2016.mappings.text.properties.author).

  • +
See more
@@ -3021,49 +3026,10 @@

Declaration

-
-
- - - -

JSON

-
-
-
    -
  • -
    - - - - JSONWrapper - -
    -
    -
    -
    -
    -
    -

    Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct JSONWrapper
    - -
    -
    -
    -
    -
  • -
-
diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/AggregationResult.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/AggregationResult.html index 8e0cf80de..d0a43c638 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/AggregationResult.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/AggregationResult.html @@ -179,9 +179,6 @@ - @@ -485,7 +482,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Calculation.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Calculation.html index 756709f1a..5703dc018 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Calculation.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Calculation.html @@ -179,9 +179,6 @@ - @@ -540,7 +537,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Collection.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Collection.html index 1ee9e8539..a577148e0 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Collection.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Collection.html @@ -179,9 +179,6 @@ - @@ -603,7 +600,8 @@

Declaration

-

The language of the documents stored in the collection. Permitted values include en (English), de (German), and es (Spanish).

+

The language of the documents stored in the collection. Permitted values include en (English), de (German), and +es (Spanish).

@@ -630,7 +628,8 @@

Declaration

-

The object providing information about the documents in the collection. Present only when retrieving details of a collection.

+

The object providing information about the documents in the collection. Present only when retrieving details of a +collection.

@@ -657,7 +656,8 @@

Declaration

-

The object providing information about the disk usage of the collection. Present only when retrieving details of a collection.

+

The object providing information about the disk usage of the collection. Present only when retrieving details of a +collection.

@@ -703,7 +703,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Collection/Status.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Collection/Status.html index feead2d75..003d335a5 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Collection/Status.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Collection/Status.html @@ -179,9 +179,6 @@ - @@ -459,7 +456,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/CollectionDiskUsage.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/CollectionDiskUsage.html index 005f0c562..40bef967b 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/CollectionDiskUsage.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/CollectionDiskUsage.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/CollectionUsage.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/CollectionUsage.html index a878a5c91..3e10a15e9 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/CollectionUsage.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/CollectionUsage.html @@ -179,9 +179,6 @@ - @@ -432,7 +429,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Configuration.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Configuration.html index f6777566c..7145ede81 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Configuration.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Configuration.html @@ -179,9 +179,6 @@ - @@ -575,7 +572,8 @@

Declaration

-

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are executed in the order that they appear in the array.

+

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are +executed in the order that they appear in the array.

@@ -609,7 +607,16 @@

Declaration

Declaration

Swift

-
public init(name: String, configurationID: String? = nil, created: String? = nil, updated: String? = nil, description: String? = nil, conversions: Conversions? = nil, enrichments: [Enrichment]? = nil, normalizations: [NormalizationOperation]? = nil)
+
public init(
+    name: String,
+    configurationID: String? = nil,
+    created: String? = nil,
+    updated: String? = nil,
+    description: String? = nil,
+    conversions: Conversions? = nil,
+    enrichments: [Enrichment]? = nil,
+    normalizations: [NormalizationOperation]? = nil
+)
@@ -709,7 +716,8 @@

Parameters

-

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are executed in the order that they appear in the array.

+

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are +executed in the order that they appear in the array.

@@ -728,7 +736,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Conversions.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Conversions.html index 7dd48d267..754fa8aa2 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Conversions.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Conversions.html @@ -179,9 +179,6 @@ - @@ -494,7 +491,8 @@

Declaration

-

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are executed in the order that they appear in the array.

+

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are +executed in the order that they appear in the array.

@@ -528,7 +526,13 @@

Declaration

Declaration

Swift

-
public init(pdf: PdfSettings? = nil, word: WordSettings? = nil, html: HtmlSettings? = nil, segment: SegmentSettings? = nil, jsonNormalizations: [NormalizationOperation]? = nil)
+
public init(
+    pdf: PdfSettings? = nil,
+    word: WordSettings? = nil,
+    html: HtmlSettings? = nil,
+    segment: SegmentSettings? = nil,
+    jsonNormalizations: [NormalizationOperation]? = nil
+)
@@ -592,7 +596,8 @@

Parameters

-

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are executed in the order that they appear in the array.

+

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are +executed in the order that they appear in the array.

@@ -611,7 +616,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateCollectionRequest.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateCollectionRequest.html index 7a1fe48ab..e0ccf6866 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateCollectionRequest.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateCollectionRequest.html @@ -179,9 +179,6 @@ - @@ -529,7 +526,12 @@

Declaration

Declaration

Swift

-
public init(name: String, description: String? = nil, configurationID: String? = nil, language: String? = nil)
+
public init(
+    name: String,
+    description: String? = nil,
+    configurationID: String? = nil,
+    language: String? = nil
+)
@@ -600,7 +602,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateCollectionRequest/Language.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateCollectionRequest/Language.html index eec13c02a..6ce7464ea 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateCollectionRequest/Language.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateCollectionRequest/Language.html @@ -179,9 +179,6 @@ - @@ -621,7 +618,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteCollectionResponse.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteCollectionResponse.html index 29ae63c0f..ad2c2f108 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteCollectionResponse.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteCollectionResponse.html @@ -179,9 +179,6 @@ - @@ -460,7 +457,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteCollectionResponse/Status.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteCollectionResponse/Status.html index 3881ae7d5..62cceaf03 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteCollectionResponse/Status.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteCollectionResponse/Status.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteConfigurationResponse.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteConfigurationResponse.html index 10b33350d..d0c60bfa4 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteConfigurationResponse.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteConfigurationResponse.html @@ -179,9 +179,6 @@ - @@ -487,7 +484,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteConfigurationResponse/Status.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteConfigurationResponse/Status.html index 1b293a46c..5ed1a16cd 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteConfigurationResponse/Status.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteConfigurationResponse/Status.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteDocumentResponse.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteDocumentResponse.html index 3a2e446db..8b408d275 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteDocumentResponse.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteDocumentResponse.html @@ -179,9 +179,6 @@ - @@ -460,7 +457,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteDocumentResponse/Status.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteDocumentResponse/Status.html index e61f519e2..7e3c73133 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteDocumentResponse/Status.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteDocumentResponse/Status.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteEnvironmentResponse.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteEnvironmentResponse.html index 9c0aef8e5..bdcca893a 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteEnvironmentResponse.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteEnvironmentResponse.html @@ -179,9 +179,6 @@ - @@ -460,7 +457,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteEnvironmentResponse/Status.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteEnvironmentResponse/Status.html index 5257cdb1b..f26156040 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteEnvironmentResponse/Status.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteEnvironmentResponse/Status.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DiskUsage.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DiskUsage.html index f185be050..c02b48c12 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DiskUsage.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DiskUsage.html @@ -179,9 +179,6 @@ - @@ -540,7 +537,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentAccepted.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentAccepted.html index db6ce3efc..169ddeb1e 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentAccepted.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentAccepted.html @@ -179,9 +179,6 @@ - @@ -487,7 +484,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentAccepted/Status.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentAccepted/Status.html index 6a1408c20..0a62dbba4 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentAccepted/Status.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentAccepted/Status.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentCounts.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentCounts.html index 7dee855a6..621f1a0fb 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentCounts.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentCounts.html @@ -179,9 +179,6 @@ - @@ -459,7 +456,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentSnapshot.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentSnapshot.html index 3484bfd3f..92a3c543f 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentSnapshot.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentSnapshot.html @@ -179,9 +179,6 @@ - @@ -460,7 +457,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentSnapshot/Step.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentSnapshot/Step.html index 01b55b3ed..f3d32c85b 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentSnapshot/Step.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentSnapshot/Step.html @@ -179,9 +179,6 @@ - @@ -540,7 +537,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentStatus.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentStatus.html index 0da0f7343..1871c4521 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentStatus.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentStatus.html @@ -179,9 +179,6 @@ - @@ -704,7 +701,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentStatus/FileType.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentStatus/FileType.html index 837f218a2..c6c0b9ba3 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentStatus/FileType.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentStatus/FileType.html @@ -179,9 +179,6 @@ - @@ -486,7 +483,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentStatus/Status.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentStatus/Status.html index e4bbbb907..51de8e6cf 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentStatus/Status.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentStatus/Status.html @@ -179,9 +179,6 @@ - @@ -486,7 +483,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Enrichment.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Enrichment.html index d09fd7f98..1ce135de8 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Enrichment.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Enrichment.html @@ -179,9 +179,6 @@ - @@ -413,7 +410,9 @@

Declaration

-

Field where enrichments will be stored. This field must already exist or be at most 1 level deeper than an existing field. For example, if text is a top-level field with no sub-fields, text.foo is a valid destination but text.foo.bar is not.

+

Field where enrichments will be stored. This field must already exist or be at most 1 level deeper than an existing +field. For example, if text is a top-level field with no sub-fields, text.foo is a valid destination but +text.foo.bar is not.

@@ -494,7 +493,13 @@

Declaration

-

Name of the enrichment service to call. Current options are natural_language_understanding and elements. When using natual_language_understanding, the options object must contain Natural Language Understanding Options. When using elements the options object must contain Element Classification options. Additionally, when using the elements enrichment the configuration specified and files ingested must meet all the criteria specified in the documentation Previous API versions also supported alchemy_language.

+

Name of the enrichment service to call. Current options are natural_language_understanding and elements. + When using natual_language_understanding, the options object must contain Natural Language Understanding +Options. + When using elements the options object must contain Element Classification options. Additionally, when using +the elements enrichment the configuration specified and files ingested must meet all the criteria specified in +the documentation + Previous API versions also supported alchemy_language.

@@ -521,7 +526,8 @@

Declaration

-

If true, then most errors generated during the enrichment process will be treated as warnings and will not cause the document to fail processing.

+

If true, then most errors generated during the enrichment process will be treated as warnings and will not cause +the document to fail processing.

@@ -582,7 +588,15 @@

Declaration

Declaration

Swift

-
public init(destinationField: String, sourceField: String, enrichmentName: String, description: String? = nil, overwrite: Bool? = nil, ignoreDownstreamErrors: Bool? = nil, options: EnrichmentOptions? = nil)
+
public init(
+    destinationField: String,
+    sourceField: String,
+    enrichmentName: String,
+    description: String? = nil,
+    overwrite: Bool? = nil,
+    ignoreDownstreamErrors: Bool? = nil,
+    options: EnrichmentOptions? = nil
+)
@@ -598,7 +612,9 @@

Parameters

-

Field where enrichments will be stored. This field must already exist or be at most 1 level deeper than an existing field. For example, if text is a top-level field with no sub-fields, text.foo is a valid destination but text.foo.bar is not.

+

Field where enrichments will be stored. This field must already exist or be at most 1 level deeper than an +existing field. For example, if text is a top-level field with no sub-fields, text.foo is a valid destination +but text.foo.bar is not.

@@ -622,7 +638,13 @@

Parameters

-

Name of the enrichment service to call. Current options are natural_language_understanding and elements. When using natual_language_understanding, the options object must contain Natural Language Understanding Options. When using elements the options object must contain Element Classification options. Additionally, when using the elements enrichment the configuration specified and files ingested must meet all the criteria specified in the documentation Previous API versions also supported alchemy_language.

+

Name of the enrichment service to call. Current options are natural_language_understanding and elements. +When using natual_language_understanding, the options object must contain Natural Language Understanding +Options. +When using elements the options object must contain Element Classification options. Additionally, when using +the elements enrichment the configuration specified and files ingested must meet all the criteria specified in +the documentation +Previous API versions also supported alchemy_language.

@@ -658,7 +680,8 @@

Parameters

-

If true, then most errors generated during the enrichment process will be treated as warnings and will not cause the document to fail processing.

+

If true, then most errors generated during the enrichment process will be treated as warnings and will not cause +the document to fail processing.

@@ -689,7 +712,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/EnrichmentOptions.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/EnrichmentOptions.html index 260f81719..b0eeee2e9 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/EnrichmentOptions.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/EnrichmentOptions.html @@ -179,9 +179,6 @@ - @@ -447,7 +444,10 @@

Declaration

Declaration

Swift

-
public init(features: NluEnrichmentFeatures? = nil, model: String? = nil)
+
public init(
+    features: NluEnrichmentFeatures? = nil,
+    model: String? = nil
+)
@@ -475,7 +475,8 @@

Parameters

-

For use with elements enrichments only. The element extraction model to use. Models available are: contract.

+

For use with elements enrichments only. The element extraction model to use. Models available are: +contract.

@@ -494,7 +495,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Environment.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Environment.html index 02e369d2e..2f31dbf99 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Environment.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Environment.html @@ -179,9 +179,6 @@ - @@ -649,7 +646,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Environment/Status.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Environment/Status.html index 3ac726f73..4b5e53118 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Environment/Status.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Environment/Status.html @@ -179,9 +179,6 @@ - @@ -459,7 +456,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/EnvironmentDocuments.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/EnvironmentDocuments.html index 5bb0d52cc..fe9a64359 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/EnvironmentDocuments.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/EnvironmentDocuments.html @@ -179,9 +179,6 @@ - @@ -432,7 +429,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Expansion.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Expansion.html index 6ffbf74c4..2b3ca88b7 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Expansion.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Expansion.html @@ -179,9 +179,6 @@ - @@ -413,7 +410,8 @@

Declaration

-

A list of terms that this expansion will be expanded to. If specified without input_terms, it also functions as the input term list.

+

A list of terms that this expansion will be expanded to. If specified without input_terms, it also functions as +the input term list.

@@ -447,7 +445,10 @@

Declaration

Declaration

Swift

-
public init(expandedTerms: [String], inputTerms: [String]? = nil)
+
public init(
+    expandedTerms: [String],
+    inputTerms: [String]? = nil
+)
@@ -463,7 +464,8 @@

Parameters

-

A list of terms that this expansion will be expanded to. If specified without input_terms, it also functions as the input term list.

+

A list of terms that this expansion will be expanded to. If specified without input_terms, it also functions as +the input term list.

@@ -494,7 +496,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Expansions.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Expansions.html index 039315fdf..45bf6d363 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Expansions.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Expansions.html @@ -179,9 +179,6 @@ - @@ -386,7 +383,15 @@

Expansions

-

An array of query expansion definitions. Each object in the expansions array represents a term or set of terms that will be expanded into other terms. Each expansion object can be configured so that all terms are expanded to all other terms in the object - bi-directional, or a set list of terms can be expanded into a second list of terms - uni-directional. To create a bi-directional expansion specify an expanded_terms array. When found in a query, all items in the expanded_terms array are then expanded to the other items in the same array. To create a uni-directional expansion, specify both an array of input_terms and an array of expanded_terms. When items in the input_terms array are present in a query, they are expanded using the items listed in the expanded_terms array.

+

An array of query expansion definitions. + Each object in the expansions array represents a term or set of terms that will be expanded into other terms. +Each expansion object can be configured so that all terms are expanded to all other terms in the object - +bi-directional, or a set list of terms can be expanded into a second list of terms - uni-directional. + To create a bi-directional expansion specify an expanded_terms array. When found in a query, all items in the +expanded_terms array are then expanded to the other items in the same array. + To create a uni-directional expansion, specify both an array of input_terms and an array of expanded_terms. +When items in the input_terms array are present in a query, they are expanded using the items listed in the +expanded_terms array.

@@ -420,7 +425,9 @@

Declaration

Declaration

Swift

-
public init(expansions: [Expansion])
+
public init(
+    expansions: [Expansion]
+)
@@ -436,7 +443,15 @@

Parameters

-

An array of query expansion definitions. Each object in the expansions array represents a term or set of terms that will be expanded into other terms. Each expansion object can be configured so that all terms are expanded to all other terms in the object - bi-directional, or a set list of terms can be expanded into a second list of terms - uni-directional. To create a bi-directional expansion specify an expanded_terms array. When found in a query, all items in the expanded_terms array are then expanded to the other items in the same array. To create a uni-directional expansion, specify both an array of input_terms and an array of expanded_terms. When items in the input_terms array are present in a query, they are expanded using the items listed in the expanded_terms array.

+

An array of query expansion definitions. +Each object in the expansions array represents a term or set of terms that will be expanded into other terms. +Each expansion object can be configured so that all terms are expanded to all other terms in the object - +bi-directional, or a set list of terms can be expanded into a second list of terms - uni-directional. +To create a bi-directional expansion specify an expanded_terms array. When found in a query, all items in the +expanded_terms array are then expanded to the other items in the same array. +To create a uni-directional expansion, specify both an array of input_terms and an array of expanded_terms. +When items in the input_terms array are present in a query, they are expanded using the items listed in the +expanded_terms array.

@@ -455,7 +470,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Field.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Field.html index a2fa19a91..fc62cd8f4 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Field.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Field.html @@ -179,9 +179,6 @@ - @@ -460,7 +457,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Field/FieldType.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Field/FieldType.html index d45587c72..a3d68a6a9 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Field/FieldType.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Field/FieldType.html @@ -179,9 +179,6 @@ - @@ -675,7 +672,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Filter.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Filter.html index 4ab045324..2fce17691 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Filter.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Filter.html @@ -179,9 +179,6 @@ - @@ -513,7 +510,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/FontSetting.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/FontSetting.html index 2c10d0e68..cab35e7a5 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/FontSetting.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/FontSetting.html @@ -179,9 +179,6 @@ - @@ -555,7 +552,14 @@

Declaration

Declaration

Swift

-
public init(level: Int? = nil, minSize: Int? = nil, maxSize: Int? = nil, bold: Bool? = nil, italic: Bool? = nil, name: String? = nil)
+
public init(
+    level: Int? = nil,
+    minSize: Int? = nil,
+    maxSize: Int? = nil,
+    bold: Bool? = nil,
+    italic: Bool? = nil,
+    name: String? = nil
+)
@@ -650,7 +654,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/GenericQueryAggregation.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/GenericQueryAggregation.html index d4eb5c29a..ffaa31d7f 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/GenericQueryAggregation.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/GenericQueryAggregation.html @@ -179,9 +179,6 @@ - @@ -486,7 +483,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Histogram.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Histogram.html index b8104eceb..f60d55096 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Histogram.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Histogram.html @@ -179,9 +179,6 @@ - @@ -540,7 +537,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/HtmlSettings.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/HtmlSettings.html index 8170be84c..582cc8271 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/HtmlSettings.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/HtmlSettings.html @@ -179,9 +179,6 @@ - @@ -555,7 +552,14 @@

Declaration

Declaration

Swift

-
public init(excludeTagsCompletely: [String]? = nil, excludeTagsKeepContent: [String]? = nil, keepContent: XPathPatterns? = nil, excludeContent: XPathPatterns? = nil, keepTagAttributes: [String]? = nil, excludeTagAttributes: [String]? = nil)
+
public init(
+    excludeTagsCompletely: [String]? = nil,
+    excludeTagsKeepContent: [String]? = nil,
+    keepContent: XPathPatterns? = nil,
+    excludeContent: XPathPatterns? = nil,
+    keepTagAttributes: [String]? = nil,
+    excludeTagAttributes: [String]? = nil
+)
@@ -650,7 +654,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/IndexCapacity.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/IndexCapacity.html index 0c0af7115..bb5b2d9c6 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/IndexCapacity.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/IndexCapacity.html @@ -179,9 +179,6 @@ - @@ -486,7 +483,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/ListCollectionFieldsResponse.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/ListCollectionFieldsResponse.html index 8b0b5c07a..b49b9f445 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/ListCollectionFieldsResponse.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/ListCollectionFieldsResponse.html @@ -179,9 +179,6 @@ - @@ -367,7 +364,15 @@

ListCollectionFieldsResponse

-

The list of fetched fields. The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations. * Fields which contain nested JSON objects are assigned a type of nested. * Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity). * Fields returned from the News collection are prefixed with v{N}-fullnews-t3-{YEAR}.mappings (for example, v5-fullnews-t3-2016.mappings.text.properties.author).

+

The list of fetched fields.

+ +

The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations.

+ +
    +
  • Fields which contain nested JSON objects are assigned a type of nested.

  • +
  • Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity).

  • +
  • Fields returned from the News collection are prefixed with v{N}-fullnews-t3-{YEAR}.mappings (for example, v5-fullnews-t3-2016.mappings.text.properties.author).

  • +
@@ -405,7 +410,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/ListCollectionsResponse.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/ListCollectionsResponse.html index 684af1ae9..c5fd0c705 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/ListCollectionsResponse.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/ListCollectionsResponse.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/ListConfigurationsResponse.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/ListConfigurationsResponse.html index f8d1f8ce5..ff405a79f 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/ListConfigurationsResponse.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/ListConfigurationsResponse.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/ListEnvironmentsResponse.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/ListEnvironmentsResponse.html index 98112c960..f0fb856b0 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/ListEnvironmentsResponse.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/ListEnvironmentsResponse.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/MemoryUsage.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/MemoryUsage.html index 837384c86..03c5c2a11 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/MemoryUsage.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/MemoryUsage.html @@ -179,9 +179,6 @@ - @@ -513,7 +510,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Nested.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Nested.html index b8ffa0383..933ad94e1 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Nested.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Nested.html @@ -179,9 +179,6 @@ - @@ -513,7 +510,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentCategories.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentCategories.html index 0bb0a0b58..6ed5493d0 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentCategories.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentCategories.html @@ -179,9 +179,6 @@ - @@ -420,7 +417,9 @@

Declaration

Declaration

Swift

-
public init(additionalProperties: [String: JSON] = [:])
+
public init(
+    additionalProperties: [String: JSON] = [:]
+)
@@ -488,7 +487,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentEmotion.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentEmotion.html index 4de53ce36..2c9d76890 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentEmotion.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentEmotion.html @@ -179,9 +179,6 @@ - @@ -447,7 +444,10 @@

Declaration

Declaration

Swift

-
public init(document: Bool? = nil, targets: [String]? = nil)
+
public init(
+    document: Bool? = nil,
+    targets: [String]? = nil
+)
@@ -494,7 +494,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentEntities.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentEntities.html index c0c460c1b..b14047241 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentEntities.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentEntities.html @@ -179,9 +179,6 @@ - @@ -521,7 +518,8 @@

Declaration

-

When true, a list of sentence locations for each instance of each identified entity is recorded. The default is false.

+

When true, a list of sentence locations for each instance of each identified entity is recorded. The default is +false.

@@ -548,7 +546,8 @@

Declaration

-

The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge Graph en-news, or the default public model alchemy.

+

The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge Studio, the +public model for use with Knowledge Graph en-news, or the default public model alchemy.

@@ -582,7 +581,15 @@

Declaration

Declaration

Swift

-
public init(sentiment: Bool? = nil, emotion: Bool? = nil, limit: Int? = nil, mentions: Bool? = nil, mentionTypes: Bool? = nil, sentenceLocation: Bool? = nil, model: String? = nil)
+
public init(
+    sentiment: Bool? = nil,
+    emotion: Bool? = nil,
+    limit: Int? = nil,
+    mentions: Bool? = nil,
+    mentionTypes: Bool? = nil,
+    sentenceLocation: Bool? = nil,
+    model: String? = nil
+)
@@ -658,7 +665,8 @@

Parameters

-

When true, a list of sentence locations for each instance of each identified entity is recorded. The default is false.

+

When true, a list of sentence locations for each instance of each identified entity is recorded. The default is +false.

@@ -670,7 +678,8 @@

Parameters

-

The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge Graph en-news, or the default public model alchemy.

+

The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge Studio, +the public model for use with Knowledge Graph en-news, or the default public model alchemy.

@@ -689,7 +698,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentFeatures.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentFeatures.html index 816f700ba..e791806ed 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentFeatures.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentFeatures.html @@ -179,9 +179,6 @@ - @@ -582,7 +579,15 @@

Declaration

Declaration

Swift

-
public init(keywords: NluEnrichmentKeywords? = nil, entities: NluEnrichmentEntities? = nil, sentiment: NluEnrichmentSentiment? = nil, emotion: NluEnrichmentEmotion? = nil, categories: NluEnrichmentCategories? = nil, semanticRoles: NluEnrichmentSemanticRoles? = nil, relations: NluEnrichmentRelations? = nil)
+
public init(
+    keywords: NluEnrichmentKeywords? = nil,
+    entities: NluEnrichmentEntities? = nil,
+    sentiment: NluEnrichmentSentiment? = nil,
+    emotion: NluEnrichmentEmotion? = nil,
+    categories: NluEnrichmentCategories? = nil,
+    semanticRoles: NluEnrichmentSemanticRoles? = nil,
+    relations: NluEnrichmentRelations? = nil
+)
@@ -689,7 +694,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentKeywords.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentKeywords.html index 2bbf0e006..373d4808d 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentKeywords.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentKeywords.html @@ -179,9 +179,6 @@ - @@ -474,7 +471,11 @@

Declaration

Declaration

Swift

-
public init(sentiment: Bool? = nil, emotion: Bool? = nil, limit: Int? = nil)
+
public init(
+    sentiment: Bool? = nil,
+    emotion: Bool? = nil,
+    limit: Int? = nil
+)
@@ -533,7 +534,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentRelations.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentRelations.html index 01b4fed44..930a1c9a0 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentRelations.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentRelations.html @@ -179,9 +179,6 @@ - @@ -386,7 +383,9 @@

NluEnrichmentRelations

-

For use with natural_language_understanding enrichments only.* The enrichement model to use with relationship extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge Graph en-news, the default isen-news.

+

For use with natural_language_understanding enrichments only. The enrichement model to use with relationship +extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge +Graph en-news, the default isen-news.

@@ -420,7 +419,9 @@

Declaration

Declaration

Swift

-
public init(model: String? = nil)
+
public init(
+    model: String? = nil
+)
@@ -436,7 +437,9 @@

Parameters

-

For use with natural_language_understanding enrichments only. The enrichement model to use with relationship extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge Graph en-news, the default isen-news.

+

For use with natural_language_understanding enrichments only. The enrichement model to use with relationship +extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge +Graph en-news, the default isen-news.

@@ -455,7 +458,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentSemanticRoles.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentSemanticRoles.html index 59703f9aa..4eadcbfa3 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentSemanticRoles.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentSemanticRoles.html @@ -179,9 +179,6 @@ - @@ -474,7 +471,11 @@

Declaration

Declaration

Swift

-
public init(entities: Bool? = nil, keywords: Bool? = nil, limit: Int? = nil)
+
public init(
+    entities: Bool? = nil,
+    keywords: Bool? = nil,
+    limit: Int? = nil
+)
@@ -533,7 +534,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentSentiment.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentSentiment.html index 75cb62887..9db59b5a3 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentSentiment.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NluEnrichmentSentiment.html @@ -179,9 +179,6 @@ - @@ -447,7 +444,10 @@

Declaration

Declaration

Swift

-
public init(document: Bool? = nil, targets: [String]? = nil)
+
public init(
+    document: Bool? = nil,
+    targets: [String]? = nil
+)
@@ -494,7 +494,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NormalizationOperation.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NormalizationOperation.html index fff86ed01..f49285747 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NormalizationOperation.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NormalizationOperation.html @@ -179,9 +179,6 @@ - @@ -387,11 +384,22 @@

NormalizationOperation

Identifies what type of operation to perform. -copy - Copies the value of the source_field to the destination_field field. If the destination_field already exists, then the value of the source_field overwrites the original value of the destination_field. -move - Renames (moves) the source_field to the destination_field. If the destination_field already exists, then the value of the source_field overwrites the original value of the destination_field. Rename is identical to copy, except that the source_field is removed after the value has been copied to the destination_field (it is the same as a copy followed by a remove). -merge - Merges the value of the source_field with the value of the destination_field. The destination_field is converted into an array if it is not already an array, and the value of the source_field is appended to the array. This operation removes the source_field after the merge. If the source_field does not exist in the current document, then the destination_field is still converted into an array (if it is not an array already). This is ensures the type for destination_field is consistent across all documents. +copy - Copies the value of the source_field to the destination_field field. If the destination_field +already exists, then the value of the source_field overwrites the original value of the destination_field. +move - Renames (moves) the source_field to the destination_field. If the destination_field already +exists, then the value of the source_field overwrites the original value of the destination_field. Rename is +identical to copy, except that the source_field is removed after the value has been copied to the +destination_field (it is the same as a copy followed by a remove). +merge - Merges the value of the source_field with the value of the destination_field. The +destination_field is converted into an array if it is not already an array, and the value of the source_field +is appended to the array. This operation removes the source_field after the merge. If the source_field does not +exist in the current document, then the destination_field is still converted into an array (if it is not an array +already). This is ensures the type for destination_field is consistent across all documents. remove - Deletes the source_field field. The destination_field is ignored for this operation. -remove_nulls - Removes all nested null (blank) leif values from the JSON tree. source_field and destination_field are ignored by this operation because remove_nulls operates on the entire JSON tree. Typically, remove_nulls is invoked as the last normalization operation (if it is inoked at all, it can be time-expensive).

+remove_nulls - Removes all nested null (blank) leif values from the JSON tree. source_field and +destination_field are ignored by this operation because remove_nulls operates on the entire JSON tree. +Typically, remove_nulls is invoked as the last normalization operation (if it is inoked at all, it can be +time-expensive).

See more
@@ -419,7 +427,23 @@

Declaration

-

Identifies what type of operation to perform.

+

Identifies what type of operation to perform. +copy - Copies the value of the source_field to the destination_field field. If the destination_field +already exists, then the value of the source_field overwrites the original value of the destination_field. +move - Renames (moves) the source_field to the destination_field. If the destination_field already +exists, then the value of the source_field overwrites the original value of the destination_field. Rename is +identical to copy, except that the source_field is removed after the value has been copied to the +destination_field (it is the same as a copy followed by a remove). +merge - Merges the value of the source_field with the value of the destination_field. The +destination_field is converted into an array if it is not already an array, and the value of the source_field +is appended to the array. This operation removes the source_field after the merge. If the source_field does not +exist in the current document, then the destination_field is still converted into an array (if it is not an array +already). This is ensures the type for destination_field is consistent across all documents. +remove - Deletes the source_field field. The destination_field is ignored for this operation. +remove_nulls - Removes all nested null (blank) leif values from the JSON tree. source_field and +destination_field are ignored by this operation because remove_nulls operates on the entire JSON tree. +Typically, remove_nulls is invoked as the last normalization operation (if it is inoked at all, it can be +time-expensive).

@@ -507,7 +531,11 @@

Declaration

Declaration

Swift

-
public init(operation: String? = nil, sourceField: String? = nil, destinationField: String? = nil)
+
public init(
+    operation: String? = nil,
+    sourceField: String? = nil,
+    destinationField: String? = nil
+)
@@ -523,7 +551,23 @@

Parameters

-

Identifies what type of operation to perform.

+

Identifies what type of operation to perform. +copy - Copies the value of the source_field to the destination_field field. If the destination_field +already exists, then the value of the source_field overwrites the original value of the destination_field. +move - Renames (moves) the source_field to the destination_field. If the destination_field already +exists, then the value of the source_field overwrites the original value of the destination_field. Rename is +identical to copy, except that the source_field is removed after the value has been copied to the +destination_field (it is the same as a copy followed by a remove). +merge - Merges the value of the source_field with the value of the destination_field. The +destination_field is converted into an array if it is not already an array, and the value of the source_field +is appended to the array. This operation removes the source_field after the merge. If the source_field does +not exist in the current document, then the destination_field is still converted into an array (if it is not an +array already). This is ensures the type for destination_field is consistent across all documents. +remove - Deletes the source_field field. The destination_field is ignored for this operation. +remove_nulls - Removes all nested null (blank) leif values from the JSON tree. source_field and +destination_field are ignored by this operation because remove_nulls operates on the entire JSON tree. +Typically, remove_nulls is invoked as the last normalization operation (if it is inoked at all, it can be +time-expensive).

@@ -566,7 +610,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NormalizationOperation/Operation.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NormalizationOperation/Operation.html index 752a520f9..a21e0bc67 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NormalizationOperation/Operation.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/NormalizationOperation/Operation.html @@ -179,9 +179,6 @@ - @@ -368,11 +365,22 @@

Operation

Identifies what type of operation to perform. -copy - Copies the value of the source_field to the destination_field field. If the destination_field already exists, then the value of the source_field overwrites the original value of the destination_field. -move - Renames (moves) the source_field to the destination_field. If the destination_field already exists, then the value of the source_field overwrites the original value of the destination_field. Rename is identical to copy, except that the source_field is removed after the value has been copied to the destination_field (it is the same as a copy followed by a remove). -merge - Merges the value of the source_field with the value of the destination_field. The destination_field is converted into an array if it is not already an array, and the value of the source_field is appended to the array. This operation removes the source_field after the merge. If the source_field does not exist in the current document, then the destination_field is still converted into an array (if it is not an array already). This is ensures the type for destination_field is consistent across all documents. +copy - Copies the value of the source_field to the destination_field field. If the destination_field +already exists, then the value of the source_field overwrites the original value of the destination_field. +move - Renames (moves) the source_field to the destination_field. If the destination_field already +exists, then the value of the source_field overwrites the original value of the destination_field. Rename is +identical to copy, except that the source_field is removed after the value has been copied to the +destination_field (it is the same as a copy followed by a remove). +merge - Merges the value of the source_field with the value of the destination_field. The +destination_field is converted into an array if it is not already an array, and the value of the source_field +is appended to the array. This operation removes the source_field after the merge. If the source_field does not +exist in the current document, then the destination_field is still converted into an array (if it is not an array +already). This is ensures the type for destination_field is consistent across all documents. remove - Deletes the source_field field. The destination_field is ignored for this operation. -remove_nulls - Removes all nested null (blank) leif values from the JSON tree. source_field and destination_field are ignored by this operation because remove_nulls operates on the entire JSON tree. Typically, remove_nulls is invoked as the last normalization operation (if it is inoked at all, it can be time-expensive).

+remove_nulls - Removes all nested null (blank) leif values from the JSON tree. source_field and +destination_field are ignored by this operation because remove_nulls operates on the entire JSON tree. +Typically, remove_nulls is invoked as the last normalization operation (if it is inoked at all, it can be +time-expensive).

@@ -518,7 +526,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Notice.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Notice.html index 680b09355..a424a6476 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Notice.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Notice.html @@ -179,9 +179,6 @@ - @@ -414,7 +411,8 @@

Declaration

-

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.

+

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.

@@ -595,7 +593,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Notice/Severity.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Notice/Severity.html index dbe0659e9..a7202cc72 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Notice/Severity.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Notice/Severity.html @@ -179,9 +179,6 @@ - @@ -432,7 +429,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/PdfHeadingDetection.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/PdfHeadingDetection.html index 92fb95e54..26ff41750 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/PdfHeadingDetection.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/PdfHeadingDetection.html @@ -179,9 +179,6 @@ - @@ -420,7 +417,9 @@

Declaration

Declaration

Swift

-
public init(fonts: [FontSetting]? = nil)
+
public init(
+    fonts: [FontSetting]? = nil
+)
@@ -455,7 +454,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/PdfSettings.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/PdfSettings.html index 281357896..246a2b6a6 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/PdfSettings.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/PdfSettings.html @@ -179,9 +179,6 @@ - @@ -420,7 +417,9 @@

Declaration

Declaration

Swift

-
public init(heading: PdfHeadingDetection? = nil)
+
public init(
+    heading: PdfHeadingDetection? = nil
+)
@@ -455,7 +454,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEntities.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEntities.html index d10a5094f..c89e2c7a9 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEntities.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEntities.html @@ -179,9 +179,6 @@ - @@ -440,7 +437,8 @@

Declaration

-

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

+

Entity text to provide context for the queried entity and rank based on that association. For example, if you +wanted to query the city of London in England your query would look for London with the context of England.

@@ -494,7 +492,8 @@

Declaration

-

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items per query is 10,000.

+

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items +per query is 10,000.

@@ -528,7 +527,13 @@

Declaration

Declaration

Swift

-
public init(feature: String? = nil, entity: QueryEntitiesEntity? = nil, context: QueryEntitiesContext? = nil, count: Int? = nil, evidenceCount: Int? = nil)
+
public init(
+    feature: String? = nil,
+    entity: QueryEntitiesEntity? = nil,
+    context: QueryEntitiesContext? = nil,
+    count: Int? = nil,
+    evidenceCount: Int? = nil
+)
@@ -568,7 +573,8 @@

Parameters

-

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

+

Entity text to provide context for the queried entity and rank based on that association. For example, if you +wanted to query the city of London in England your query would look for London with the context of England.

@@ -592,7 +598,8 @@

Parameters

-

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items per query is 10,000.

+

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items +per query is 10,000.

@@ -611,7 +618,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEntitiesContext.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEntitiesContext.html index 69df677d3..3134691e2 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEntitiesContext.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEntitiesContext.html @@ -179,9 +179,6 @@ - @@ -386,7 +383,8 @@

QueryEntitiesContext

-

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

+

Entity text to provide context for the queried entity and rank based on that association. For example, if you +wanted to query the city of London in England your query would look for London with the context of England.

@@ -420,7 +418,9 @@

Declaration

Declaration

Swift

-
public init(text: String? = nil)
+
public init(
+    text: String? = nil
+)
@@ -436,7 +436,8 @@

Parameters

-

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

+

Entity text to provide context for the queried entity and rank based on that association. For example, if you +wanted to query the city of London in England your query would look for London with the context of England.

@@ -455,7 +456,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEntitiesEntity.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEntitiesEntity.html index 7b38caa5d..5aed4a642 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEntitiesEntity.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEntitiesEntity.html @@ -179,9 +179,6 @@ - @@ -447,7 +444,10 @@

Declaration

Declaration

Swift

-
public init(text: String? = nil, type: String? = nil)
+
public init(
+    text: String? = nil,
+    type: String? = nil
+)
@@ -494,7 +494,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEntitiesResponse.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEntitiesResponse.html index 53264dda5..16ab73810 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEntitiesResponse.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEntitiesResponse.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEntitiesResponseItem.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEntitiesResponseItem.html index af4306477..6d91e9c3a 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEntitiesResponseItem.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEntitiesResponseItem.html @@ -179,9 +179,6 @@ - @@ -459,7 +456,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEvidence.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEvidence.html index 4050b0bc8..f1bd50c97 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEvidence.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEvidence.html @@ -179,9 +179,6 @@ - @@ -513,7 +510,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEvidenceEntity.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEvidenceEntity.html index 6ba44a2b1..70ab0f1fa 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEvidenceEntity.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryEvidenceEntity.html @@ -179,9 +179,6 @@ - @@ -486,7 +483,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryFilterType.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryFilterType.html index db46e167c..96d9c9c65 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryFilterType.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryFilterType.html @@ -179,9 +179,6 @@ - @@ -447,7 +444,10 @@

Declaration

Declaration

Swift

-
public init(exclude: [String]? = nil, include: [String]? = nil)
+
public init(
+    exclude: [String]? = nil,
+    include: [String]? = nil
+)
@@ -494,7 +494,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryNoticesResponse.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryNoticesResponse.html index ff28f99fd..0b891113c 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryNoticesResponse.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryNoticesResponse.html @@ -179,9 +179,6 @@ - @@ -513,7 +510,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryNoticesResult.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryNoticesResult.html index f002c52c3..48864704d 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryNoticesResult.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryNoticesResult.html @@ -179,9 +179,6 @@ - @@ -549,7 +546,8 @@

Declaration

-

The internal status code returned by the ingestion subsystem indicating the overall result of ingesting the source document.

+

The internal status code returned by the ingestion subsystem indicating the overall result of ingesting the source +document.

@@ -729,7 +727,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryNoticesResult/FileType.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryNoticesResult/FileType.html index 52ebb6550..1428919e0 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryNoticesResult/FileType.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryNoticesResult/FileType.html @@ -179,9 +179,6 @@ - @@ -486,7 +483,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryPassages.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryPassages.html index 840827b42..b67914f1d 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryPassages.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryPassages.html @@ -179,9 +179,6 @@ - @@ -540,7 +537,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelations.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelations.html index 2c2f2a08c..4e779baf7 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelations.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelations.html @@ -179,9 +179,6 @@ - @@ -386,7 +383,8 @@

QueryRelations

-

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times each entity is identified. The default is score.

+

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times +each entity is identified. The default is score.

See more
@@ -441,7 +439,8 @@

Declaration

-

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

+

Entity text to provide context for the queried entity and rank based on that association. For example, if you +wanted to query the city of London in England your query would look for London with the context of England.

@@ -468,7 +467,8 @@

Declaration

-

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times each entity is identified. The default is score.

+

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times +each entity is identified. The default is score.

@@ -549,7 +549,8 @@

Declaration

-

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items per query is 10,000.

+

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items +per query is 10,000.

@@ -583,7 +584,14 @@

Declaration

Declaration

Swift

-
public init(entities: [QueryRelationsEntity]? = nil, context: QueryEntitiesContext? = nil, sort: String? = nil, filter: QueryRelationsFilter? = nil, count: Int? = nil, evidenceCount: Int? = nil)
+
public init(
+    entities: [QueryRelationsEntity]? = nil,
+    context: QueryEntitiesContext? = nil,
+    sort: String? = nil,
+    filter: QueryRelationsFilter? = nil,
+    count: Int? = nil,
+    evidenceCount: Int? = nil
+)
@@ -611,7 +619,8 @@

Parameters

-

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

+

Entity text to provide context for the queried entity and rank based on that association. For example, if you +wanted to query the city of London in England your query would look for London with the context of England.

@@ -623,7 +632,8 @@

Parameters

-

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times each entity is identified. The default is score.

+

The sorting method for the relationships, can be score or frequency. frequency is the number of unique +times each entity is identified. The default is score.

@@ -659,7 +669,8 @@

Parameters

-

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items per query is 10,000.

+

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items +per query is 10,000.

@@ -678,7 +689,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelations/Sort.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelations/Sort.html index ec10bc123..9e710633c 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelations/Sort.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelations/Sort.html @@ -179,9 +179,6 @@ - @@ -367,7 +364,8 @@

Sort

-

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times each entity is identified. The default is score.

+

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times +each entity is identified. The default is score.

@@ -432,7 +430,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelationsArgument.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelationsArgument.html index 50799b1c8..7ecbc6b7c 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelationsArgument.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelationsArgument.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelationsEntity.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelationsEntity.html index 66f8ab468..d1042ab22 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelationsEntity.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelationsEntity.html @@ -179,9 +179,6 @@ - @@ -474,7 +471,11 @@

Declaration

Declaration

Swift

-
public init(text: String? = nil, type: String? = nil, exact: Bool? = nil)
+
public init(
+    text: String? = nil,
+    type: String? = nil,
+    exact: Bool? = nil
+)
@@ -533,7 +534,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelationsFilter.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelationsFilter.html index 7c87c53f5..b27565ee3 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelationsFilter.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelationsFilter.html @@ -179,9 +179,6 @@ - @@ -474,7 +471,11 @@

Declaration

Declaration

Swift

-
public init(relationTypes: QueryFilterType? = nil, entityTypes: QueryFilterType? = nil, documentIds: [String]? = nil)
+
public init(
+    relationTypes: QueryFilterType? = nil,
+    entityTypes: QueryFilterType? = nil,
+    documentIds: [String]? = nil
+)
@@ -533,7 +534,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelationsRelationship.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelationsRelationship.html index 8736906e0..88adf0f15 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelationsRelationship.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelationsRelationship.html @@ -179,9 +179,6 @@ - @@ -486,7 +483,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelationsResponse.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelationsResponse.html index ddc451018..be21eb529 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelationsResponse.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryRelationsResponse.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryResponse.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryResponse.html index da4967ece..385b52a81 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryResponse.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryResponse.html @@ -179,9 +179,6 @@ - @@ -513,7 +510,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryResult.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryResult.html index f0b70f40f..d0c693842 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryResult.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryResult.html @@ -179,9 +179,6 @@ - @@ -566,7 +563,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryResultMetadata.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryResultMetadata.html index 949f6808b..cf5f46cca 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryResultMetadata.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/QueryResultMetadata.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/SegmentSettings.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/SegmentSettings.html index 9e943b112..201479b2d 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/SegmentSettings.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/SegmentSettings.html @@ -179,9 +179,6 @@ - @@ -447,7 +444,10 @@

Declaration

Declaration

Swift

-
public init(enabled: Bool? = nil, selectorTags: [String]? = nil)
+
public init(
+    enabled: Bool? = nil,
+    selectorTags: [String]? = nil
+)
@@ -494,7 +494,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Term.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Term.html index 04e9e8195..e727a5fa4 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Term.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Term.html @@ -179,9 +179,6 @@ - @@ -540,7 +537,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TestDocument.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TestDocument.html index b2f0497cb..47bcb0613 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TestDocument.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TestDocument.html @@ -179,9 +179,6 @@ - @@ -440,7 +437,8 @@

Declaration

-

The number of 10-kB chunks of field data that were enriched. This can be used to estimate the cost of running a real ingestion.

+

The number of 10-kB chunks of field data that were enriched. This can be used to estimate the cost of running a +real ingestion.

@@ -540,7 +538,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Timeslice.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Timeslice.html index f6e191c4a..2345fbfa0 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Timeslice.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/Timeslice.html @@ -179,9 +179,6 @@ - @@ -521,7 +518,8 @@

Declaration

-

Interval of the aggregation. Valid date interval values are second/seconds minute/minutes, hour/hours, day/days, week/weeks, month/months, and year/years.

+

Interval of the aggregation. Valid date interval values are second/seconds minute/minutes, hour/hours, day/days, +week/weeks, month/months, and year/years.

@@ -548,7 +546,8 @@

Declaration

-

Used to inducate that anomaly detection should be performed. Anomaly detection is used to locate unusual datapoints within a time series.

+

Used to inducate that anomaly detection should be performed. Anomaly detection is used to locate unusual datapoints +within a time series.

@@ -567,7 +566,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TopHits.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TopHits.html index 226bd5b35..a98904ad5 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TopHits.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TopHits.html @@ -179,9 +179,6 @@ - @@ -540,7 +537,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TopHitsResults.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TopHitsResults.html index c51177bf1..592a90108 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TopHitsResults.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TopHitsResults.html @@ -179,9 +179,6 @@ - @@ -432,7 +429,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TrainingDataSet.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TrainingDataSet.html index 089dae03c..6b2addf82 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TrainingDataSet.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TrainingDataSet.html @@ -179,9 +179,6 @@ - @@ -459,7 +456,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TrainingExample.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TrainingExample.html index 6b649383e..1e004eafd 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TrainingExample.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TrainingExample.html @@ -179,9 +179,6 @@ - @@ -474,7 +471,11 @@

Declaration

Declaration

Swift

-
public init(documentID: String? = nil, crossReference: String? = nil, relevance: Int? = nil)
+
public init(
+    documentID: String? = nil,
+    crossReference: String? = nil,
+    relevance: Int? = nil
+)
@@ -533,7 +534,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TrainingExampleList.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TrainingExampleList.html index 1e06885fd..2e4737549 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TrainingExampleList.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TrainingExampleList.html @@ -179,9 +179,6 @@ - @@ -405,7 +402,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TrainingQuery.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TrainingQuery.html index 2af6ce3d4..f2a746ffd 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TrainingQuery.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TrainingQuery.html @@ -179,9 +179,6 @@ - @@ -486,7 +483,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TrainingStatus.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TrainingStatus.html index 4126c13f8..76654d8a9 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TrainingStatus.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/TrainingStatus.html @@ -179,9 +179,6 @@ - @@ -621,7 +618,7 @@

Declaration

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/WordHeadingDetection.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/WordHeadingDetection.html index 3cb26d067..14d7d80dd 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/WordHeadingDetection.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/WordHeadingDetection.html @@ -179,9 +179,6 @@ - @@ -447,7 +444,10 @@

Declaration

Declaration

Swift

-
public init(fonts: [FontSetting]? = nil, styles: [WordStyle]? = nil)
+
public init(
+    fonts: [FontSetting]? = nil,
+    styles: [WordStyle]? = nil
+)
@@ -494,7 +494,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/WordSettings.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/WordSettings.html index f67a5268f..51352e05b 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/WordSettings.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/WordSettings.html @@ -179,9 +179,6 @@ - @@ -420,7 +417,9 @@

Declaration

Declaration

Swift

-
public init(heading: WordHeadingDetection? = nil)
+
public init(
+    heading: WordHeadingDetection? = nil
+)
@@ -455,7 +454,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/WordStyle.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/WordStyle.html index aeea62f07..567159239 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/WordStyle.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/WordStyle.html @@ -179,9 +179,6 @@ - @@ -447,7 +444,10 @@

Declaration

Declaration

Swift

-
public init(level: Int? = nil, names: [String]? = nil)
+
public init(
+    level: Int? = nil,
+    names: [String]? = nil
+)
@@ -494,7 +494,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/XPathPatterns.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/XPathPatterns.html index a05ea9e9c..650088213 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/XPathPatterns.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/Structs/XPathPatterns.html @@ -179,9 +179,6 @@ - @@ -420,7 +417,9 @@

Declaration

Declaration

Swift

-
public init(xpaths: [String]? = nil)
+
public init(
+    xpaths: [String]? = nil
+)
@@ -455,7 +454,7 @@

Return Value

diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/index.html b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/index.html index 8a73a27de..802a67864 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/index.html +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/index.html @@ -178,9 +178,6 @@ - @@ -400,7 +397,8 @@

Services

  • Assistant
  • Discovery
  • -
  • Language Translator
  • +
  • Language Translator V2
  • +
  • Language Translator V3
  • Natural Language Classifier
  • Natural Language Understanding
  • Personality Insights
  • @@ -445,7 +443,7 @@

    Swift Package Manager

    Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

    dependencies: [
    -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
    +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
     ]
     

    Service Instances

    @@ -488,7 +486,7 @@

    Username and Password

    API Key

    -

    Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

    +

    Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

    let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
     

    Using IAM

    @@ -723,7 +721,12 @@

    Private Data Collections

  • IBM Discovery - Documentation
  • IBM Discovery - Demo
-

Language Translator

+

Language Translator V2

+ +

Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

@@ -734,6 +737,25 @@

Language Translator

let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} + +

Language Translator V3

+ +

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

+ +

The following example demonstrates how to use the Language Translator service:

+
import LanguageTranslatorV3
+
+let username = "your-username-here"
+let password = "your-password-here"
+let version = "yyyy-mm-dd" // use today's date for the most recent version
+let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
+
 let failure = { (error: Error) in print(error) }
 let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
 languageTranslator.translate(request: request, failure: failure) {
@@ -1124,7 +1146,7 @@ 

Visual Recognition

let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -1132,6 +1154,10 @@

Visual Recognition

print(classifiedImages) }
+ +

Note: a different initializer is used for authentication with instances created before May 23, 2018:

+
let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
+

Using Core ML

The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

@@ -1183,7 +1209,7 @@

Bundlin diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/search.json b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/search.json index 5d36cb42a..e7f878f4a 100644 --- a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/search.json +++ b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/Documents/search.json @@ -1 +1 @@ -{"Structs/XPathPatterns.html#/s:11DiscoveryV113XPathPatternsV6xpathsSaySSGSgvp":{"name":"xpaths","abstract":"

Undocumented

","parent_name":"XPathPatterns"},"Structs/XPathPatterns.html#/s:11DiscoveryV113XPathPatternsVACSaySSGSg6xpaths_tcfc":{"name":"init(xpaths:)","abstract":"

Initialize a XPathPatterns with member variables.

","parent_name":"XPathPatterns"},"Structs/WordStyle.html#/s:11DiscoveryV19WordStyleV5levelSiSgvp":{"name":"level","abstract":"

Undocumented

","parent_name":"WordStyle"},"Structs/WordStyle.html#/s:11DiscoveryV19WordStyleV5namesSaySSGSgvp":{"name":"names","abstract":"

Undocumented

","parent_name":"WordStyle"},"Structs/WordStyle.html#/s:11DiscoveryV19WordStyleVACSiSg5level_SaySSGSg5namestcfc":{"name":"init(level:names:)","abstract":"

Initialize a WordStyle with member variables.

","parent_name":"WordStyle"},"Structs/WordSettings.html#/s:11DiscoveryV112WordSettingsV7headingAA0C16HeadingDetectionVSgvp":{"name":"heading","abstract":"

Undocumented

","parent_name":"WordSettings"},"Structs/WordSettings.html#/s:11DiscoveryV112WordSettingsVAcA0C16HeadingDetectionVSg7heading_tcfc":{"name":"init(heading:)","abstract":"

Initialize a WordSettings with member variables.

","parent_name":"WordSettings"},"Structs/WordHeadingDetection.html#/s:11DiscoveryV120WordHeadingDetectionV5fontsSayAA11FontSettingVGSgvp":{"name":"fonts","abstract":"

Undocumented

","parent_name":"WordHeadingDetection"},"Structs/WordHeadingDetection.html#/s:11DiscoveryV120WordHeadingDetectionV6stylesSayAA0C5StyleVGSgvp":{"name":"styles","abstract":"

Undocumented

","parent_name":"WordHeadingDetection"},"Structs/WordHeadingDetection.html#/s:11DiscoveryV120WordHeadingDetectionVACSayAA11FontSettingVGSg5fonts_SayAA0C5StyleVGSg6stylestcfc":{"name":"init(fonts:styles:)","abstract":"

Initialize a WordHeadingDetection with member variables.

","parent_name":"WordHeadingDetection"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV13totalExamplesSiSgvp":{"name":"totalExamples","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV9availableSbSgvp":{"name":"available","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV10processingSbSgvp":{"name":"processing","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV19minimumQueriesAddedSbSgvp":{"name":"minimumQueriesAdded","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV20minimumExamplesAddedSbSgvp":{"name":"minimumExamplesAdded","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV24sufficientLabelDiversitySbSgvp":{"name":"sufficientLabelDiversity","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV7noticesSiSgvp":{"name":"notices","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV19successfullyTrainedSSSgvp":{"name":"successfullyTrained","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV11dataUpdatedSSSgvp":{"name":"dataUpdated","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingQuery.html#/s:11DiscoveryV113TrainingQueryV7queryIDSSSgvp":{"name":"queryID","abstract":"

Undocumented

","parent_name":"TrainingQuery"},"Structs/TrainingQuery.html#/s:11DiscoveryV113TrainingQueryV015naturalLanguageD0SSSgvp":{"name":"naturalLanguageQuery","abstract":"

Undocumented

","parent_name":"TrainingQuery"},"Structs/TrainingQuery.html#/s:11DiscoveryV113TrainingQueryV6filterSSSgvp":{"name":"filter","abstract":"

Undocumented

","parent_name":"TrainingQuery"},"Structs/TrainingQuery.html#/s:11DiscoveryV113TrainingQueryV8examplesSayAA0C7ExampleVGSgvp":{"name":"examples","abstract":"

Undocumented

","parent_name":"TrainingQuery"},"Structs/TrainingExampleList.html#/s:11DiscoveryV119TrainingExampleListV8examplesSayAA0cD0VGSgvp":{"name":"examples","abstract":"

Undocumented

","parent_name":"TrainingExampleList"},"Structs/TrainingExample.html#/s:11DiscoveryV115TrainingExampleV10documentIDSSSgvp":{"name":"documentID","abstract":"

Undocumented

","parent_name":"TrainingExample"},"Structs/TrainingExample.html#/s:11DiscoveryV115TrainingExampleV14crossReferenceSSSgvp":{"name":"crossReference","abstract":"

Undocumented

","parent_name":"TrainingExample"},"Structs/TrainingExample.html#/s:11DiscoveryV115TrainingExampleV9relevanceSiSgvp":{"name":"relevance","abstract":"

Undocumented

","parent_name":"TrainingExample"},"Structs/TrainingExample.html#/s:11DiscoveryV115TrainingExampleVACSSSg10documentID_AD14crossReferenceSiSg9relevancetcfc":{"name":"init(documentID:crossReference:relevance:)","abstract":"

Initialize a TrainingExample with member variables.

","parent_name":"TrainingExample"},"Structs/TrainingDataSet.html#/s:11DiscoveryV115TrainingDataSetV13environmentIDSSSgvp":{"name":"environmentID","abstract":"

Undocumented

","parent_name":"TrainingDataSet"},"Structs/TrainingDataSet.html#/s:11DiscoveryV115TrainingDataSetV12collectionIDSSSgvp":{"name":"collectionID","abstract":"

Undocumented

","parent_name":"TrainingDataSet"},"Structs/TrainingDataSet.html#/s:11DiscoveryV115TrainingDataSetV7queriesSayAA0C5QueryVGSgvp":{"name":"queries","abstract":"

Undocumented

","parent_name":"TrainingDataSet"},"Structs/TopHitsResults.html#/s:11DiscoveryV114TopHitsResultsV08matchingE0SiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"TopHitsResults"},"Structs/TopHitsResults.html#/s:11DiscoveryV114TopHitsResultsV4hitsSayAA11QueryResultVGSgvp":{"name":"hits","abstract":"

Top results returned by the aggregation.

","parent_name":"TopHitsResults"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"TopHits"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"TopHits"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"TopHits"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"TopHits"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV4sizeSiSgvp":{"name":"size","abstract":"

Number of top hits returned by the aggregation.

","parent_name":"TopHits"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV4hitsAA0cD7ResultsVSgvp":{"name":"hits","abstract":"

Undocumented

","parent_name":"TopHits"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV5fieldSSSgvp":{"name":"field","abstract":"

The field where the aggregation is located in the document.

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV8intervalSSSgvp":{"name":"interval","abstract":"

Interval of the aggregation. Valid date interval values are second/seconds minute/minutes, hour/hours, day/days, week/weeks, month/months, and year/years.

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV7anomalySbSgvp":{"name":"anomaly","abstract":"

Used to inducate that anomaly detection should be performed. Anomaly detection is used to locate unusual datapoints within a time series.

","parent_name":"Timeslice"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV15configurationIDSSSgvp":{"name":"configurationID","abstract":"

The unique identifier for the configuration.

","parent_name":"TestDocument"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV6statusSSSgvp":{"name":"status","abstract":"

Status of the preview operation.

","parent_name":"TestDocument"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV18enrichedFieldUnitsSiSgvp":{"name":"enrichedFieldUnits","abstract":"

The number of 10-kB chunks of field data that were enriched. This can be used to estimate the cost of running a real ingestion.

","parent_name":"TestDocument"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV17originalMediaTypeSSSgvp":{"name":"originalMediaType","abstract":"

Format of the test document.

","parent_name":"TestDocument"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV9snapshotsSayAA0D8SnapshotVGSgvp":{"name":"snapshots","abstract":"

An array of objects that describe each step in the preview process.

","parent_name":"TestDocument"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV7noticesSayAA6NoticeVGSgvp":{"name":"notices","abstract":"

An array of notice messages about the preview operation.

","parent_name":"TestDocument"},"Structs/Term.html#/s:11DiscoveryV14TermV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Term"},"Structs/Term.html#/s:11DiscoveryV14TermV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Term"},"Structs/Term.html#/s:11DiscoveryV14TermV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Term"},"Structs/Term.html#/s:11DiscoveryV14TermV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Term"},"Structs/Term.html#/s:11DiscoveryV14TermV5fieldSSSgvp":{"name":"field","abstract":"

The field where the aggregation is located in the document.

","parent_name":"Term"},"Structs/Term.html#/s:11DiscoveryV14TermV5countSiSgvp":{"name":"count","abstract":"

Undocumented

","parent_name":"Term"},"Structs/SegmentSettings.html#/s:11DiscoveryV115SegmentSettingsV7enabledSbSgvp":{"name":"enabled","abstract":"

Enables/disables the Document Segmentation feature.

","parent_name":"SegmentSettings"},"Structs/SegmentSettings.html#/s:11DiscoveryV115SegmentSettingsV12selectorTagsSaySSGSgvp":{"name":"selectorTags","abstract":"

Defines the heading level that splits into document segments. Valid values are h1, h2, h3, h4, h5, h6.

","parent_name":"SegmentSettings"},"Structs/SegmentSettings.html#/s:11DiscoveryV115SegmentSettingsVACSbSg7enabled_SaySSGSg12selectorTagstcfc":{"name":"init(enabled:selectorTags:)","abstract":"

Initialize a SegmentSettings with member variables.

","parent_name":"SegmentSettings"},"Structs/QueryResultMetadata.html#/s:11DiscoveryV119QueryResultMetadataV5scoreSdSgvp":{"name":"score","abstract":"

The confidence score of the result’s analysis. A higher score indicating greater confidence.

","parent_name":"QueryResultMetadata"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV2idSSSgvp":{"name":"id","abstract":"

The unique identifier of the document.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV5scoreSdSgvp":{"name":"score","abstract":"

Deprecated* This field is now part of the result_metadata object.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Metadata of the document.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV12collectionIDSSSgvp":{"name":"collectionID","abstract":"

The collection ID of the collection containing the document for this result.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV14resultMetadataAA0cdF0VSgvp":{"name":"resultMetadata","abstract":"

Metadata of the query result.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"QueryResult"},"Structs/QueryResponse.html#/s:11DiscoveryV113QueryResponseV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Undocumented

","parent_name":"QueryResponse"},"Structs/QueryResponse.html#/s:11DiscoveryV113QueryResponseV7resultsSayAA0C6ResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"QueryResponse"},"Structs/QueryResponse.html#/s:11DiscoveryV113QueryResponseV12aggregationsSayAA0C11AggregationOGSgvp":{"name":"aggregations","abstract":"

Undocumented

","parent_name":"QueryResponse"},"Structs/QueryResponse.html#/s:11DiscoveryV113QueryResponseV8passagesSayAA0C8PassagesVGSgvp":{"name":"passages","abstract":"

Undocumented

","parent_name":"QueryResponse"},"Structs/QueryResponse.html#/s:11DiscoveryV113QueryResponseV17duplicatesRemovedSiSgvp":{"name":"duplicatesRemoved","abstract":"

Undocumented

","parent_name":"QueryResponse"},"Structs/QueryRelationsResponse.html#/s:11DiscoveryV122QueryRelationsResponseV9relationsSayAA0cD12RelationshipVGSgvp":{"name":"relations","abstract":"

Undocumented

","parent_name":"QueryRelationsResponse"},"Structs/QueryRelationsRelationship.html#/s:11DiscoveryV126QueryRelationsRelationshipV4typeSSSgvp":{"name":"type","abstract":"

The identified relationship type.

","parent_name":"QueryRelationsRelationship"},"Structs/QueryRelationsRelationship.html#/s:11DiscoveryV126QueryRelationsRelationshipV9frequencySiSgvp":{"name":"frequency","abstract":"

The number of times the relationship is mentioned.

","parent_name":"QueryRelationsRelationship"},"Structs/QueryRelationsRelationship.html#/s:11DiscoveryV126QueryRelationsRelationshipV9argumentsSayAA0cD8ArgumentVGSgvp":{"name":"arguments","abstract":"

Information about the relationship.

","parent_name":"QueryRelationsRelationship"},"Structs/QueryRelationsRelationship.html#/s:11DiscoveryV126QueryRelationsRelationshipV8evidenceSayAA0C8EvidenceVGSgvp":{"name":"evidence","abstract":"

List of different evidentiary items to support the result.

","parent_name":"QueryRelationsRelationship"},"Structs/QueryRelationsFilter.html#/s:11DiscoveryV120QueryRelationsFilterV13relationTypesAA0cE4TypeVSgvp":{"name":"relationTypes","abstract":"

A list of relation types to include or exclude from the query.

","parent_name":"QueryRelationsFilter"},"Structs/QueryRelationsFilter.html#/s:11DiscoveryV120QueryRelationsFilterV11entityTypesAA0cE4TypeVSgvp":{"name":"entityTypes","abstract":"

A list of entity types to include or exclude from the query.

","parent_name":"QueryRelationsFilter"},"Structs/QueryRelationsFilter.html#/s:11DiscoveryV120QueryRelationsFilterV11documentIdsSaySSGSgvp":{"name":"documentIds","abstract":"

A comma-separated list of document IDs to include in the query.

","parent_name":"QueryRelationsFilter"},"Structs/QueryRelationsFilter.html#/s:11DiscoveryV120QueryRelationsFilterVAcA0cE4TypeVSg13relationTypes_AF06entityH0SaySSGSg11documentIdstcfc":{"name":"init(relationTypes:entityTypes:documentIds:)","abstract":"

Initialize a QueryRelationsFilter with member variables.

","parent_name":"QueryRelationsFilter"},"Structs/QueryRelationsEntity.html#/s:11DiscoveryV120QueryRelationsEntityV4textSSSgvp":{"name":"text","abstract":"

Entity text content.

","parent_name":"QueryRelationsEntity"},"Structs/QueryRelationsEntity.html#/s:11DiscoveryV120QueryRelationsEntityV4typeSSSgvp":{"name":"type","abstract":"

The type of the specified entity.

","parent_name":"QueryRelationsEntity"},"Structs/QueryRelationsEntity.html#/s:11DiscoveryV120QueryRelationsEntityV5exactSbSgvp":{"name":"exact","abstract":"

If false, implicit querying is performed. The default is false.

","parent_name":"QueryRelationsEntity"},"Structs/QueryRelationsEntity.html#/s:11DiscoveryV120QueryRelationsEntityVACSSSg4text_AD4typeSbSg5exacttcfc":{"name":"init(text:type:exact:)","abstract":"

Initialize a QueryRelationsEntity with member variables.

","parent_name":"QueryRelationsEntity"},"Structs/QueryRelationsArgument.html#/s:11DiscoveryV122QueryRelationsArgumentV8entitiesSayAA0C14EntitiesEntityVGSgvp":{"name":"entities","abstract":"

Undocumented

","parent_name":"QueryRelationsArgument"},"Structs/QueryRelations/Sort.html#/s:11DiscoveryV114QueryRelationsV4SortO5scoreA2EmF":{"name":"score","abstract":"

Undocumented

","parent_name":"Sort"},"Structs/QueryRelations/Sort.html#/s:11DiscoveryV114QueryRelationsV4SortO9frequencyA2EmF":{"name":"frequency","abstract":"

Undocumented

","parent_name":"Sort"},"Structs/QueryRelations/Sort.html":{"name":"Sort","abstract":"

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times each entity is identified. The default is score.

","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV8entitiesSayAA0cD6EntityVGSgvp":{"name":"entities","abstract":"

An array of entities to find relationships for.

","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV7contextAA0C15EntitiesContextVSgvp":{"name":"context","abstract":"

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV4sortSSSgvp":{"name":"sort","abstract":"

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times each entity is identified. The default is score.

","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV6filterAA0cD6FilterVSgvp":{"name":"filter","abstract":"

Filters to apply to the relationship query.

","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV5countSiSgvp":{"name":"count","abstract":"

The number of results to return. The default is 10. The maximum is 1000.

","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV13evidenceCountSiSgvp":{"name":"evidenceCount","abstract":"

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items per query is 10,000.

","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsVACSayAA0cD6EntityVGSg8entities_AA0C15EntitiesContextVSg7contextSSSg4sortAA0cD6FilterVSg6filterSiSg5countAS13evidenceCounttcfc":{"name":"init(entities:context:sort:filter:count:evidenceCount:)","abstract":"

Initialize a QueryRelations with member variables.

","parent_name":"QueryRelations"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV10documentIDSSSgvp":{"name":"documentID","abstract":"

The unique identifier of the document from which the passage has been extracted.

","parent_name":"QueryPassages"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV12passageScoreSdSgvp":{"name":"passageScore","abstract":"

The confidence score of the passages’s analysis. A higher score indicates greater confidence.

","parent_name":"QueryPassages"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV11passageTextSSSgvp":{"name":"passageText","abstract":"

The content of the extracted passage.

","parent_name":"QueryPassages"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV11startOffsetSiSgvp":{"name":"startOffset","abstract":"

The position of the first character of the extracted passage in the originating field.

","parent_name":"QueryPassages"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV9endOffsetSiSgvp":{"name":"endOffset","abstract":"

The position of the last character of the extracted passage in the originating field.

","parent_name":"QueryPassages"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV5fieldSSSgvp":{"name":"field","abstract":"

The label of the field from which the passage has been extracted.

","parent_name":"QueryPassages"},"Structs/QueryNoticesResult/FileType.html#/s:11DiscoveryV118QueryNoticesResultV8FileTypeO3pdfA2EmF":{"name":"pdf","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/QueryNoticesResult/FileType.html#/s:11DiscoveryV118QueryNoticesResultV8FileTypeO4htmlA2EmF":{"name":"html","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/QueryNoticesResult/FileType.html#/s:11DiscoveryV118QueryNoticesResultV8FileTypeO4wordA2EmF":{"name":"word","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/QueryNoticesResult/FileType.html#/s:11DiscoveryV118QueryNoticesResultV8FileTypeO4jsonA2EmF":{"name":"json","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/QueryNoticesResult/FileType.html":{"name":"FileType","abstract":"

The type of the original source file.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV2idSSSgvp":{"name":"id","abstract":"

The unique identifier of the document.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV5scoreSdSgvp":{"name":"score","abstract":"

Deprecated* This field is now part of the result_metadata object.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Metadata of the document.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV12collectionIDSSSgvp":{"name":"collectionID","abstract":"

The collection ID of the collection containing the document for this result.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV14resultMetadataAA0ceG0VSgvp":{"name":"resultMetadata","abstract":"

Metadata of the query result.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV4codeSiSgvp":{"name":"code","abstract":"

The internal status code returned by the ingestion subsystem indicating the overall result of ingesting the source document.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV8filenameSSSgvp":{"name":"filename","abstract":"

Name of the original source file (if available).

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV8fileTypeSSSgvp":{"name":"fileType","abstract":"

The type of the original source file.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV4sha1SSSgvp":{"name":"sha1","abstract":"

The SHA-1 hash of the original source file (formatted as a hexadecimal string).

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV7noticesSayAA6NoticeVGSgvp":{"name":"notices","abstract":"

Array of notices for the document.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResponse.html#/s:11DiscoveryV120QueryNoticesResponseV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Undocumented

","parent_name":"QueryNoticesResponse"},"Structs/QueryNoticesResponse.html#/s:11DiscoveryV120QueryNoticesResponseV7resultsSayAA0cD6ResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"QueryNoticesResponse"},"Structs/QueryNoticesResponse.html#/s:11DiscoveryV120QueryNoticesResponseV12aggregationsSayAA0C11AggregationOGSgvp":{"name":"aggregations","abstract":"

Undocumented

","parent_name":"QueryNoticesResponse"},"Structs/QueryNoticesResponse.html#/s:11DiscoveryV120QueryNoticesResponseV8passagesSayAA0C8PassagesVGSgvp":{"name":"passages","abstract":"

Undocumented

","parent_name":"QueryNoticesResponse"},"Structs/QueryNoticesResponse.html#/s:11DiscoveryV120QueryNoticesResponseV17duplicatesRemovedSiSgvp":{"name":"duplicatesRemoved","abstract":"

Undocumented

","parent_name":"QueryNoticesResponse"},"Structs/QueryFilterType.html#/s:11DiscoveryV115QueryFilterTypeV7excludeSaySSGSgvp":{"name":"exclude","abstract":"

A comma-separated list of types to exclude.

","parent_name":"QueryFilterType"},"Structs/QueryFilterType.html#/s:11DiscoveryV115QueryFilterTypeV7includeSaySSGSgvp":{"name":"include","abstract":"

A comma-separated list of types to include. All other types are excluded.

","parent_name":"QueryFilterType"},"Structs/QueryFilterType.html#/s:11DiscoveryV115QueryFilterTypeVACSaySSGSg7exclude_AE7includetcfc":{"name":"init(exclude:include:)","abstract":"

Initialize a QueryFilterType with member variables.

","parent_name":"QueryFilterType"},"Structs/QueryEvidenceEntity.html#/s:11DiscoveryV119QueryEvidenceEntityV4typeSSSgvp":{"name":"type","abstract":"

The entity type for this entity. Possible types vary based on model used.

","parent_name":"QueryEvidenceEntity"},"Structs/QueryEvidenceEntity.html#/s:11DiscoveryV119QueryEvidenceEntityV4textSSSgvp":{"name":"text","abstract":"

The original text of this entity as found in the evidence field.

","parent_name":"QueryEvidenceEntity"},"Structs/QueryEvidenceEntity.html#/s:11DiscoveryV119QueryEvidenceEntityV11startOffsetSiSgvp":{"name":"startOffset","abstract":"

The start location of the entity text in the identified field. This value is inclusive.

","parent_name":"QueryEvidenceEntity"},"Structs/QueryEvidenceEntity.html#/s:11DiscoveryV119QueryEvidenceEntityV9endOffsetSiSgvp":{"name":"endOffset","abstract":"

The end location of the entity text in the identified field. This value is exclusive.

","parent_name":"QueryEvidenceEntity"},"Structs/QueryEvidence.html#/s:11DiscoveryV113QueryEvidenceV10documentIDSSSgvp":{"name":"documentID","abstract":"

The docuemnt ID (as indexed in Discovery) of the evidence location.

","parent_name":"QueryEvidence"},"Structs/QueryEvidence.html#/s:11DiscoveryV113QueryEvidenceV5fieldSSSgvp":{"name":"field","abstract":"

The field of the document where the supporting evidence was identified.

","parent_name":"QueryEvidence"},"Structs/QueryEvidence.html#/s:11DiscoveryV113QueryEvidenceV11startOffsetSiSgvp":{"name":"startOffset","abstract":"

The start location of the evidence in the identified field. This value is inclusive.

","parent_name":"QueryEvidence"},"Structs/QueryEvidence.html#/s:11DiscoveryV113QueryEvidenceV9endOffsetSiSgvp":{"name":"endOffset","abstract":"

The end location of the evidence in the identified field. This value is inclusive.

","parent_name":"QueryEvidence"},"Structs/QueryEvidence.html#/s:11DiscoveryV113QueryEvidenceV8entitiesSayAA0cD6EntityVGSgvp":{"name":"entities","abstract":"

An array of entity objects that show evidence of the result.

","parent_name":"QueryEvidence"},"Structs/QueryEntitiesResponseItem.html#/s:11DiscoveryV125QueryEntitiesResponseItemV4textSSSgvp":{"name":"text","abstract":"

Entity text content.

","parent_name":"QueryEntitiesResponseItem"},"Structs/QueryEntitiesResponseItem.html#/s:11DiscoveryV125QueryEntitiesResponseItemV4typeSSSgvp":{"name":"type","abstract":"

The type of the result entity.

","parent_name":"QueryEntitiesResponseItem"},"Structs/QueryEntitiesResponseItem.html#/s:11DiscoveryV125QueryEntitiesResponseItemV8evidenceSayAA0C8EvidenceVGSgvp":{"name":"evidence","abstract":"

List of different evidentiary items to support the result.

","parent_name":"QueryEntitiesResponseItem"},"Structs/QueryEntitiesResponse.html#/s:11DiscoveryV121QueryEntitiesResponseV8entitiesSayAA0cdE4ItemVGSgvp":{"name":"entities","abstract":"

Undocumented

","parent_name":"QueryEntitiesResponse"},"Structs/QueryEntitiesEntity.html#/s:11DiscoveryV119QueryEntitiesEntityV4textSSSgvp":{"name":"text","abstract":"

Entity text content.

","parent_name":"QueryEntitiesEntity"},"Structs/QueryEntitiesEntity.html#/s:11DiscoveryV119QueryEntitiesEntityV4typeSSSgvp":{"name":"type","abstract":"

The type of the specified entity.

","parent_name":"QueryEntitiesEntity"},"Structs/QueryEntitiesEntity.html#/s:11DiscoveryV119QueryEntitiesEntityVACSSSg4text_AD4typetcfc":{"name":"init(text:type:)","abstract":"

Initialize a QueryEntitiesEntity with member variables.

","parent_name":"QueryEntitiesEntity"},"Structs/QueryEntitiesContext.html#/s:11DiscoveryV120QueryEntitiesContextV4textSSSgvp":{"name":"text","abstract":"

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

","parent_name":"QueryEntitiesContext"},"Structs/QueryEntitiesContext.html#/s:11DiscoveryV120QueryEntitiesContextVACSSSg4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a QueryEntitiesContext with member variables.

","parent_name":"QueryEntitiesContext"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesV7featureSSSgvp":{"name":"feature","abstract":"

The entity query feature to perform. Supported features are disambiguate and similar_entities.

","parent_name":"QueryEntities"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesV6entityAA0cD6EntityVSgvp":{"name":"entity","abstract":"

A text string that appears within the entity text field.

","parent_name":"QueryEntities"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesV7contextAA0cD7ContextVSgvp":{"name":"context","abstract":"

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

","parent_name":"QueryEntities"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesV5countSiSgvp":{"name":"count","abstract":"

The number of results to return. The default is 10. The maximum is 1000.

","parent_name":"QueryEntities"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesV13evidenceCountSiSgvp":{"name":"evidenceCount","abstract":"

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items per query is 10,000.

","parent_name":"QueryEntities"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesVACSSSg7feature_AA0cD6EntityVSg6entityAA0cD7ContextVSg7contextSiSg5countAN13evidenceCounttcfc":{"name":"init(feature:entity:context:count:evidenceCount:)","abstract":"

Initialize a QueryEntities with member variables.

","parent_name":"QueryEntities"},"Structs/PdfSettings.html#/s:11DiscoveryV111PdfSettingsV7headingAA0C16HeadingDetectionVSgvp":{"name":"heading","abstract":"

Undocumented

","parent_name":"PdfSettings"},"Structs/PdfSettings.html#/s:11DiscoveryV111PdfSettingsVAcA0C16HeadingDetectionVSg7heading_tcfc":{"name":"init(heading:)","abstract":"

Initialize a PdfSettings with member variables.

","parent_name":"PdfSettings"},"Structs/PdfHeadingDetection.html#/s:11DiscoveryV119PdfHeadingDetectionV5fontsSayAA11FontSettingVGSgvp":{"name":"fonts","abstract":"

Undocumented

","parent_name":"PdfHeadingDetection"},"Structs/PdfHeadingDetection.html#/s:11DiscoveryV119PdfHeadingDetectionVACSayAA11FontSettingVGSg5fonts_tcfc":{"name":"init(fonts:)","abstract":"

Initialize a PdfHeadingDetection with member variables.

","parent_name":"PdfHeadingDetection"},"Structs/Notice/Severity.html#/s:11DiscoveryV16NoticeV8SeverityO7warningA2EmF":{"name":"warning","abstract":"

Undocumented

","parent_name":"Severity"},"Structs/Notice/Severity.html#/s:11DiscoveryV16NoticeV8SeverityO5errorA2EmF":{"name":"error","abstract":"

Undocumented

","parent_name":"Severity"},"Structs/Notice/Severity.html":{"name":"Severity","abstract":"

Severity level of the notice.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV8noticeIDSSSgvp":{"name":"noticeID","abstract":"

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.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV7createdSSSgvp":{"name":"created","abstract":"

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

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV10documentIDSSSgvp":{"name":"documentID","abstract":"

Unique identifier of the document.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV7queryIDSSSgvp":{"name":"queryID","abstract":"

Unique identifier of the query used for relevance training.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV8severitySSSgvp":{"name":"severity","abstract":"

Severity level of the notice.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV4stepSSSgvp":{"name":"step","abstract":"

Ingestion or training step in which the notice occurred.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the notice.

","parent_name":"Notice"},"Structs/NormalizationOperation/Operation.html#/s:11DiscoveryV122NormalizationOperationV0D0O4copyA2EmF":{"name":"copy","abstract":"

Undocumented

","parent_name":"Operation"},"Structs/NormalizationOperation/Operation.html#/s:11DiscoveryV122NormalizationOperationV0D0O4moveA2EmF":{"name":"move","abstract":"

Undocumented

","parent_name":"Operation"},"Structs/NormalizationOperation/Operation.html#/s:11DiscoveryV122NormalizationOperationV0D0O5mergeA2EmF":{"name":"merge","abstract":"

Undocumented

","parent_name":"Operation"},"Structs/NormalizationOperation/Operation.html#/s:11DiscoveryV122NormalizationOperationV0D0O6removeA2EmF":{"name":"remove","abstract":"

Undocumented

","parent_name":"Operation"},"Structs/NormalizationOperation/Operation.html#/s:11DiscoveryV122NormalizationOperationV0D0O11removeNullsA2EmF":{"name":"removeNulls","abstract":"

Undocumented

","parent_name":"Operation"},"Structs/NormalizationOperation/Operation.html":{"name":"Operation","abstract":"

Identifies what type of operation to perform.","parent_name":"NormalizationOperation"},"Structs/NormalizationOperation.html#/s:11DiscoveryV122NormalizationOperationV9operationSSSgvp":{"name":"operation","abstract":"

Identifies what type of operation to perform.

","parent_name":"NormalizationOperation"},"Structs/NormalizationOperation.html#/s:11DiscoveryV122NormalizationOperationV11sourceFieldSSSgvp":{"name":"sourceField","abstract":"

The source field for the operation.

","parent_name":"NormalizationOperation"},"Structs/NormalizationOperation.html#/s:11DiscoveryV122NormalizationOperationV16destinationFieldSSSgvp":{"name":"destinationField","abstract":"

The destination field for the operation.

","parent_name":"NormalizationOperation"},"Structs/NormalizationOperation.html#/s:11DiscoveryV122NormalizationOperationVACSSSg9operation_AD11sourceFieldAD011destinationG0tcfc":{"name":"init(operation:sourceField:destinationField:)","abstract":"

Initialize a NormalizationOperation with member variables.

","parent_name":"NormalizationOperation"},"Structs/NluEnrichmentSentiment.html#/s:11DiscoveryV122NluEnrichmentSentimentV8documentSbSgvp":{"name":"document","abstract":"

When true, sentiment analysis is performed on the entire field.

","parent_name":"NluEnrichmentSentiment"},"Structs/NluEnrichmentSentiment.html#/s:11DiscoveryV122NluEnrichmentSentimentV7targetsSaySSGSgvp":{"name":"targets","abstract":"

A comma-separated list of target strings that will have any associated sentiment analyzed.

","parent_name":"NluEnrichmentSentiment"},"Structs/NluEnrichmentSentiment.html#/s:11DiscoveryV122NluEnrichmentSentimentVACSbSg8document_SaySSGSg7targetstcfc":{"name":"init(document:targets:)","abstract":"

Initialize a NluEnrichmentSentiment with member variables.

","parent_name":"NluEnrichmentSentiment"},"Structs/NluEnrichmentSemanticRoles.html#/s:11DiscoveryV126NluEnrichmentSemanticRolesV8entitiesSbSgvp":{"name":"entities","abstract":"

When true entities are extracted from the identified sentence parts.

","parent_name":"NluEnrichmentSemanticRoles"},"Structs/NluEnrichmentSemanticRoles.html#/s:11DiscoveryV126NluEnrichmentSemanticRolesV8keywordsSbSgvp":{"name":"keywords","abstract":"

When true, keywords are extracted from the identified sentence parts.

","parent_name":"NluEnrichmentSemanticRoles"},"Structs/NluEnrichmentSemanticRoles.html#/s:11DiscoveryV126NluEnrichmentSemanticRolesV5limitSiSgvp":{"name":"limit","abstract":"

The maximum number of semantic roles enrichments to extact from each instance of the specified field.

","parent_name":"NluEnrichmentSemanticRoles"},"Structs/NluEnrichmentSemanticRoles.html#/s:11DiscoveryV126NluEnrichmentSemanticRolesVACSbSg8entities_AD8keywordsSiSg5limittcfc":{"name":"init(entities:keywords:limit:)","abstract":"

Initialize a NluEnrichmentSemanticRoles with member variables.

","parent_name":"NluEnrichmentSemanticRoles"},"Structs/NluEnrichmentRelations.html#/s:11DiscoveryV122NluEnrichmentRelationsV5modelSSSgvp":{"name":"model","abstract":"

For use with natural_language_understanding enrichments only.* The enrichement model to use with relationship extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge Graph en-news, the default isen-news.

","parent_name":"NluEnrichmentRelations"},"Structs/NluEnrichmentRelations.html#/s:11DiscoveryV122NluEnrichmentRelationsVACSSSg5model_tcfc":{"name":"init(model:)","abstract":"

Initialize a NluEnrichmentRelations with member variables.

","parent_name":"NluEnrichmentRelations"},"Structs/NluEnrichmentKeywords.html#/s:11DiscoveryV121NluEnrichmentKeywordsV9sentimentSbSgvp":{"name":"sentiment","abstract":"

When true, sentiment analysis of keywords will be performed on the specified field.

","parent_name":"NluEnrichmentKeywords"},"Structs/NluEnrichmentKeywords.html#/s:11DiscoveryV121NluEnrichmentKeywordsV7emotionSbSgvp":{"name":"emotion","abstract":"

When true, emotion detection of keywords will be performed on the specified field.

","parent_name":"NluEnrichmentKeywords"},"Structs/NluEnrichmentKeywords.html#/s:11DiscoveryV121NluEnrichmentKeywordsV5limitSiSgvp":{"name":"limit","abstract":"

The maximum number of keywords to extract for each instance of the specified field.

","parent_name":"NluEnrichmentKeywords"},"Structs/NluEnrichmentKeywords.html#/s:11DiscoveryV121NluEnrichmentKeywordsVACSbSg9sentiment_AD7emotionSiSg5limittcfc":{"name":"init(sentiment:emotion:limit:)","abstract":"

Initialize a NluEnrichmentKeywords with member variables.

","parent_name":"NluEnrichmentKeywords"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV8keywordsAA0cD8KeywordsVSgvp":{"name":"keywords","abstract":"

An object specifying the Keyword enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV8entitiesAA0cD8EntitiesVSgvp":{"name":"entities","abstract":"

An object speficying the Entities enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV9sentimentAA0cD9SentimentVSgvp":{"name":"sentiment","abstract":"

An object specifying the sentiment extraction enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV7emotionAA0cD7EmotionVSgvp":{"name":"emotion","abstract":"

An object specifying the emotion detection enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV10categoriesAA0cD10CategoriesVSgvp":{"name":"categories","abstract":"

An object specifying the categories enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV13semanticRolesAA0cd8SemanticG0VSgvp":{"name":"semanticRoles","abstract":"

An object specifiying the semantic roles enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV9relationsAA0cD9RelationsVSgvp":{"name":"relations","abstract":"

An object specifying the relations enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesVAcA0cD8KeywordsVSg8keywords_AA0cD8EntitiesVSg8entitiesAA0cD9SentimentVSg9sentimentAA0cD7EmotionVSg7emotionAA0cD10CategoriesVSg10categoriesAA0cD13SemanticRolesVSg08semanticQ0AA0cD9RelationsVSg9relationstcfc":{"name":"init(keywords:entities:sentiment:emotion:categories:semanticRoles:relations:)","abstract":"

Initialize a NluEnrichmentFeatures with member variables.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV9sentimentSbSgvp":{"name":"sentiment","abstract":"

When true, sentiment analysis of entities will be performed on the specified field.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV7emotionSbSgvp":{"name":"emotion","abstract":"

When true, emotion detection of entities will be performed on the specified field.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV5limitSiSgvp":{"name":"limit","abstract":"

The maximum number of entities to extract for each instance of the specified field.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV8mentionsSbSgvp":{"name":"mentions","abstract":"

When true, the number of mentions of each identified entity is recorded. The default is false.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV12mentionTypesSbSgvp":{"name":"mentionTypes","abstract":"

When true, the types of mentions for each idetifieid entity is recorded. The default is false.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV16sentenceLocationSbSgvp":{"name":"sentenceLocation","abstract":"

When true, a list of sentence locations for each instance of each identified entity is recorded. The default is false.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV5modelSSSgvp":{"name":"model","abstract":"

The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge Graph en-news, or the default public model alchemy.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesVACSbSg9sentiment_AD7emotionSiSg5limitAD8mentionsAD12mentionTypesAD16sentenceLocationSSSg5modeltcfc":{"name":"init(sentiment:emotion:limit:mentions:mentionTypes:sentenceLocation:model:)","abstract":"

Initialize a NluEnrichmentEntities with member variables.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEmotion.html#/s:11DiscoveryV120NluEnrichmentEmotionV8documentSbSgvp":{"name":"document","abstract":"

When true, emotion detection is performed on the entire field.

","parent_name":"NluEnrichmentEmotion"},"Structs/NluEnrichmentEmotion.html#/s:11DiscoveryV120NluEnrichmentEmotionV7targetsSaySSGSgvp":{"name":"targets","abstract":"

A comma-separated list of target strings that will have any associated emotions detected.

","parent_name":"NluEnrichmentEmotion"},"Structs/NluEnrichmentEmotion.html#/s:11DiscoveryV120NluEnrichmentEmotionVACSbSg8document_SaySSGSg7targetstcfc":{"name":"init(document:targets:)","abstract":"

Initialize a NluEnrichmentEmotion with member variables.

","parent_name":"NluEnrichmentEmotion"},"Structs/NluEnrichmentCategories.html#/s:11DiscoveryV123NluEnrichmentCategoriesV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"NluEnrichmentCategories"},"Structs/NluEnrichmentCategories.html#/s:11DiscoveryV123NluEnrichmentCategoriesVACs10DictionaryVySSAA4JSONOG20additionalProperties_tcfc":{"name":"init(additionalProperties:)","abstract":"

Initialize a NluEnrichmentCategories.

","parent_name":"NluEnrichmentCategories"},"Structs/NluEnrichmentCategories.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"NluEnrichmentCategories"},"Structs/NluEnrichmentCategories.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"NluEnrichmentCategories"},"Structs/Nested.html#/s:11DiscoveryV16NestedV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Nested"},"Structs/Nested.html#/s:11DiscoveryV16NestedV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Nested"},"Structs/Nested.html#/s:11DiscoveryV16NestedV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Nested"},"Structs/Nested.html#/s:11DiscoveryV16NestedV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Nested"},"Structs/Nested.html#/s:11DiscoveryV16NestedV4pathSSSgvp":{"name":"path","abstract":"

The area of the results the aggregation was restricted to.

","parent_name":"Nested"},"Structs/MemoryUsage.html#/s:11DiscoveryV111MemoryUsageV9usedBytesSiSgvp":{"name":"usedBytes","abstract":"

Deprecated**: Number of bytes used in the environment’s memory capacity.

","parent_name":"MemoryUsage"},"Structs/MemoryUsage.html#/s:11DiscoveryV111MemoryUsageV10totalBytesSiSgvp":{"name":"totalBytes","abstract":"

Deprecated**: Total number of bytes available in the environment’s memory capacity.

","parent_name":"MemoryUsage"},"Structs/MemoryUsage.html#/s:11DiscoveryV111MemoryUsageV4usedSSSgvp":{"name":"used","abstract":"

Deprecated**: Amount of memory capacity used, in KB or GB format.

","parent_name":"MemoryUsage"},"Structs/MemoryUsage.html#/s:11DiscoveryV111MemoryUsageV5totalSSSgvp":{"name":"total","abstract":"

Deprecated**: Total amount of the environment’s memory capacity, in KB or GB format.

","parent_name":"MemoryUsage"},"Structs/MemoryUsage.html#/s:11DiscoveryV111MemoryUsageV11percentUsedSdSgvp":{"name":"percentUsed","abstract":"

Deprecated**: Percentage of the environment’s memory capacity that is being used.

","parent_name":"MemoryUsage"},"Structs/ListEnvironmentsResponse.html#/s:11DiscoveryV124ListEnvironmentsResponseV12environmentsSayAA11EnvironmentVGSgvp":{"name":"environments","abstract":"

An array of [environments] that are available for the service instance.

","parent_name":"ListEnvironmentsResponse"},"Structs/ListConfigurationsResponse.html#/s:11DiscoveryV126ListConfigurationsResponseV14configurationsSayAA13ConfigurationVGSgvp":{"name":"configurations","abstract":"

An array of Configurations that are available for the service instance.

","parent_name":"ListConfigurationsResponse"},"Structs/ListCollectionsResponse.html#/s:11DiscoveryV123ListCollectionsResponseV11collectionsSayAA10CollectionVGSgvp":{"name":"collections","abstract":"

An array containing information about each collection in the environment.

","parent_name":"ListCollectionsResponse"},"Structs/ListCollectionFieldsResponse.html#/s:11DiscoveryV128ListCollectionFieldsResponseV6fieldsSayAA5FieldVGSgvp":{"name":"fields","abstract":"

An array containing information about each field in the collections.

","parent_name":"ListCollectionFieldsResponse"},"Structs/IndexCapacity.html#/s:11DiscoveryV113IndexCapacityV9documentsAA20EnvironmentDocumentsVSgvp":{"name":"documents","abstract":"

Summary of the document usage statistics for the environment.

","parent_name":"IndexCapacity"},"Structs/IndexCapacity.html#/s:11DiscoveryV113IndexCapacityV9diskUsageAA04DiskF0VSgvp":{"name":"diskUsage","abstract":"

Summary of the disk usage of the environment.

","parent_name":"IndexCapacity"},"Structs/IndexCapacity.html#/s:11DiscoveryV113IndexCapacityV11collectionsAA15CollectionUsageVSgvp":{"name":"collections","abstract":"

Summary of the collection usage in the environment.

","parent_name":"IndexCapacity"},"Structs/IndexCapacity.html#/s:11DiscoveryV113IndexCapacityV11memoryUsageAA06MemoryF0VSgvp":{"name":"memoryUsage","abstract":"

Deprecated**: Summary of the memory usage of the environment.

","parent_name":"IndexCapacity"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV21excludeTagsCompletelySaySSGSgvp":{"name":"excludeTagsCompletely","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV22excludeTagsKeepContentSaySSGSgvp":{"name":"excludeTagsKeepContent","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV11keepContentAA13XPathPatternsVSgvp":{"name":"keepContent","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV14excludeContentAA13XPathPatternsVSgvp":{"name":"excludeContent","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV17keepTagAttributesSaySSGSgvp":{"name":"keepTagAttributes","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV20excludeTagAttributesSaySSGSgvp":{"name":"excludeTagAttributes","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsVACSaySSGSg21excludeTagsCompletely_AE0eF11KeepContentAA13XPathPatternsVSg04keepI0AJ0eI0AE0L13TagAttributesAE0emN0tcfc":{"name":"init(excludeTagsCompletely:excludeTagsKeepContent:keepContent:excludeContent:keepTagAttributes:excludeTagAttributes:)","abstract":"

Initialize a HtmlSettings with member variables.

","parent_name":"HtmlSettings"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Histogram"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Histogram"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Histogram"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Histogram"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV5fieldSSSgvp":{"name":"field","abstract":"

The field where the aggregation is located in the document.

","parent_name":"Histogram"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV8intervalSiSgvp":{"name":"interval","abstract":"

Interval of the aggregation. (For ‘histogram’ type).

","parent_name":"Histogram"},"Structs/GenericQueryAggregation.html#/s:11DiscoveryV123GenericQueryAggregationV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"GenericQueryAggregation"},"Structs/GenericQueryAggregation.html#/s:11DiscoveryV123GenericQueryAggregationV7resultsSayAA0E6ResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"GenericQueryAggregation"},"Structs/GenericQueryAggregation.html#/s:11DiscoveryV123GenericQueryAggregationV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"GenericQueryAggregation"},"Structs/GenericQueryAggregation.html#/s:11DiscoveryV123GenericQueryAggregationV12aggregationsSayAA0dE0OGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"GenericQueryAggregation"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV5levelSiSgvp":{"name":"level","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV7minSizeSiSgvp":{"name":"minSize","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV7maxSizeSiSgvp":{"name":"maxSize","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV4boldSbSgvp":{"name":"bold","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV6italicSbSgvp":{"name":"italic","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV4nameSSSgvp":{"name":"name","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingVACSiSg5level_AD7minSizeAD03maxG0SbSg4boldAH6italicSSSg4nametcfc":{"name":"init(level:minSize:maxSize:bold:italic:name:)","abstract":"

Initialize a FontSetting with member variables.

","parent_name":"FontSetting"},"Structs/Filter.html#/s:11DiscoveryV16FilterV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Filter"},"Structs/Filter.html#/s:11DiscoveryV16FilterV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Filter"},"Structs/Filter.html#/s:11DiscoveryV16FilterV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Filter"},"Structs/Filter.html#/s:11DiscoveryV16FilterV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Filter"},"Structs/Filter.html#/s:11DiscoveryV16FilterV5matchSSSgvp":{"name":"match","abstract":"

The match the aggregated results queried for.

","parent_name":"Filter"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO6nestedA2EmF":{"name":"nested","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO6stringA2EmF":{"name":"string","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO4dateA2EmF":{"name":"date","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO4longA2EmF":{"name":"long","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO7integerA2EmF":{"name":"integer","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO5shortA2EmF":{"name":"short","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO4byteA2EmF":{"name":"byte","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO6doubleA2EmF":{"name":"double","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO5floatA2EmF":{"name":"float","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO7booleanA2EmF":{"name":"boolean","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO6binaryA2EmF":{"name":"binary","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html":{"name":"FieldType","abstract":"

The type of the field.

","parent_name":"Field"},"Structs/Field.html#/s:11DiscoveryV15FieldV9fieldNameSSSgvp":{"name":"fieldName","abstract":"

The name of the field.

","parent_name":"Field"},"Structs/Field.html#/s:11DiscoveryV15FieldV9fieldTypeSSSgvp":{"name":"fieldType","abstract":"

The type of the field.

","parent_name":"Field"},"Structs/Expansions.html#/s:11DiscoveryV110ExpansionsV10expansionsSayAA9ExpansionVGvp":{"name":"expansions","abstract":"

An array of query expansion definitions. Each object in the expansions array represents a term or set of terms that will be expanded into other terms. Each expansion object can be configured so that all terms are expanded to all other terms in the object - bi-directional, or a set list of terms can be expanded into a second list of terms - uni-directional. To create a bi-directional expansion specify an expanded_terms array. When found in a query, all items in the expanded_terms array are then expanded to the other items in the same array. To create a uni-directional expansion, specify both an array of input_terms and an array of expanded_terms. When items in the input_terms array are present in a query, they are expanded using the items listed in the expanded_terms array.

","parent_name":"Expansions"},"Structs/Expansions.html#/s:11DiscoveryV110ExpansionsVACSayAA9ExpansionVG10expansions_tcfc":{"name":"init(expansions:)","abstract":"

Initialize a Expansions with member variables.

","parent_name":"Expansions"},"Structs/Expansion.html#/s:11DiscoveryV19ExpansionV10inputTermsSaySSGSgvp":{"name":"inputTerms","abstract":"

A list of terms that will be expanded for this expansion. If specified, only the items in this list are expanded.

","parent_name":"Expansion"},"Structs/Expansion.html#/s:11DiscoveryV19ExpansionV13expandedTermsSaySSGvp":{"name":"expandedTerms","abstract":"

A list of terms that this expansion will be expanded to. If specified without input_terms, it also functions as the input term list.

","parent_name":"Expansion"},"Structs/Expansion.html#/s:11DiscoveryV19ExpansionVACSaySSG13expandedTerms_ADSg05inputE0tcfc":{"name":"init(expandedTerms:inputTerms:)","abstract":"

Initialize a Expansion with member variables.

","parent_name":"Expansion"},"Structs/EnvironmentDocuments.html#/s:11DiscoveryV120EnvironmentDocumentsV7indexedSiSgvp":{"name":"indexed","abstract":"

Number of documents indexed for the environment.

","parent_name":"EnvironmentDocuments"},"Structs/EnvironmentDocuments.html#/s:11DiscoveryV120EnvironmentDocumentsV14maximumAllowedSiSgvp":{"name":"maximumAllowed","abstract":"

Total number of documents allowed in the environment’s capacity.

","parent_name":"EnvironmentDocuments"},"Structs/Environment/Status.html#/s:11DiscoveryV111EnvironmentV6StatusO6activeA2EmF":{"name":"active","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Environment/Status.html#/s:11DiscoveryV111EnvironmentV6StatusO7pendingA2EmF":{"name":"pending","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Environment/Status.html#/s:11DiscoveryV111EnvironmentV6StatusO11maintenanceA2EmF":{"name":"maintenance","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Environment/Status.html":{"name":"Status","abstract":"

Status of the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV13environmentIDSSSgvp":{"name":"environmentID","abstract":"

Unique identifier for the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV4nameSSSgvp":{"name":"name","abstract":"

Name that identifies the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV11descriptionSSSgvp":{"name":"description","abstract":"

Description of the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV7createdSSSgvp":{"name":"created","abstract":"

Creation date of the environment, in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV7updatedSSSgvp":{"name":"updated","abstract":"

Date of most recent environment update, in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV6statusSSSgvp":{"name":"status","abstract":"

Status of the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV8readOnlySbSgvp":{"name":"readOnly","abstract":"

If true, then the environment contains read-only collections which are maintained by IBM.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV4sizeSiSgvp":{"name":"size","abstract":"

Deprecated**: Size of the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV13indexCapacityAA05IndexE0VSgvp":{"name":"indexCapacity","abstract":"

Details about the resource usage and capacity of the environment.

","parent_name":"Environment"},"Structs/EnrichmentOptions.html#/s:11DiscoveryV117EnrichmentOptionsV8featuresAA03NluC8FeaturesVSgvp":{"name":"features","abstract":"

An object representing the enrichment features that will be applied to the specified field.

","parent_name":"EnrichmentOptions"},"Structs/EnrichmentOptions.html#/s:11DiscoveryV117EnrichmentOptionsV5modelSSSgvp":{"name":"model","abstract":"

For use with elements enrichments only.* The element extraction model to use. Models available are: contract.

","parent_name":"EnrichmentOptions"},"Structs/EnrichmentOptions.html#/s:11DiscoveryV117EnrichmentOptionsVAcA03NluC8FeaturesVSg8features_SSSg5modeltcfc":{"name":"init(features:model:)","abstract":"

Initialize a EnrichmentOptions with member variables.

","parent_name":"EnrichmentOptions"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV11descriptionSSSgvp":{"name":"description","abstract":"

Describes what the enrichment step does.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV16destinationFieldSSvp":{"name":"destinationField","abstract":"

Field where enrichments will be stored. This field must already exist or be at most 1 level deeper than an existing field. For example, if text is a top-level field with no sub-fields, text.foo is a valid destination but text.foo.bar is not.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV11sourceFieldSSvp":{"name":"sourceField","abstract":"

Field to be enriched.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV9overwriteSbSgvp":{"name":"overwrite","abstract":"

Indicates that the enrichments will overwrite the destination_field field if it already exists.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV14enrichmentNameSSvp":{"name":"enrichmentName","abstract":"

Name of the enrichment service to call. Current options are natural_language_understanding and elements. When using natual_language_understanding, the options object must contain Natural Language Understanding Options. When using elements the options object must contain Element Classification options. Additionally, when using the elements enrichment the configuration specified and files ingested must meet all the criteria specified in the documentation Previous API versions also supported alchemy_language.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV22ignoreDownstreamErrorsSbSgvp":{"name":"ignoreDownstreamErrors","abstract":"

If true, then most errors generated during the enrichment process will be treated as warnings and will not cause the document to fail processing.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV7optionsAA0C7OptionsVSgvp":{"name":"options","abstract":"

A list of options specific to the enrichment.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentVACSS16destinationField_SS06sourceE0SS14enrichmentNameSSSg11descriptionSbSg9overwriteAI22ignoreDownstreamErrorsAA0C7OptionsVSg7optionstcfc":{"name":"init(destinationField:sourceField:enrichmentName:description:overwrite:ignoreDownstreamErrors:options:)","abstract":"

Initialize a Enrichment with member variables.

","parent_name":"Enrichment"},"Structs/DocumentStatus/FileType.html#/s:11DiscoveryV114DocumentStatusV8FileTypeO3pdfA2EmF":{"name":"pdf","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/DocumentStatus/FileType.html#/s:11DiscoveryV114DocumentStatusV8FileTypeO4htmlA2EmF":{"name":"html","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/DocumentStatus/FileType.html#/s:11DiscoveryV114DocumentStatusV8FileTypeO4wordA2EmF":{"name":"word","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/DocumentStatus/FileType.html#/s:11DiscoveryV114DocumentStatusV8FileTypeO4jsonA2EmF":{"name":"json","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/DocumentStatus/Status.html#/s:11DiscoveryV114DocumentStatusV0D0O9availableA2EmF":{"name":"available","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DocumentStatus/Status.html#/s:11DiscoveryV114DocumentStatusV0D0O20availableWithNoticesA2EmF":{"name":"availableWithNotices","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DocumentStatus/Status.html#/s:11DiscoveryV114DocumentStatusV0D0O6failedA2EmF":{"name":"failed","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DocumentStatus/Status.html#/s:11DiscoveryV114DocumentStatusV0D0O10processingA2EmF":{"name":"processing","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DocumentStatus/Status.html":{"name":"Status","abstract":"

Status of the document in the ingestion process.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus/FileType.html":{"name":"FileType","abstract":"

The type of the original source file.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV10documentIDSSvp":{"name":"documentID","abstract":"

The unique identifier of the document.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV15configurationIDSSSgvp":{"name":"configurationID","abstract":"

The unique identifier for the configuration.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV7createdSSSgvp":{"name":"created","abstract":"

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

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV7updatedSSSgvp":{"name":"updated","abstract":"

Date of the most recent document update, in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV6statusSSvp":{"name":"status","abstract":"

Status of the document in the ingestion process.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV17statusDescriptionSSvp":{"name":"statusDescription","abstract":"

Description of the document status.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV8filenameSSSgvp":{"name":"filename","abstract":"

Name of the original source file (if available).

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV8fileTypeSSSgvp":{"name":"fileType","abstract":"

The type of the original source file.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV4sha1SSSgvp":{"name":"sha1","abstract":"

The SHA-1 hash of the original source file (formatted as a hexadecimal string).

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV7noticesSayAA6NoticeVGvp":{"name":"notices","abstract":"

Array of notices produced by the document-ingestion process.

","parent_name":"DocumentStatus"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO9htmlInputA2EmF":{"name":"htmlInput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO10htmlOutputA2EmF":{"name":"htmlOutput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO10jsonOutputA2EmF":{"name":"jsonOutput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO24jsonNormalizationsOutputA2EmF":{"name":"jsonNormalizationsOutput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO17enrichmentsOutputA2EmF":{"name":"enrichmentsOutput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO20normalizationsOutputA2EmF":{"name":"normalizationsOutput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html":{"name":"Step","abstract":"

Undocumented

","parent_name":"DocumentSnapshot"},"Structs/DocumentSnapshot.html#/s:11DiscoveryV116DocumentSnapshotV4stepSSSgvp":{"name":"step","abstract":"

Undocumented

","parent_name":"DocumentSnapshot"},"Structs/DocumentSnapshot.html#/s:11DiscoveryV116DocumentSnapshotV8snapshots10DictionaryVySSAA4JSONOGSgvp":{"name":"snapshot","abstract":"

Undocumented

","parent_name":"DocumentSnapshot"},"Structs/DocumentCounts.html#/s:11DiscoveryV114DocumentCountsV9availableSiSgvp":{"name":"available","abstract":"

The total number of available documents in the collection.

","parent_name":"DocumentCounts"},"Structs/DocumentCounts.html#/s:11DiscoveryV114DocumentCountsV10processingSiSgvp":{"name":"processing","abstract":"

The number of documents in the collection that are currently being processed.

","parent_name":"DocumentCounts"},"Structs/DocumentCounts.html#/s:11DiscoveryV114DocumentCountsV6failedSiSgvp":{"name":"failed","abstract":"

The number of documents in the collection that failed to be ingested.

","parent_name":"DocumentCounts"},"Structs/DocumentAccepted/Status.html#/s:11DiscoveryV116DocumentAcceptedV6StatusO10processingA2EmF":{"name":"processing","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DocumentAccepted/Status.html":{"name":"Status","abstract":"

Status of the document in the ingestion process.

","parent_name":"DocumentAccepted"},"Structs/DocumentAccepted.html#/s:11DiscoveryV116DocumentAcceptedV10documentIDSSSgvp":{"name":"documentID","abstract":"

The unique identifier of the ingested document.

","parent_name":"DocumentAccepted"},"Structs/DocumentAccepted.html#/s:11DiscoveryV116DocumentAcceptedV6statusSSSgvp":{"name":"status","abstract":"

Status of the document in the ingestion process.

","parent_name":"DocumentAccepted"},"Structs/DocumentAccepted.html#/s:11DiscoveryV116DocumentAcceptedV7noticesSayAA6NoticeVGSgvp":{"name":"notices","abstract":"

Array of notices produced by the document-ingestion process.

","parent_name":"DocumentAccepted"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV9usedBytesSiSgvp":{"name":"usedBytes","abstract":"

Number of bytes used on the environment’s disk capacity.

","parent_name":"DiskUsage"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV19maximumAllowedBytesSiSgvp":{"name":"maximumAllowedBytes","abstract":"

Total number of bytes available in the environment’s disk capacity.

","parent_name":"DiskUsage"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV10totalBytesSiSgvp":{"name":"totalBytes","abstract":"

Deprecated**: Total number of bytes available in the environment’s disk capacity.

","parent_name":"DiskUsage"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV4usedSSSgvp":{"name":"used","abstract":"

Deprecated**: Amount of disk capacity used, in KB or GB format.

","parent_name":"DiskUsage"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV5totalSSSgvp":{"name":"total","abstract":"

Deprecated**: Total amount of the environment’s disk capacity, in KB or GB format.

","parent_name":"DiskUsage"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV11percentUsedSdSgvp":{"name":"percentUsed","abstract":"

Deprecated**: Percentage of the environment’s disk capacity that is being used.

","parent_name":"DiskUsage"},"Structs/DeleteEnvironmentResponse/Status.html#/s:11DiscoveryV125DeleteEnvironmentResponseV6StatusO7deletedA2EmF":{"name":"deleted","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DeleteEnvironmentResponse/Status.html":{"name":"Status","abstract":"

Status of the environment.

","parent_name":"DeleteEnvironmentResponse"},"Structs/DeleteEnvironmentResponse.html#/s:11DiscoveryV125DeleteEnvironmentResponseV13environmentIDSSvp":{"name":"environmentID","abstract":"

The unique identifier for the environment.

","parent_name":"DeleteEnvironmentResponse"},"Structs/DeleteEnvironmentResponse.html#/s:11DiscoveryV125DeleteEnvironmentResponseV6statusSSvp":{"name":"status","abstract":"

Status of the environment.

","parent_name":"DeleteEnvironmentResponse"},"Structs/DeleteDocumentResponse/Status.html#/s:11DiscoveryV122DeleteDocumentResponseV6StatusO7deletedA2EmF":{"name":"deleted","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DeleteDocumentResponse/Status.html":{"name":"Status","abstract":"

Status of the document. A deleted document has the status deleted.

","parent_name":"DeleteDocumentResponse"},"Structs/DeleteDocumentResponse.html#/s:11DiscoveryV122DeleteDocumentResponseV10documentIDSSSgvp":{"name":"documentID","abstract":"

The unique identifier of the document.

","parent_name":"DeleteDocumentResponse"},"Structs/DeleteDocumentResponse.html#/s:11DiscoveryV122DeleteDocumentResponseV6statusSSSgvp":{"name":"status","abstract":"

Status of the document. A deleted document has the status deleted.

","parent_name":"DeleteDocumentResponse"},"Structs/DeleteConfigurationResponse/Status.html#/s:11DiscoveryV127DeleteConfigurationResponseV6StatusO7deletedA2EmF":{"name":"deleted","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DeleteConfigurationResponse/Status.html":{"name":"Status","abstract":"

Status of the configuration. A deleted configuration has the status deleted.

","parent_name":"DeleteConfigurationResponse"},"Structs/DeleteConfigurationResponse.html#/s:11DiscoveryV127DeleteConfigurationResponseV15configurationIDSSvp":{"name":"configurationID","abstract":"

The unique identifier for the configuration.

","parent_name":"DeleteConfigurationResponse"},"Structs/DeleteConfigurationResponse.html#/s:11DiscoveryV127DeleteConfigurationResponseV6statusSSvp":{"name":"status","abstract":"

Status of the configuration. A deleted configuration has the status deleted.

","parent_name":"DeleteConfigurationResponse"},"Structs/DeleteConfigurationResponse.html#/s:11DiscoveryV127DeleteConfigurationResponseV7noticesSayAA6NoticeVGSgvp":{"name":"notices","abstract":"

An array of notice messages, if any.

","parent_name":"DeleteConfigurationResponse"},"Structs/DeleteCollectionResponse/Status.html#/s:11DiscoveryV124DeleteCollectionResponseV6StatusO7deletedA2EmF":{"name":"deleted","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DeleteCollectionResponse/Status.html":{"name":"Status","abstract":"

The status of the collection. The status of a successful deletion operation is deleted.

","parent_name":"DeleteCollectionResponse"},"Structs/DeleteCollectionResponse.html#/s:11DiscoveryV124DeleteCollectionResponseV12collectionIDSSvp":{"name":"collectionID","abstract":"

The unique identifier of the collection that is being deleted.

","parent_name":"DeleteCollectionResponse"},"Structs/DeleteCollectionResponse.html#/s:11DiscoveryV124DeleteCollectionResponseV6statusSSvp":{"name":"status","abstract":"

The status of the collection. The status of a successful deletion operation is deleted.

","parent_name":"DeleteCollectionResponse"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2enA2EmF":{"name":"en","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2esA2EmF":{"name":"es","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2deA2EmF":{"name":"de","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2arA2EmF":{"name":"ar","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2frA2EmF":{"name":"fr","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2itA2EmF":{"name":"it","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2jaA2EmF":{"name":"ja","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2koA2EmF":{"name":"ko","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2ptA2EmF":{"name":"pt","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html":{"name":"Language","abstract":"

The language of the documents stored in the collection, in the form of an ISO 639-1 language code.

","parent_name":"CreateCollectionRequest"},"Structs/CreateCollectionRequest.html#/s:11DiscoveryV123CreateCollectionRequestV4nameSSvp":{"name":"name","abstract":"

The name of the collection to be created.

","parent_name":"CreateCollectionRequest"},"Structs/CreateCollectionRequest.html#/s:11DiscoveryV123CreateCollectionRequestV11descriptionSSSgvp":{"name":"description","abstract":"

A description of the collection.

","parent_name":"CreateCollectionRequest"},"Structs/CreateCollectionRequest.html#/s:11DiscoveryV123CreateCollectionRequestV15configurationIDSSSgvp":{"name":"configurationID","abstract":"

The ID of the configuration in which the collection is to be created.

","parent_name":"CreateCollectionRequest"},"Structs/CreateCollectionRequest.html#/s:11DiscoveryV123CreateCollectionRequestV8languageSSSgvp":{"name":"language","abstract":"

The language of the documents stored in the collection, in the form of an ISO 639-1 language code.

","parent_name":"CreateCollectionRequest"},"Structs/CreateCollectionRequest.html#/s:11DiscoveryV123CreateCollectionRequestVACSS4name_SSSg11descriptionAE15configurationIDAE8languagetcfc":{"name":"init(name:description:configurationID:language:)","abstract":"

Initialize a CreateCollectionRequest with member variables.

","parent_name":"CreateCollectionRequest"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsV3pdfAA11PdfSettingsVSgvp":{"name":"pdf","abstract":"

A list of PDF conversion settings.

","parent_name":"Conversions"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsV4wordAA12WordSettingsVSgvp":{"name":"word","abstract":"

A list of Word conversion settings.

","parent_name":"Conversions"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsV4htmlAA12HtmlSettingsVSgvp":{"name":"html","abstract":"

A list of HTML conversion settings.

","parent_name":"Conversions"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsV7segmentAA15SegmentSettingsVSgvp":{"name":"segment","abstract":"

A list of Document Segmentation settings.

","parent_name":"Conversions"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsV18jsonNormalizationsSayAA22NormalizationOperationVGSgvp":{"name":"jsonNormalizations","abstract":"

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are executed in the order that they appear in the array.

","parent_name":"Conversions"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsVAcA11PdfSettingsVSg3pdf_AA04WordE0VSg4wordAA04HtmlE0VSg4htmlAA07SegmentE0VSg7segmentSayAA22NormalizationOperationVGSg18jsonNormalizationstcfc":{"name":"init(pdf:word:html:segment:jsonNormalizations:)","abstract":"

Initialize a Conversions with member variables.

","parent_name":"Conversions"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV15configurationIDSSSgvp":{"name":"configurationID","abstract":"

The unique identifier of the configuration.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV4nameSSvp":{"name":"name","abstract":"

The name of the configuration.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV7createdSSSgvp":{"name":"created","abstract":"

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

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp of when the configuration was last updated in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the configuration, if available.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV11conversionsAA11ConversionsVSgvp":{"name":"conversions","abstract":"

The document conversion settings for the configuration.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV11enrichmentsSayAA10EnrichmentVGSgvp":{"name":"enrichments","abstract":"

An array of document enrichment settings for the configuration.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV14normalizationsSayAA22NormalizationOperationVGSgvp":{"name":"normalizations","abstract":"

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are executed in the order that they appear in the array.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationVACSS4name_SSSg15configurationIDAE7createdAE7updatedAE11descriptionAA11ConversionsVSg11conversionsSayAA10EnrichmentVGSg11enrichmentsSayAA22NormalizationOperationVGSg14normalizationstcfc":{"name":"init(name:configurationID:created:updated:description:conversions:enrichments:normalizations:)","abstract":"

Initialize a Configuration with member variables.

","parent_name":"Configuration"},"Structs/CollectionUsage.html#/s:11DiscoveryV115CollectionUsageV9availableSiSgvp":{"name":"available","abstract":"

Number of active collections in the environment.

","parent_name":"CollectionUsage"},"Structs/CollectionUsage.html#/s:11DiscoveryV115CollectionUsageV14maximumAllowedSiSgvp":{"name":"maximumAllowed","abstract":"

Total number of collections allowed in the environment.

","parent_name":"CollectionUsage"},"Structs/CollectionDiskUsage.html#/s:11DiscoveryV119CollectionDiskUsageV9usedBytesSiSgvp":{"name":"usedBytes","abstract":"

Number of bytes used by the collection.

","parent_name":"CollectionDiskUsage"},"Structs/Collection/Status.html#/s:11DiscoveryV110CollectionV6StatusO6activeA2EmF":{"name":"active","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Collection/Status.html#/s:11DiscoveryV110CollectionV6StatusO7pendingA2EmF":{"name":"pending","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Collection/Status.html#/s:11DiscoveryV110CollectionV6StatusO11maintenanceA2EmF":{"name":"maintenance","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Collection/Status.html":{"name":"Status","abstract":"

The status of the collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV12collectionIDSSSgvp":{"name":"collectionID","abstract":"

The unique identifier of the collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV4nameSSSgvp":{"name":"name","abstract":"

The name of the collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV7createdSSSgvp":{"name":"created","abstract":"

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

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp of when the collection was last updated in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV6statusSSSgvp":{"name":"status","abstract":"

The status of the collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV15configurationIDSSSgvp":{"name":"configurationID","abstract":"

The unique identifier of the collection’s configuration.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV8languageSSSgvp":{"name":"language","abstract":"

The language of the documents stored in the collection. Permitted values include en (English), de (German), and es (Spanish).

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV14documentCountsAA08DocumentE0VSgvp":{"name":"documentCounts","abstract":"

The object providing information about the documents in the collection. Present only when retrieving details of a collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV9diskUsageAA0c4DiskE0VSgvp":{"name":"diskUsage","abstract":"

The object providing information about the disk usage of the collection. Present only when retrieving details of a collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV14trainingStatusAA08TrainingE0VSgvp":{"name":"trainingStatus","abstract":"

Provides information about the status of relevance training for collection.

","parent_name":"Collection"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Calculation"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Calculation"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Calculation"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Calculation"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV5fieldSSSgvp":{"name":"field","abstract":"

The field where the aggregation is located in the document.

","parent_name":"Calculation"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV5valueSdSgvp":{"name":"value","abstract":"

Value of the aggregation.

","parent_name":"Calculation"},"Structs/AggregationResult.html#/s:11DiscoveryV117AggregationResultV3keySSSgvp":{"name":"key","abstract":"

Key that matched the aggregation type.

","parent_name":"AggregationResult"},"Structs/AggregationResult.html#/s:11DiscoveryV117AggregationResultV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"AggregationResult"},"Structs/AggregationResult.html#/s:11DiscoveryV117AggregationResultV12aggregationsSayAA05QueryC0OGSgvp":{"name":"aggregations","abstract":"

Aggregations returned in the case of chained aggregations.

","parent_name":"AggregationResult"},"Structs/AggregationResult.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"AggregationResult"},"Structs/AggregationResult.html":{"name":"AggregationResult","abstract":"

AggregationResult.

"},"Structs/Calculation.html":{"name":"Calculation","abstract":"

Calculation.

"},"Structs/Collection.html":{"name":"Collection","abstract":"

A collection for storing documents.

"},"Structs/CollectionDiskUsage.html":{"name":"CollectionDiskUsage","abstract":"

Summary of the disk usage statistics for this collection.

"},"Structs/CollectionUsage.html":{"name":"CollectionUsage","abstract":"

Summary of the collection usage in the environment.

"},"Structs/Configuration.html":{"name":"Configuration","abstract":"

A custom configuration for the environment.

"},"Structs/Conversions.html":{"name":"Conversions","abstract":"

Document conversion settings.

"},"Structs/CreateCollectionRequest.html":{"name":"CreateCollectionRequest","abstract":"

CreateCollectionRequest.

"},"Structs/DeleteCollectionResponse.html":{"name":"DeleteCollectionResponse","abstract":"

DeleteCollectionResponse.

"},"Structs/DeleteConfigurationResponse.html":{"name":"DeleteConfigurationResponse","abstract":"

DeleteConfigurationResponse.

"},"Structs/DeleteDocumentResponse.html":{"name":"DeleteDocumentResponse","abstract":"

DeleteDocumentResponse.

"},"Structs/DeleteEnvironmentResponse.html":{"name":"DeleteEnvironmentResponse","abstract":"

DeleteEnvironmentResponse.

"},"Structs/DiskUsage.html":{"name":"DiskUsage","abstract":"

Summary of the disk usage statistics for the environment.

"},"Structs/DocumentAccepted.html":{"name":"DocumentAccepted","abstract":"

DocumentAccepted.

"},"Structs/DocumentCounts.html":{"name":"DocumentCounts","abstract":"

DocumentCounts.

"},"Structs/DocumentSnapshot.html":{"name":"DocumentSnapshot","abstract":"

DocumentSnapshot.

"},"Structs/DocumentStatus.html":{"name":"DocumentStatus","abstract":"

Status information about a submitted document.

"},"Structs/Enrichment.html":{"name":"Enrichment","abstract":"

Enrichment.

"},"Structs/EnrichmentOptions.html":{"name":"EnrichmentOptions","abstract":"

Options which are specific to a particular enrichment.

"},"Structs/Environment.html":{"name":"Environment","abstract":"

Details about an environment.

"},"Structs/EnvironmentDocuments.html":{"name":"EnvironmentDocuments","abstract":"

Summary of the document usage statistics for the environment.

"},"Structs/Expansion.html":{"name":"Expansion","abstract":"

An expansion definition. Each object respresents one set of expandable strings. For example, you could have expansions for the word hot in one object, and expansions for the word cold in another.

"},"Structs/Expansions.html":{"name":"Expansions","abstract":"

The query expansion definitions for the specified collection.

"},"Structs/Field.html":{"name":"Field","abstract":"

Field.

"},"Structs/Filter.html":{"name":"Filter","abstract":"

Filter.

"},"Structs/FontSetting.html":{"name":"FontSetting","abstract":"

FontSetting.

"},"Structs/GenericQueryAggregation.html":{"name":"GenericQueryAggregation","abstract":"

An aggregation produced by the Discovery service to analyze the input provided.

"},"Structs/Histogram.html":{"name":"Histogram","abstract":"

Histogram.

"},"Structs/HtmlSettings.html":{"name":"HtmlSettings","abstract":"

A list of HTML conversion settings.

"},"Structs/IndexCapacity.html":{"name":"IndexCapacity","abstract":"

Details about the resource usage and capacity of the environment.

"},"Structs/ListCollectionFieldsResponse.html":{"name":"ListCollectionFieldsResponse","abstract":"

The list of fetched fields. The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations. * Fields which contain nested JSON objects are assigned a type of nested. * Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity). * Fields returned from the News collection are prefixed with v{N}-fullnews-t3-{YEAR}.mappings (for example, v5-fullnews-t3-2016.mappings.text.properties.author).

"},"Structs/ListCollectionsResponse.html":{"name":"ListCollectionsResponse","abstract":"

ListCollectionsResponse.

"},"Structs/ListConfigurationsResponse.html":{"name":"ListConfigurationsResponse","abstract":"

ListConfigurationsResponse.

"},"Structs/ListEnvironmentsResponse.html":{"name":"ListEnvironmentsResponse","abstract":"

ListEnvironmentsResponse.

"},"Structs/MemoryUsage.html":{"name":"MemoryUsage","abstract":"

Deprecated**: Summary of the memory usage statistics for this environment.

"},"Structs/Nested.html":{"name":"Nested","abstract":"

Nested.

"},"Structs/NluEnrichmentCategories.html":{"name":"NluEnrichmentCategories","abstract":"

An object that indicates the Categories enrichment will be applied to the specified field.

"},"Structs/NluEnrichmentEmotion.html":{"name":"NluEnrichmentEmotion","abstract":"

An object specifying the emotion detection enrichment and related parameters.

"},"Structs/NluEnrichmentEntities.html":{"name":"NluEnrichmentEntities","abstract":"

An object speficying the Entities enrichment and related parameters.

"},"Structs/NluEnrichmentFeatures.html":{"name":"NluEnrichmentFeatures","abstract":"

NluEnrichmentFeatures.

"},"Structs/NluEnrichmentKeywords.html":{"name":"NluEnrichmentKeywords","abstract":"

An object specifying the Keyword enrichment and related parameters.

"},"Structs/NluEnrichmentRelations.html":{"name":"NluEnrichmentRelations","abstract":"

An object specifying the relations enrichment and related parameters.

"},"Structs/NluEnrichmentSemanticRoles.html":{"name":"NluEnrichmentSemanticRoles","abstract":"

An object specifiying the semantic roles enrichment and related parameters.

"},"Structs/NluEnrichmentSentiment.html":{"name":"NluEnrichmentSentiment","abstract":"

An object specifying the sentiment extraction enrichment and related parameters.

"},"Structs/NormalizationOperation.html":{"name":"NormalizationOperation","abstract":"

NormalizationOperation.

"},"Structs/Notice.html":{"name":"Notice","abstract":"

A notice produced for the collection.

"},"Structs/PdfHeadingDetection.html":{"name":"PdfHeadingDetection","abstract":"

PdfHeadingDetection.

"},"Structs/PdfSettings.html":{"name":"PdfSettings","abstract":"

A list of PDF conversion settings.

"},"Structs/QueryEntities.html":{"name":"QueryEntities","abstract":"

QueryEntities.

"},"Structs/QueryEntitiesContext.html":{"name":"QueryEntitiesContext","abstract":"

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

"},"Structs/QueryEntitiesEntity.html":{"name":"QueryEntitiesEntity","abstract":"

A text string that appears within the entity text field.

"},"Structs/QueryEntitiesResponse.html":{"name":"QueryEntitiesResponse","abstract":"

An array of entities resulting from the query.

"},"Structs/QueryEntitiesResponseItem.html":{"name":"QueryEntitiesResponseItem","abstract":"

Object containing Entity query response information.

"},"Structs/QueryEvidence.html":{"name":"QueryEvidence","abstract":"

Description of evidence location supporting Knoweldge Graph query result.

"},"Structs/QueryEvidenceEntity.html":{"name":"QueryEvidenceEntity","abstract":"

Entity description and location within evidence field.

"},"Structs/QueryFilterType.html":{"name":"QueryFilterType","abstract":"

QueryFilterType.

"},"Structs/QueryNoticesResponse.html":{"name":"QueryNoticesResponse","abstract":"

QueryNoticesResponse.

"},"Structs/QueryNoticesResult.html":{"name":"QueryNoticesResult","abstract":"

QueryNoticesResult.

"},"Structs/QueryPassages.html":{"name":"QueryPassages","abstract":"

QueryPassages.

"},"Structs/QueryRelations.html":{"name":"QueryRelations","abstract":"

A respresentation of a relationship query.

"},"Structs/QueryRelationsArgument.html":{"name":"QueryRelationsArgument","abstract":"

QueryRelationsArgument.

"},"Structs/QueryRelationsEntity.html":{"name":"QueryRelationsEntity","abstract":"

QueryRelationsEntity.

"},"Structs/QueryRelationsFilter.html":{"name":"QueryRelationsFilter","abstract":"

QueryRelationsFilter.

"},"Structs/QueryRelationsRelationship.html":{"name":"QueryRelationsRelationship","abstract":"

QueryRelationsRelationship.

"},"Structs/QueryRelationsResponse.html":{"name":"QueryRelationsResponse","abstract":"

QueryRelationsResponse.

"},"Structs/QueryResponse.html":{"name":"QueryResponse","abstract":"

A response containing the documents and aggregations for the query.

"},"Structs/QueryResult.html":{"name":"QueryResult","abstract":"

QueryResult.

"},"Structs/QueryResultMetadata.html":{"name":"QueryResultMetadata","abstract":"

Metadata of a query result.

"},"Structs/SegmentSettings.html":{"name":"SegmentSettings","abstract":"

A list of Document Segmentation settings.

"},"Structs/Term.html":{"name":"Term","abstract":"

Term.

"},"Structs/TestDocument.html":{"name":"TestDocument","abstract":"

TestDocument.

"},"Structs/Timeslice.html":{"name":"Timeslice","abstract":"

Timeslice.

"},"Structs/TopHits.html":{"name":"TopHits","abstract":"

TopHits.

"},"Structs/TopHitsResults.html":{"name":"TopHitsResults","abstract":"

TopHitsResults.

"},"Structs/TrainingDataSet.html":{"name":"TrainingDataSet","abstract":"

TrainingDataSet.

"},"Structs/TrainingExample.html":{"name":"TrainingExample","abstract":"

TrainingExample.

"},"Structs/TrainingExampleList.html":{"name":"TrainingExampleList","abstract":"

TrainingExampleList.

"},"Structs/TrainingQuery.html":{"name":"TrainingQuery","abstract":"

TrainingQuery.

"},"Structs/TrainingStatus.html":{"name":"TrainingStatus","abstract":"

TrainingStatus.

"},"Structs/WordHeadingDetection.html":{"name":"WordHeadingDetection","abstract":"

WordHeadingDetection.

"},"Structs/WordSettings.html":{"name":"WordSettings","abstract":"

A list of Word conversion settings.

"},"Structs/WordStyle.html":{"name":"WordStyle","abstract":"

WordStyle.

"},"Structs/XPathPatterns.html":{"name":"XPathPatterns","abstract":"

XPathPatterns.

"},"Structs.html#/s:11DiscoveryV111JSONWrapperV":{"name":"JSONWrapper","abstract":"

Used internally to serialize and deserialize JSON."},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO013serializationD0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO08encodingD0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO011fileManagerD0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:11DiscoveryV14JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO4termAcA4TermVcACmF":{"name":"term","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO6filterAcA6FilterVcACmF":{"name":"filter","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO6nestedAcA6NestedVcACmF":{"name":"nested","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO9histogramAcA9HistogramVcACmF":{"name":"histogram","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO9timesliceAcA9TimesliceVcACmF":{"name":"timeslice","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO7topHitsAcA03TopF0VcACmF":{"name":"topHits","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO11uniqueCountAcA11CalculationVcACmF":{"name":"uniqueCount","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO3maxAcA11CalculationVcACmF":{"name":"max","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO3minAcA11CalculationVcACmF":{"name":"min","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO7averageAcA11CalculationVcACmF":{"name":"average","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO3sumAcA11CalculationVcACmF":{"name":"sum","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO7genericAcA07GenericcD0VcACmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html":{"name":"QueryAggregation","abstract":"

An aggregation produced by the Discovery service to analyze the input provided.

"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/Discovery.html#/s:11DiscoveryV10A0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

Create a Discovery object.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a Discovery object.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a Discovery object.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C17createEnvironmentySS4name_SSSg11descriptionSiSg4sizes10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createEnvironment(name:description:size:headers:failure:success:)","abstract":"

Create an environment.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16listEnvironmentsySSSg4name_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA04ListD8ResponseVc7successtF":{"name":"listEnvironments(name:headers:failure:success:)","abstract":"

List environments.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14getEnvironmentySS13environmentID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getEnvironment(environmentID:headers:failure:success:)","abstract":"

Get environment info.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C17updateEnvironmentySS13environmentID_SSSg4nameAF11descriptions10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateEnvironment(environmentID:name:description:headers:failure:success:)","abstract":"

Update an environment.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C17deleteEnvironmentySS13environmentID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteD8ResponseVc7successtF":{"name":"deleteEnvironment(environmentID:headers:failure:success:)","abstract":"

Delete environment.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C10listFieldsySS13environmentID_SaySSG13collectionIdss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA014ListCollectionD8ResponseVc7successtF":{"name":"listFields(environmentID:collectionIds:headers:failure:success:)","abstract":"

List fields across collections.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C19createConfigurationySS13environmentID_AA0D0V13configurations10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAGc7successtF":{"name":"createConfiguration(environmentID:configuration:headers:failure:success:)","abstract":"

Add configuration.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C18listConfigurationsySS13environmentID_SSSg4names10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA04ListD8ResponseVc7successtF":{"name":"listConfigurations(environmentID:name:headers:failure:success:)","abstract":"

List configurations.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16getConfigurationySS13environmentID_SS013configurationF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getConfiguration(environmentID:configurationID:headers:failure:success:)","abstract":"

Get configuration details.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C19updateConfigurationySS13environmentID_SS013configurationF0AA0D0V0G0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAHc7successtF":{"name":"updateConfiguration(environmentID:configurationID:configuration:headers:failure:success:)","abstract":"

Update a configuration.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C19deleteConfigurationySS13environmentID_SS013configurationF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteD8ResponseVc7successtF":{"name":"deleteConfiguration(environmentID:configurationID:headers:failure:success:)","abstract":"

Delete a configuration.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C30testConfigurationInEnvironmentySS13environmentID_SSSg13configurationAF4stepAF0iH010Foundation3URLVSg4fileAF8metadataAF0M11ContentTypes10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA12TestDocumentVc7successtF":{"name":"testConfigurationInEnvironment(environmentID:configuration:step:configurationID:file:metadata:fileContentType:headers:failure:success:)","abstract":"

Test configuration.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16createCollectionySS13environmentID_AA06CreateD7RequestV10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createCollection(environmentID:properties:headers:failure:success:)","abstract":"

Create a collection.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C15listCollectionsySS13environmentID_SSSg4names10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA04ListD8ResponseVc7successtF":{"name":"listCollections(environmentID:name:headers:failure:success:)","abstract":"

List collections.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C13getCollectionySS13environmentID_SS010collectionF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getCollection(environmentID:collectionID:headers:failure:success:)","abstract":"

Get collection details.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16updateCollectionySS13environmentID_SS010collectionF0SS4nameSSSg11descriptionAH013configurationF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateCollection(environmentID:collectionID:name:description:configurationID:headers:failure:success:)","abstract":"

Update a collection.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16deleteCollectionySS13environmentID_SS010collectionF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteD8ResponseVc7successtF":{"name":"deleteCollection(environmentID:collectionID:headers:failure:success:)","abstract":"

Delete a collection.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C20listCollectionFieldsySS13environmentID_SS010collectionG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA04ListdE8ResponseVc7successtF":{"name":"listCollectionFields(environmentID:collectionID:headers:failure:success:)","abstract":"

List collection fields.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14listExpansionsySS13environmentID_SS010collectionF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"listExpansions(environmentID:collectionID:headers:failure:success:)","abstract":"

Get the expansion list.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16createExpansionsySS13environmentID_SS010collectionF0SayAA9ExpansionVG10expansionss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createExpansions(environmentID:collectionID:expansions:headers:failure:success:)","abstract":"

Create or update expansion list.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16deleteExpansionsySS13environmentID_SS010collectionF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteExpansions(environmentID:collectionID:headers:failure:success:)","abstract":"

Delete the expansion list.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C11addDocumentySS13environmentID_SS010collectionF010Foundation3URLVSg4fileSSSg8metadataAL0J11ContentTypes10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D8AcceptedVc7successtF":{"name":"addDocument(environmentID:collectionID:file:metadata:fileContentType:headers:failure:success:)","abstract":"

Add a document.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C17getDocumentStatusySS13environmentID_SS010collectionG0SS08documentG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"getDocumentStatus(environmentID:collectionID:documentID:headers:failure:success:)","abstract":"

Get document details.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14updateDocumentySS13environmentID_SS010collectionF0SS08documentF010Foundation3URLVSg4fileSSSg8metadataAM0K11ContentTypes10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D8AcceptedVc7successtF":{"name":"updateDocument(environmentID:collectionID:documentID:file:metadata:fileContentType:headers:failure:success:)","abstract":"

Update a document.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14deleteDocumentySS13environmentID_SS010collectionF0SS08documentF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteD8ResponseVc7successtF":{"name":"deleteDocument(environmentID:collectionID:documentID:headers:failure:success:)","abstract":"

Delete a document.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C5queryySS13environmentID_SS010collectionE0SSSg6filterAgdG20naturalLanguageQuerySbSg8passagesAG11aggregationSiSg5countSaySSGSg12returnFieldsAM6offsetAP4sortAJ9highlightAP0kO0AM0K5CountAM0K10CharactersAJ11deduplicateAG0U5FieldAJ7similarAP0W11DocumentIdsAP0wO0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0J8ResponseVc7successtF":{"name":"query(environmentID:collectionID:filter:query:naturalLanguageQuery:passages:aggregation:count:returnFields:offset:sort:highlight:passagesFields:passagesCount:passagesCharacters:deduplicate:deduplicateField:similar:similarDocumentIds:similarFields:headers:failure:success:)","abstract":"

Query your collection.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C12queryNoticesySS13environmentID_SS010collectionF0SSSg6filterAG0C0AG20naturalLanguageQuerySbSg8passagesAG11aggregationSiSg5countSaySSGSg12returnFieldsAN6offsetAQ4sortAK9highlightAQ0lP0AN0L5CountAN0L10CharactersAG16deduplicateFieldAK7similarAQ0X11DocumentIdsAQ0xP0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0kD8ResponseVc7successtF":{"name":"queryNotices(environmentID:collectionID:filter:query:naturalLanguageQuery:passages:aggregation:count:returnFields:offset:sort:highlight:passagesFields:passagesCount:passagesCharacters:deduplicateField:similar:similarDocumentIds:similarFields:headers:failure:success:)","abstract":"

Query system notices.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14federatedQueryySS13environmentID_SaySSG13collectionIdsSSSg6filterAH5queryAH015naturalLanguageD0AH11aggregationSiSg5countAFSg12returnFieldsAM6offsetAO4sortSbSg9highlightAS11deduplicateAH0T5FieldAS7similarAO0v8DocumentH0AO0vP0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D8ResponseVc7successtF":{"name":"federatedQuery(environmentID:collectionIds:filter:query:naturalLanguageQuery:aggregation:count:returnFields:offset:sort:highlight:deduplicate:deduplicateField:similar:similarDocumentIds:similarFields:headers:failure:success:)","abstract":"

Query documents in multiple collections.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C21federatedQueryNoticesySS13environmentID_SaySSG13collectionIdsSSSg6filterAH5queryAH015naturalLanguageD0AH11aggregationSiSg5countAFSg12returnFieldsAM6offsetAO4sortSbSg9highlightAH16deduplicateFieldAS7similarAO0w8DocumentI0AO0wQ0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE8ResponseVc7successtF":{"name":"federatedQueryNotices(environmentID:collectionIds:filter:query:naturalLanguageQuery:aggregation:count:returnFields:offset:sort:highlight:deduplicateField:similar:similarDocumentIds:similarFields:headers:failure:success:)","abstract":"

Query multiple collection system notices.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C13queryEntitiesySS13environmentID_SS010collectionF0AA05QueryD0V06entityH0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0hD8ResponseVc7successtF":{"name":"queryEntities(environmentID:collectionID:entityQuery:headers:failure:success:)","abstract":"

Knowledge Graph entity query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14queryRelationsySS13environmentID_SS010collectionF0AA05QueryD0V012relationshipH0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0hD8ResponseVc7successtF":{"name":"queryRelations(environmentID:collectionID:relationshipQuery:headers:failure:success:)","abstract":"

Knowledge Graph relationship query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16listTrainingDataySS13environmentID_SS010collectionG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE3SetVc7successtF":{"name":"listTrainingData(environmentID:collectionID:headers:failure:success:)","abstract":"

List training data.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C15addTrainingDataySS13environmentID_SS010collectionG0SSSg20naturalLanguageQueryAG6filterSayAA0D7ExampleVGSg8exampless10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dK0Vc7successtF":{"name":"addTrainingData(environmentID:collectionID:naturalLanguageQuery:filter:examples:headers:failure:success:)","abstract":"

Add query to training data.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C21deleteAllTrainingDataySS13environmentID_SS010collectionH0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteAllTrainingData(environmentID:collectionID:headers:failure:success:)","abstract":"

Delete all training data.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C15getTrainingDataySS13environmentID_SS010collectionG0SS05queryG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D5QueryVc7successtF":{"name":"getTrainingData(environmentID:collectionID:queryID:headers:failure:success:)","abstract":"

Get details about a query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C18deleteTrainingDataySS13environmentID_SS010collectionG0SS05queryG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteTrainingData(environmentID:collectionID:queryID:headers:failure:success:)","abstract":"

Delete a training data query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C20listTrainingExamplesySS13environmentID_SS010collectionG0SS05queryG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D11ExampleListVc7successtF":{"name":"listTrainingExamples(environmentID:collectionID:queryID:headers:failure:success:)","abstract":"

List examples for a training data query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C21createTrainingExampleySS13environmentID_SS010collectionG0SS05queryG0SSSg08documentG0AH14crossReferenceSiSg9relevances10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"createTrainingExample(environmentID:collectionID:queryID:documentID:crossReference:relevance:headers:failure:success:)","abstract":"

Add example to training data query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C21deleteTrainingExampleySS13environmentID_SS010collectionG0SS05queryG0SS07exampleG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteTrainingExample(environmentID:collectionID:queryID:exampleID:headers:failure:success:)","abstract":"

Delete example for training data query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C21updateTrainingExampleySS13environmentID_SS010collectionG0SS05queryG0SS07exampleG0SSSg14crossReferenceSiSg9relevances10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"updateTrainingExample(environmentID:collectionID:queryID:exampleID:crossReference:relevance:headers:failure:success:)","abstract":"

Change label or cross reference for example.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C18getTrainingExampleySS13environmentID_SS010collectionG0SS05queryG0SS07exampleG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"getTrainingExample(environmentID:collectionID:queryID:exampleID:headers:failure:success:)","abstract":"

Get details for training data example.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

Delete labeled data.

","parent_name":"Discovery"},"Classes/Discovery.html":{"name":"Discovery","abstract":"

The IBM Watson Discovery Service is a cognitive search and content analytics engine that you can add to applications to"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file +{"Structs/XPathPatterns.html#/s:11DiscoveryV113XPathPatternsV6xpathsSaySSGSgvp":{"name":"xpaths","abstract":"

Undocumented

","parent_name":"XPathPatterns"},"Structs/XPathPatterns.html#/s:11DiscoveryV113XPathPatternsVACSaySSGSg6xpaths_tcfc":{"name":"init(xpaths:)","abstract":"

Initialize a XPathPatterns with member variables.

","parent_name":"XPathPatterns"},"Structs/WordStyle.html#/s:11DiscoveryV19WordStyleV5levelSiSgvp":{"name":"level","abstract":"

Undocumented

","parent_name":"WordStyle"},"Structs/WordStyle.html#/s:11DiscoveryV19WordStyleV5namesSaySSGSgvp":{"name":"names","abstract":"

Undocumented

","parent_name":"WordStyle"},"Structs/WordStyle.html#/s:11DiscoveryV19WordStyleVACSiSg5level_SaySSGSg5namestcfc":{"name":"init(level:names:)","abstract":"

Initialize a WordStyle with member variables.

","parent_name":"WordStyle"},"Structs/WordSettings.html#/s:11DiscoveryV112WordSettingsV7headingAA0C16HeadingDetectionVSgvp":{"name":"heading","abstract":"

Undocumented

","parent_name":"WordSettings"},"Structs/WordSettings.html#/s:11DiscoveryV112WordSettingsVAcA0C16HeadingDetectionVSg7heading_tcfc":{"name":"init(heading:)","abstract":"

Initialize a WordSettings with member variables.

","parent_name":"WordSettings"},"Structs/WordHeadingDetection.html#/s:11DiscoveryV120WordHeadingDetectionV5fontsSayAA11FontSettingVGSgvp":{"name":"fonts","abstract":"

Undocumented

","parent_name":"WordHeadingDetection"},"Structs/WordHeadingDetection.html#/s:11DiscoveryV120WordHeadingDetectionV6stylesSayAA0C5StyleVGSgvp":{"name":"styles","abstract":"

Undocumented

","parent_name":"WordHeadingDetection"},"Structs/WordHeadingDetection.html#/s:11DiscoveryV120WordHeadingDetectionVACSayAA11FontSettingVGSg5fonts_SayAA0C5StyleVGSg6stylestcfc":{"name":"init(fonts:styles:)","abstract":"

Initialize a WordHeadingDetection with member variables.

","parent_name":"WordHeadingDetection"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV13totalExamplesSiSgvp":{"name":"totalExamples","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV9availableSbSgvp":{"name":"available","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV10processingSbSgvp":{"name":"processing","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV19minimumQueriesAddedSbSgvp":{"name":"minimumQueriesAdded","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV20minimumExamplesAddedSbSgvp":{"name":"minimumExamplesAdded","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV24sufficientLabelDiversitySbSgvp":{"name":"sufficientLabelDiversity","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV7noticesSiSgvp":{"name":"notices","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV19successfullyTrainedSSSgvp":{"name":"successfullyTrained","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV11dataUpdatedSSSgvp":{"name":"dataUpdated","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingQuery.html#/s:11DiscoveryV113TrainingQueryV7queryIDSSSgvp":{"name":"queryID","abstract":"

Undocumented

","parent_name":"TrainingQuery"},"Structs/TrainingQuery.html#/s:11DiscoveryV113TrainingQueryV015naturalLanguageD0SSSgvp":{"name":"naturalLanguageQuery","abstract":"

Undocumented

","parent_name":"TrainingQuery"},"Structs/TrainingQuery.html#/s:11DiscoveryV113TrainingQueryV6filterSSSgvp":{"name":"filter","abstract":"

Undocumented

","parent_name":"TrainingQuery"},"Structs/TrainingQuery.html#/s:11DiscoveryV113TrainingQueryV8examplesSayAA0C7ExampleVGSgvp":{"name":"examples","abstract":"

Undocumented

","parent_name":"TrainingQuery"},"Structs/TrainingExampleList.html#/s:11DiscoveryV119TrainingExampleListV8examplesSayAA0cD0VGSgvp":{"name":"examples","abstract":"

Undocumented

","parent_name":"TrainingExampleList"},"Structs/TrainingExample.html#/s:11DiscoveryV115TrainingExampleV10documentIDSSSgvp":{"name":"documentID","abstract":"

Undocumented

","parent_name":"TrainingExample"},"Structs/TrainingExample.html#/s:11DiscoveryV115TrainingExampleV14crossReferenceSSSgvp":{"name":"crossReference","abstract":"

Undocumented

","parent_name":"TrainingExample"},"Structs/TrainingExample.html#/s:11DiscoveryV115TrainingExampleV9relevanceSiSgvp":{"name":"relevance","abstract":"

Undocumented

","parent_name":"TrainingExample"},"Structs/TrainingExample.html#/s:11DiscoveryV115TrainingExampleVACSSSg10documentID_AD14crossReferenceSiSg9relevancetcfc":{"name":"init(documentID:crossReference:relevance:)","abstract":"

Initialize a TrainingExample with member variables.

","parent_name":"TrainingExample"},"Structs/TrainingDataSet.html#/s:11DiscoveryV115TrainingDataSetV13environmentIDSSSgvp":{"name":"environmentID","abstract":"

Undocumented

","parent_name":"TrainingDataSet"},"Structs/TrainingDataSet.html#/s:11DiscoveryV115TrainingDataSetV12collectionIDSSSgvp":{"name":"collectionID","abstract":"

Undocumented

","parent_name":"TrainingDataSet"},"Structs/TrainingDataSet.html#/s:11DiscoveryV115TrainingDataSetV7queriesSayAA0C5QueryVGSgvp":{"name":"queries","abstract":"

Undocumented

","parent_name":"TrainingDataSet"},"Structs/TopHitsResults.html#/s:11DiscoveryV114TopHitsResultsV08matchingE0SiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"TopHitsResults"},"Structs/TopHitsResults.html#/s:11DiscoveryV114TopHitsResultsV4hitsSayAA11QueryResultVGSgvp":{"name":"hits","abstract":"

Top results returned by the aggregation.

","parent_name":"TopHitsResults"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"TopHits"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"TopHits"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"TopHits"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"TopHits"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV4sizeSiSgvp":{"name":"size","abstract":"

Number of top hits returned by the aggregation.

","parent_name":"TopHits"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV4hitsAA0cD7ResultsVSgvp":{"name":"hits","abstract":"

Undocumented

","parent_name":"TopHits"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV5fieldSSSgvp":{"name":"field","abstract":"

The field where the aggregation is located in the document.

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV8intervalSSSgvp":{"name":"interval","abstract":"

Interval of the aggregation. Valid date interval values are second/seconds minute/minutes, hour/hours, day/days,","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV7anomalySbSgvp":{"name":"anomaly","abstract":"

Used to inducate that anomaly detection should be performed. Anomaly detection is used to locate unusual datapoints","parent_name":"Timeslice"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV15configurationIDSSSgvp":{"name":"configurationID","abstract":"

The unique identifier for the configuration.

","parent_name":"TestDocument"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV6statusSSSgvp":{"name":"status","abstract":"

Status of the preview operation.

","parent_name":"TestDocument"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV18enrichedFieldUnitsSiSgvp":{"name":"enrichedFieldUnits","abstract":"

The number of 10-kB chunks of field data that were enriched. This can be used to estimate the cost of running a","parent_name":"TestDocument"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV17originalMediaTypeSSSgvp":{"name":"originalMediaType","abstract":"

Format of the test document.

","parent_name":"TestDocument"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV9snapshotsSayAA0D8SnapshotVGSgvp":{"name":"snapshots","abstract":"

An array of objects that describe each step in the preview process.

","parent_name":"TestDocument"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV7noticesSayAA6NoticeVGSgvp":{"name":"notices","abstract":"

An array of notice messages about the preview operation.

","parent_name":"TestDocument"},"Structs/Term.html#/s:11DiscoveryV14TermV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Term"},"Structs/Term.html#/s:11DiscoveryV14TermV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Term"},"Structs/Term.html#/s:11DiscoveryV14TermV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Term"},"Structs/Term.html#/s:11DiscoveryV14TermV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Term"},"Structs/Term.html#/s:11DiscoveryV14TermV5fieldSSSgvp":{"name":"field","abstract":"

The field where the aggregation is located in the document.

","parent_name":"Term"},"Structs/Term.html#/s:11DiscoveryV14TermV5countSiSgvp":{"name":"count","abstract":"

Undocumented

","parent_name":"Term"},"Structs/SegmentSettings.html#/s:11DiscoveryV115SegmentSettingsV7enabledSbSgvp":{"name":"enabled","abstract":"

Enables/disables the Document Segmentation feature.

","parent_name":"SegmentSettings"},"Structs/SegmentSettings.html#/s:11DiscoveryV115SegmentSettingsV12selectorTagsSaySSGSgvp":{"name":"selectorTags","abstract":"

Defines the heading level that splits into document segments. Valid values are h1, h2, h3, h4, h5, h6.

","parent_name":"SegmentSettings"},"Structs/SegmentSettings.html#/s:11DiscoveryV115SegmentSettingsVACSbSg7enabled_SaySSGSg12selectorTagstcfc":{"name":"init(enabled:selectorTags:)","abstract":"

Initialize a SegmentSettings with member variables.

","parent_name":"SegmentSettings"},"Structs/QueryResultMetadata.html#/s:11DiscoveryV119QueryResultMetadataV5scoreSdSgvp":{"name":"score","abstract":"

The confidence score of the result’s analysis. A higher score indicating greater confidence.

","parent_name":"QueryResultMetadata"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV2idSSSgvp":{"name":"id","abstract":"

The unique identifier of the document.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV5scoreSdSgvp":{"name":"score","abstract":"

Deprecated* This field is now part of the result_metadata object.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Metadata of the document.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV12collectionIDSSSgvp":{"name":"collectionID","abstract":"

The collection ID of the collection containing the document for this result.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV14resultMetadataAA0cdF0VSgvp":{"name":"resultMetadata","abstract":"

Metadata of the query result.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"QueryResult"},"Structs/QueryResponse.html#/s:11DiscoveryV113QueryResponseV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Undocumented

","parent_name":"QueryResponse"},"Structs/QueryResponse.html#/s:11DiscoveryV113QueryResponseV7resultsSayAA0C6ResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"QueryResponse"},"Structs/QueryResponse.html#/s:11DiscoveryV113QueryResponseV12aggregationsSayAA0C11AggregationOGSgvp":{"name":"aggregations","abstract":"

Undocumented

","parent_name":"QueryResponse"},"Structs/QueryResponse.html#/s:11DiscoveryV113QueryResponseV8passagesSayAA0C8PassagesVGSgvp":{"name":"passages","abstract":"

Undocumented

","parent_name":"QueryResponse"},"Structs/QueryResponse.html#/s:11DiscoveryV113QueryResponseV17duplicatesRemovedSiSgvp":{"name":"duplicatesRemoved","abstract":"

Undocumented

","parent_name":"QueryResponse"},"Structs/QueryRelationsResponse.html#/s:11DiscoveryV122QueryRelationsResponseV9relationsSayAA0cD12RelationshipVGSgvp":{"name":"relations","abstract":"

Undocumented

","parent_name":"QueryRelationsResponse"},"Structs/QueryRelationsRelationship.html#/s:11DiscoveryV126QueryRelationsRelationshipV4typeSSSgvp":{"name":"type","abstract":"

The identified relationship type.

","parent_name":"QueryRelationsRelationship"},"Structs/QueryRelationsRelationship.html#/s:11DiscoveryV126QueryRelationsRelationshipV9frequencySiSgvp":{"name":"frequency","abstract":"

The number of times the relationship is mentioned.

","parent_name":"QueryRelationsRelationship"},"Structs/QueryRelationsRelationship.html#/s:11DiscoveryV126QueryRelationsRelationshipV9argumentsSayAA0cD8ArgumentVGSgvp":{"name":"arguments","abstract":"

Information about the relationship.

","parent_name":"QueryRelationsRelationship"},"Structs/QueryRelationsRelationship.html#/s:11DiscoveryV126QueryRelationsRelationshipV8evidenceSayAA0C8EvidenceVGSgvp":{"name":"evidence","abstract":"

List of different evidentiary items to support the result.

","parent_name":"QueryRelationsRelationship"},"Structs/QueryRelationsFilter.html#/s:11DiscoveryV120QueryRelationsFilterV13relationTypesAA0cE4TypeVSgvp":{"name":"relationTypes","abstract":"

A list of relation types to include or exclude from the query.

","parent_name":"QueryRelationsFilter"},"Structs/QueryRelationsFilter.html#/s:11DiscoveryV120QueryRelationsFilterV11entityTypesAA0cE4TypeVSgvp":{"name":"entityTypes","abstract":"

A list of entity types to include or exclude from the query.

","parent_name":"QueryRelationsFilter"},"Structs/QueryRelationsFilter.html#/s:11DiscoveryV120QueryRelationsFilterV11documentIdsSaySSGSgvp":{"name":"documentIds","abstract":"

A comma-separated list of document IDs to include in the query.

","parent_name":"QueryRelationsFilter"},"Structs/QueryRelationsFilter.html#/s:11DiscoveryV120QueryRelationsFilterVAcA0cE4TypeVSg13relationTypes_AF06entityH0SaySSGSg11documentIdstcfc":{"name":"init(relationTypes:entityTypes:documentIds:)","abstract":"

Initialize a QueryRelationsFilter with member variables.

","parent_name":"QueryRelationsFilter"},"Structs/QueryRelationsEntity.html#/s:11DiscoveryV120QueryRelationsEntityV4textSSSgvp":{"name":"text","abstract":"

Entity text content.

","parent_name":"QueryRelationsEntity"},"Structs/QueryRelationsEntity.html#/s:11DiscoveryV120QueryRelationsEntityV4typeSSSgvp":{"name":"type","abstract":"

The type of the specified entity.

","parent_name":"QueryRelationsEntity"},"Structs/QueryRelationsEntity.html#/s:11DiscoveryV120QueryRelationsEntityV5exactSbSgvp":{"name":"exact","abstract":"

If false, implicit querying is performed. The default is false.

","parent_name":"QueryRelationsEntity"},"Structs/QueryRelationsEntity.html#/s:11DiscoveryV120QueryRelationsEntityVACSSSg4text_AD4typeSbSg5exacttcfc":{"name":"init(text:type:exact:)","abstract":"

Initialize a QueryRelationsEntity with member variables.

","parent_name":"QueryRelationsEntity"},"Structs/QueryRelationsArgument.html#/s:11DiscoveryV122QueryRelationsArgumentV8entitiesSayAA0C14EntitiesEntityVGSgvp":{"name":"entities","abstract":"

Undocumented

","parent_name":"QueryRelationsArgument"},"Structs/QueryRelations/Sort.html#/s:11DiscoveryV114QueryRelationsV4SortO5scoreA2EmF":{"name":"score","abstract":"

Undocumented

","parent_name":"Sort"},"Structs/QueryRelations/Sort.html#/s:11DiscoveryV114QueryRelationsV4SortO9frequencyA2EmF":{"name":"frequency","abstract":"

Undocumented

","parent_name":"Sort"},"Structs/QueryRelations/Sort.html":{"name":"Sort","abstract":"

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV8entitiesSayAA0cD6EntityVGSgvp":{"name":"entities","abstract":"

An array of entities to find relationships for.

","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV7contextAA0C15EntitiesContextVSgvp":{"name":"context","abstract":"

Entity text to provide context for the queried entity and rank based on that association. For example, if you","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV4sortSSSgvp":{"name":"sort","abstract":"

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV6filterAA0cD6FilterVSgvp":{"name":"filter","abstract":"

Filters to apply to the relationship query.

","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV5countSiSgvp":{"name":"count","abstract":"

The number of results to return. The default is 10. The maximum is 1000.

","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV13evidenceCountSiSgvp":{"name":"evidenceCount","abstract":"

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsVACSayAA0cD6EntityVGSg8entities_AA0C15EntitiesContextVSg7contextSSSg4sortAA0cD6FilterVSg6filterSiSg5countAS13evidenceCounttcfc":{"name":"init(entities:context:sort:filter:count:evidenceCount:)","abstract":"

Initialize a QueryRelations with member variables.

","parent_name":"QueryRelations"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV10documentIDSSSgvp":{"name":"documentID","abstract":"

The unique identifier of the document from which the passage has been extracted.

","parent_name":"QueryPassages"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV12passageScoreSdSgvp":{"name":"passageScore","abstract":"

The confidence score of the passages’s analysis. A higher score indicates greater confidence.

","parent_name":"QueryPassages"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV11passageTextSSSgvp":{"name":"passageText","abstract":"

The content of the extracted passage.

","parent_name":"QueryPassages"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV11startOffsetSiSgvp":{"name":"startOffset","abstract":"

The position of the first character of the extracted passage in the originating field.

","parent_name":"QueryPassages"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV9endOffsetSiSgvp":{"name":"endOffset","abstract":"

The position of the last character of the extracted passage in the originating field.

","parent_name":"QueryPassages"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV5fieldSSSgvp":{"name":"field","abstract":"

The label of the field from which the passage has been extracted.

","parent_name":"QueryPassages"},"Structs/QueryNoticesResult/FileType.html#/s:11DiscoveryV118QueryNoticesResultV8FileTypeO3pdfA2EmF":{"name":"pdf","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/QueryNoticesResult/FileType.html#/s:11DiscoveryV118QueryNoticesResultV8FileTypeO4htmlA2EmF":{"name":"html","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/QueryNoticesResult/FileType.html#/s:11DiscoveryV118QueryNoticesResultV8FileTypeO4wordA2EmF":{"name":"word","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/QueryNoticesResult/FileType.html#/s:11DiscoveryV118QueryNoticesResultV8FileTypeO4jsonA2EmF":{"name":"json","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/QueryNoticesResult/FileType.html":{"name":"FileType","abstract":"

The type of the original source file.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV2idSSSgvp":{"name":"id","abstract":"

The unique identifier of the document.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV5scoreSdSgvp":{"name":"score","abstract":"

Deprecated* This field is now part of the result_metadata object.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Metadata of the document.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV12collectionIDSSSgvp":{"name":"collectionID","abstract":"

The collection ID of the collection containing the document for this result.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV14resultMetadataAA0ceG0VSgvp":{"name":"resultMetadata","abstract":"

Metadata of the query result.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV4codeSiSgvp":{"name":"code","abstract":"

The internal status code returned by the ingestion subsystem indicating the overall result of ingesting the source","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV8filenameSSSgvp":{"name":"filename","abstract":"

Name of the original source file (if available).

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV8fileTypeSSSgvp":{"name":"fileType","abstract":"

The type of the original source file.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV4sha1SSSgvp":{"name":"sha1","abstract":"

The SHA-1 hash of the original source file (formatted as a hexadecimal string).

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV7noticesSayAA6NoticeVGSgvp":{"name":"notices","abstract":"

Array of notices for the document.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResponse.html#/s:11DiscoveryV120QueryNoticesResponseV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Undocumented

","parent_name":"QueryNoticesResponse"},"Structs/QueryNoticesResponse.html#/s:11DiscoveryV120QueryNoticesResponseV7resultsSayAA0cD6ResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"QueryNoticesResponse"},"Structs/QueryNoticesResponse.html#/s:11DiscoveryV120QueryNoticesResponseV12aggregationsSayAA0C11AggregationOGSgvp":{"name":"aggregations","abstract":"

Undocumented

","parent_name":"QueryNoticesResponse"},"Structs/QueryNoticesResponse.html#/s:11DiscoveryV120QueryNoticesResponseV8passagesSayAA0C8PassagesVGSgvp":{"name":"passages","abstract":"

Undocumented

","parent_name":"QueryNoticesResponse"},"Structs/QueryNoticesResponse.html#/s:11DiscoveryV120QueryNoticesResponseV17duplicatesRemovedSiSgvp":{"name":"duplicatesRemoved","abstract":"

Undocumented

","parent_name":"QueryNoticesResponse"},"Structs/QueryFilterType.html#/s:11DiscoveryV115QueryFilterTypeV7excludeSaySSGSgvp":{"name":"exclude","abstract":"

A comma-separated list of types to exclude.

","parent_name":"QueryFilterType"},"Structs/QueryFilterType.html#/s:11DiscoveryV115QueryFilterTypeV7includeSaySSGSgvp":{"name":"include","abstract":"

A comma-separated list of types to include. All other types are excluded.

","parent_name":"QueryFilterType"},"Structs/QueryFilterType.html#/s:11DiscoveryV115QueryFilterTypeVACSaySSGSg7exclude_AE7includetcfc":{"name":"init(exclude:include:)","abstract":"

Initialize a QueryFilterType with member variables.

","parent_name":"QueryFilterType"},"Structs/QueryEvidenceEntity.html#/s:11DiscoveryV119QueryEvidenceEntityV4typeSSSgvp":{"name":"type","abstract":"

The entity type for this entity. Possible types vary based on model used.

","parent_name":"QueryEvidenceEntity"},"Structs/QueryEvidenceEntity.html#/s:11DiscoveryV119QueryEvidenceEntityV4textSSSgvp":{"name":"text","abstract":"

The original text of this entity as found in the evidence field.

","parent_name":"QueryEvidenceEntity"},"Structs/QueryEvidenceEntity.html#/s:11DiscoveryV119QueryEvidenceEntityV11startOffsetSiSgvp":{"name":"startOffset","abstract":"

The start location of the entity text in the identified field. This value is inclusive.

","parent_name":"QueryEvidenceEntity"},"Structs/QueryEvidenceEntity.html#/s:11DiscoveryV119QueryEvidenceEntityV9endOffsetSiSgvp":{"name":"endOffset","abstract":"

The end location of the entity text in the identified field. This value is exclusive.

","parent_name":"QueryEvidenceEntity"},"Structs/QueryEvidence.html#/s:11DiscoveryV113QueryEvidenceV10documentIDSSSgvp":{"name":"documentID","abstract":"

The docuemnt ID (as indexed in Discovery) of the evidence location.

","parent_name":"QueryEvidence"},"Structs/QueryEvidence.html#/s:11DiscoveryV113QueryEvidenceV5fieldSSSgvp":{"name":"field","abstract":"

The field of the document where the supporting evidence was identified.

","parent_name":"QueryEvidence"},"Structs/QueryEvidence.html#/s:11DiscoveryV113QueryEvidenceV11startOffsetSiSgvp":{"name":"startOffset","abstract":"

The start location of the evidence in the identified field. This value is inclusive.

","parent_name":"QueryEvidence"},"Structs/QueryEvidence.html#/s:11DiscoveryV113QueryEvidenceV9endOffsetSiSgvp":{"name":"endOffset","abstract":"

The end location of the evidence in the identified field. This value is inclusive.

","parent_name":"QueryEvidence"},"Structs/QueryEvidence.html#/s:11DiscoveryV113QueryEvidenceV8entitiesSayAA0cD6EntityVGSgvp":{"name":"entities","abstract":"

An array of entity objects that show evidence of the result.

","parent_name":"QueryEvidence"},"Structs/QueryEntitiesResponseItem.html#/s:11DiscoveryV125QueryEntitiesResponseItemV4textSSSgvp":{"name":"text","abstract":"

Entity text content.

","parent_name":"QueryEntitiesResponseItem"},"Structs/QueryEntitiesResponseItem.html#/s:11DiscoveryV125QueryEntitiesResponseItemV4typeSSSgvp":{"name":"type","abstract":"

The type of the result entity.

","parent_name":"QueryEntitiesResponseItem"},"Structs/QueryEntitiesResponseItem.html#/s:11DiscoveryV125QueryEntitiesResponseItemV8evidenceSayAA0C8EvidenceVGSgvp":{"name":"evidence","abstract":"

List of different evidentiary items to support the result.

","parent_name":"QueryEntitiesResponseItem"},"Structs/QueryEntitiesResponse.html#/s:11DiscoveryV121QueryEntitiesResponseV8entitiesSayAA0cdE4ItemVGSgvp":{"name":"entities","abstract":"

Undocumented

","parent_name":"QueryEntitiesResponse"},"Structs/QueryEntitiesEntity.html#/s:11DiscoveryV119QueryEntitiesEntityV4textSSSgvp":{"name":"text","abstract":"

Entity text content.

","parent_name":"QueryEntitiesEntity"},"Structs/QueryEntitiesEntity.html#/s:11DiscoveryV119QueryEntitiesEntityV4typeSSSgvp":{"name":"type","abstract":"

The type of the specified entity.

","parent_name":"QueryEntitiesEntity"},"Structs/QueryEntitiesEntity.html#/s:11DiscoveryV119QueryEntitiesEntityVACSSSg4text_AD4typetcfc":{"name":"init(text:type:)","abstract":"

Initialize a QueryEntitiesEntity with member variables.

","parent_name":"QueryEntitiesEntity"},"Structs/QueryEntitiesContext.html#/s:11DiscoveryV120QueryEntitiesContextV4textSSSgvp":{"name":"text","abstract":"

Entity text to provide context for the queried entity and rank based on that association. For example, if you","parent_name":"QueryEntitiesContext"},"Structs/QueryEntitiesContext.html#/s:11DiscoveryV120QueryEntitiesContextVACSSSg4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a QueryEntitiesContext with member variables.

","parent_name":"QueryEntitiesContext"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesV7featureSSSgvp":{"name":"feature","abstract":"

The entity query feature to perform. Supported features are disambiguate and similar_entities.

","parent_name":"QueryEntities"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesV6entityAA0cD6EntityVSgvp":{"name":"entity","abstract":"

A text string that appears within the entity text field.

","parent_name":"QueryEntities"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesV7contextAA0cD7ContextVSgvp":{"name":"context","abstract":"

Entity text to provide context for the queried entity and rank based on that association. For example, if you","parent_name":"QueryEntities"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesV5countSiSgvp":{"name":"count","abstract":"

The number of results to return. The default is 10. The maximum is 1000.

","parent_name":"QueryEntities"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesV13evidenceCountSiSgvp":{"name":"evidenceCount","abstract":"

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items","parent_name":"QueryEntities"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesVACSSSg7feature_AA0cD6EntityVSg6entityAA0cD7ContextVSg7contextSiSg5countAN13evidenceCounttcfc":{"name":"init(feature:entity:context:count:evidenceCount:)","abstract":"

Initialize a QueryEntities with member variables.

","parent_name":"QueryEntities"},"Structs/PdfSettings.html#/s:11DiscoveryV111PdfSettingsV7headingAA0C16HeadingDetectionVSgvp":{"name":"heading","abstract":"

Undocumented

","parent_name":"PdfSettings"},"Structs/PdfSettings.html#/s:11DiscoveryV111PdfSettingsVAcA0C16HeadingDetectionVSg7heading_tcfc":{"name":"init(heading:)","abstract":"

Initialize a PdfSettings with member variables.

","parent_name":"PdfSettings"},"Structs/PdfHeadingDetection.html#/s:11DiscoveryV119PdfHeadingDetectionV5fontsSayAA11FontSettingVGSgvp":{"name":"fonts","abstract":"

Undocumented

","parent_name":"PdfHeadingDetection"},"Structs/PdfHeadingDetection.html#/s:11DiscoveryV119PdfHeadingDetectionVACSayAA11FontSettingVGSg5fonts_tcfc":{"name":"init(fonts:)","abstract":"

Initialize a PdfHeadingDetection with member variables.

","parent_name":"PdfHeadingDetection"},"Structs/Notice/Severity.html#/s:11DiscoveryV16NoticeV8SeverityO7warningA2EmF":{"name":"warning","abstract":"

Undocumented

","parent_name":"Severity"},"Structs/Notice/Severity.html#/s:11DiscoveryV16NoticeV8SeverityO5errorA2EmF":{"name":"error","abstract":"

Undocumented

","parent_name":"Severity"},"Structs/Notice/Severity.html":{"name":"Severity","abstract":"

Severity level of the notice.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV8noticeIDSSSgvp":{"name":"noticeID","abstract":"

Identifies the notice. Many notices might have the same ID. This field exists so that user applications can","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV7createdSSSgvp":{"name":"created","abstract":"

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

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV10documentIDSSSgvp":{"name":"documentID","abstract":"

Unique identifier of the document.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV7queryIDSSSgvp":{"name":"queryID","abstract":"

Unique identifier of the query used for relevance training.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV8severitySSSgvp":{"name":"severity","abstract":"

Severity level of the notice.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV4stepSSSgvp":{"name":"step","abstract":"

Ingestion or training step in which the notice occurred.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the notice.

","parent_name":"Notice"},"Structs/NormalizationOperation/Operation.html#/s:11DiscoveryV122NormalizationOperationV0D0O4copyA2EmF":{"name":"copy","abstract":"

Undocumented

","parent_name":"Operation"},"Structs/NormalizationOperation/Operation.html#/s:11DiscoveryV122NormalizationOperationV0D0O4moveA2EmF":{"name":"move","abstract":"

Undocumented

","parent_name":"Operation"},"Structs/NormalizationOperation/Operation.html#/s:11DiscoveryV122NormalizationOperationV0D0O5mergeA2EmF":{"name":"merge","abstract":"

Undocumented

","parent_name":"Operation"},"Structs/NormalizationOperation/Operation.html#/s:11DiscoveryV122NormalizationOperationV0D0O6removeA2EmF":{"name":"remove","abstract":"

Undocumented

","parent_name":"Operation"},"Structs/NormalizationOperation/Operation.html#/s:11DiscoveryV122NormalizationOperationV0D0O11removeNullsA2EmF":{"name":"removeNulls","abstract":"

Undocumented

","parent_name":"Operation"},"Structs/NormalizationOperation/Operation.html":{"name":"Operation","abstract":"

Identifies what type of operation to perform.","parent_name":"NormalizationOperation"},"Structs/NormalizationOperation.html#/s:11DiscoveryV122NormalizationOperationV9operationSSSgvp":{"name":"operation","abstract":"

Identifies what type of operation to perform.","parent_name":"NormalizationOperation"},"Structs/NormalizationOperation.html#/s:11DiscoveryV122NormalizationOperationV11sourceFieldSSSgvp":{"name":"sourceField","abstract":"

The source field for the operation.

","parent_name":"NormalizationOperation"},"Structs/NormalizationOperation.html#/s:11DiscoveryV122NormalizationOperationV16destinationFieldSSSgvp":{"name":"destinationField","abstract":"

The destination field for the operation.

","parent_name":"NormalizationOperation"},"Structs/NormalizationOperation.html#/s:11DiscoveryV122NormalizationOperationVACSSSg9operation_AD11sourceFieldAD011destinationG0tcfc":{"name":"init(operation:sourceField:destinationField:)","abstract":"

Initialize a NormalizationOperation with member variables.

","parent_name":"NormalizationOperation"},"Structs/NluEnrichmentSentiment.html#/s:11DiscoveryV122NluEnrichmentSentimentV8documentSbSgvp":{"name":"document","abstract":"

When true, sentiment analysis is performed on the entire field.

","parent_name":"NluEnrichmentSentiment"},"Structs/NluEnrichmentSentiment.html#/s:11DiscoveryV122NluEnrichmentSentimentV7targetsSaySSGSgvp":{"name":"targets","abstract":"

A comma-separated list of target strings that will have any associated sentiment analyzed.

","parent_name":"NluEnrichmentSentiment"},"Structs/NluEnrichmentSentiment.html#/s:11DiscoveryV122NluEnrichmentSentimentVACSbSg8document_SaySSGSg7targetstcfc":{"name":"init(document:targets:)","abstract":"

Initialize a NluEnrichmentSentiment with member variables.

","parent_name":"NluEnrichmentSentiment"},"Structs/NluEnrichmentSemanticRoles.html#/s:11DiscoveryV126NluEnrichmentSemanticRolesV8entitiesSbSgvp":{"name":"entities","abstract":"

When true entities are extracted from the identified sentence parts.

","parent_name":"NluEnrichmentSemanticRoles"},"Structs/NluEnrichmentSemanticRoles.html#/s:11DiscoveryV126NluEnrichmentSemanticRolesV8keywordsSbSgvp":{"name":"keywords","abstract":"

When true, keywords are extracted from the identified sentence parts.

","parent_name":"NluEnrichmentSemanticRoles"},"Structs/NluEnrichmentSemanticRoles.html#/s:11DiscoveryV126NluEnrichmentSemanticRolesV5limitSiSgvp":{"name":"limit","abstract":"

The maximum number of semantic roles enrichments to extact from each instance of the specified field.

","parent_name":"NluEnrichmentSemanticRoles"},"Structs/NluEnrichmentSemanticRoles.html#/s:11DiscoveryV126NluEnrichmentSemanticRolesVACSbSg8entities_AD8keywordsSiSg5limittcfc":{"name":"init(entities:keywords:limit:)","abstract":"

Initialize a NluEnrichmentSemanticRoles with member variables.

","parent_name":"NluEnrichmentSemanticRoles"},"Structs/NluEnrichmentRelations.html#/s:11DiscoveryV122NluEnrichmentRelationsV5modelSSSgvp":{"name":"model","abstract":"

For use with natural_language_understanding enrichments only. The enrichement model to use with relationship","parent_name":"NluEnrichmentRelations"},"Structs/NluEnrichmentRelations.html#/s:11DiscoveryV122NluEnrichmentRelationsVACSSSg5model_tcfc":{"name":"init(model:)","abstract":"

Initialize a NluEnrichmentRelations with member variables.

","parent_name":"NluEnrichmentRelations"},"Structs/NluEnrichmentKeywords.html#/s:11DiscoveryV121NluEnrichmentKeywordsV9sentimentSbSgvp":{"name":"sentiment","abstract":"

When true, sentiment analysis of keywords will be performed on the specified field.

","parent_name":"NluEnrichmentKeywords"},"Structs/NluEnrichmentKeywords.html#/s:11DiscoveryV121NluEnrichmentKeywordsV7emotionSbSgvp":{"name":"emotion","abstract":"

When true, emotion detection of keywords will be performed on the specified field.

","parent_name":"NluEnrichmentKeywords"},"Structs/NluEnrichmentKeywords.html#/s:11DiscoveryV121NluEnrichmentKeywordsV5limitSiSgvp":{"name":"limit","abstract":"

The maximum number of keywords to extract for each instance of the specified field.

","parent_name":"NluEnrichmentKeywords"},"Structs/NluEnrichmentKeywords.html#/s:11DiscoveryV121NluEnrichmentKeywordsVACSbSg9sentiment_AD7emotionSiSg5limittcfc":{"name":"init(sentiment:emotion:limit:)","abstract":"

Initialize a NluEnrichmentKeywords with member variables.

","parent_name":"NluEnrichmentKeywords"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV8keywordsAA0cD8KeywordsVSgvp":{"name":"keywords","abstract":"

An object specifying the Keyword enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV8entitiesAA0cD8EntitiesVSgvp":{"name":"entities","abstract":"

An object speficying the Entities enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV9sentimentAA0cD9SentimentVSgvp":{"name":"sentiment","abstract":"

An object specifying the sentiment extraction enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV7emotionAA0cD7EmotionVSgvp":{"name":"emotion","abstract":"

An object specifying the emotion detection enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV10categoriesAA0cD10CategoriesVSgvp":{"name":"categories","abstract":"

An object specifying the categories enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV13semanticRolesAA0cd8SemanticG0VSgvp":{"name":"semanticRoles","abstract":"

An object specifiying the semantic roles enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV9relationsAA0cD9RelationsVSgvp":{"name":"relations","abstract":"

An object specifying the relations enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesVAcA0cD8KeywordsVSg8keywords_AA0cD8EntitiesVSg8entitiesAA0cD9SentimentVSg9sentimentAA0cD7EmotionVSg7emotionAA0cD10CategoriesVSg10categoriesAA0cD13SemanticRolesVSg08semanticQ0AA0cD9RelationsVSg9relationstcfc":{"name":"init(keywords:entities:sentiment:emotion:categories:semanticRoles:relations:)","abstract":"

Initialize a NluEnrichmentFeatures with member variables.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV9sentimentSbSgvp":{"name":"sentiment","abstract":"

When true, sentiment analysis of entities will be performed on the specified field.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV7emotionSbSgvp":{"name":"emotion","abstract":"

When true, emotion detection of entities will be performed on the specified field.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV5limitSiSgvp":{"name":"limit","abstract":"

The maximum number of entities to extract for each instance of the specified field.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV8mentionsSbSgvp":{"name":"mentions","abstract":"

When true, the number of mentions of each identified entity is recorded. The default is false.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV12mentionTypesSbSgvp":{"name":"mentionTypes","abstract":"

When true, the types of mentions for each idetifieid entity is recorded. The default is false.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV16sentenceLocationSbSgvp":{"name":"sentenceLocation","abstract":"

When true, a list of sentence locations for each instance of each identified entity is recorded. The default is","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV5modelSSSgvp":{"name":"model","abstract":"

The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge Studio, the","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesVACSbSg9sentiment_AD7emotionSiSg5limitAD8mentionsAD12mentionTypesAD16sentenceLocationSSSg5modeltcfc":{"name":"init(sentiment:emotion:limit:mentions:mentionTypes:sentenceLocation:model:)","abstract":"

Initialize a NluEnrichmentEntities with member variables.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEmotion.html#/s:11DiscoveryV120NluEnrichmentEmotionV8documentSbSgvp":{"name":"document","abstract":"

When true, emotion detection is performed on the entire field.

","parent_name":"NluEnrichmentEmotion"},"Structs/NluEnrichmentEmotion.html#/s:11DiscoveryV120NluEnrichmentEmotionV7targetsSaySSGSgvp":{"name":"targets","abstract":"

A comma-separated list of target strings that will have any associated emotions detected.

","parent_name":"NluEnrichmentEmotion"},"Structs/NluEnrichmentEmotion.html#/s:11DiscoveryV120NluEnrichmentEmotionVACSbSg8document_SaySSGSg7targetstcfc":{"name":"init(document:targets:)","abstract":"

Initialize a NluEnrichmentEmotion with member variables.

","parent_name":"NluEnrichmentEmotion"},"Structs/NluEnrichmentCategories.html#/s:11DiscoveryV123NluEnrichmentCategoriesV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"NluEnrichmentCategories"},"Structs/NluEnrichmentCategories.html#/s:11DiscoveryV123NluEnrichmentCategoriesVACs10DictionaryVySSAA4JSONOG20additionalProperties_tcfc":{"name":"init(additionalProperties:)","abstract":"

Initialize a NluEnrichmentCategories.

","parent_name":"NluEnrichmentCategories"},"Structs/NluEnrichmentCategories.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"NluEnrichmentCategories"},"Structs/NluEnrichmentCategories.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"NluEnrichmentCategories"},"Structs/Nested.html#/s:11DiscoveryV16NestedV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Nested"},"Structs/Nested.html#/s:11DiscoveryV16NestedV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Nested"},"Structs/Nested.html#/s:11DiscoveryV16NestedV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Nested"},"Structs/Nested.html#/s:11DiscoveryV16NestedV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Nested"},"Structs/Nested.html#/s:11DiscoveryV16NestedV4pathSSSgvp":{"name":"path","abstract":"

The area of the results the aggregation was restricted to.

","parent_name":"Nested"},"Structs/MemoryUsage.html#/s:11DiscoveryV111MemoryUsageV9usedBytesSiSgvp":{"name":"usedBytes","abstract":"

Deprecated**: Number of bytes used in the environment’s memory capacity.

","parent_name":"MemoryUsage"},"Structs/MemoryUsage.html#/s:11DiscoveryV111MemoryUsageV10totalBytesSiSgvp":{"name":"totalBytes","abstract":"

Deprecated**: Total number of bytes available in the environment’s memory capacity.

","parent_name":"MemoryUsage"},"Structs/MemoryUsage.html#/s:11DiscoveryV111MemoryUsageV4usedSSSgvp":{"name":"used","abstract":"

Deprecated**: Amount of memory capacity used, in KB or GB format.

","parent_name":"MemoryUsage"},"Structs/MemoryUsage.html#/s:11DiscoveryV111MemoryUsageV5totalSSSgvp":{"name":"total","abstract":"

Deprecated**: Total amount of the environment’s memory capacity, in KB or GB format.

","parent_name":"MemoryUsage"},"Structs/MemoryUsage.html#/s:11DiscoveryV111MemoryUsageV11percentUsedSdSgvp":{"name":"percentUsed","abstract":"

Deprecated**: Percentage of the environment’s memory capacity that is being used.

","parent_name":"MemoryUsage"},"Structs/ListEnvironmentsResponse.html#/s:11DiscoveryV124ListEnvironmentsResponseV12environmentsSayAA11EnvironmentVGSgvp":{"name":"environments","abstract":"

An array of [environments] that are available for the service instance.

","parent_name":"ListEnvironmentsResponse"},"Structs/ListConfigurationsResponse.html#/s:11DiscoveryV126ListConfigurationsResponseV14configurationsSayAA13ConfigurationVGSgvp":{"name":"configurations","abstract":"

An array of Configurations that are available for the service instance.

","parent_name":"ListConfigurationsResponse"},"Structs/ListCollectionsResponse.html#/s:11DiscoveryV123ListCollectionsResponseV11collectionsSayAA10CollectionVGSgvp":{"name":"collections","abstract":"

An array containing information about each collection in the environment.

","parent_name":"ListCollectionsResponse"},"Structs/ListCollectionFieldsResponse.html#/s:11DiscoveryV128ListCollectionFieldsResponseV6fieldsSayAA5FieldVGSgvp":{"name":"fields","abstract":"

An array containing information about each field in the collections.

","parent_name":"ListCollectionFieldsResponse"},"Structs/IndexCapacity.html#/s:11DiscoveryV113IndexCapacityV9documentsAA20EnvironmentDocumentsVSgvp":{"name":"documents","abstract":"

Summary of the document usage statistics for the environment.

","parent_name":"IndexCapacity"},"Structs/IndexCapacity.html#/s:11DiscoveryV113IndexCapacityV9diskUsageAA04DiskF0VSgvp":{"name":"diskUsage","abstract":"

Summary of the disk usage of the environment.

","parent_name":"IndexCapacity"},"Structs/IndexCapacity.html#/s:11DiscoveryV113IndexCapacityV11collectionsAA15CollectionUsageVSgvp":{"name":"collections","abstract":"

Summary of the collection usage in the environment.

","parent_name":"IndexCapacity"},"Structs/IndexCapacity.html#/s:11DiscoveryV113IndexCapacityV11memoryUsageAA06MemoryF0VSgvp":{"name":"memoryUsage","abstract":"

Deprecated**: Summary of the memory usage of the environment.

","parent_name":"IndexCapacity"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV21excludeTagsCompletelySaySSGSgvp":{"name":"excludeTagsCompletely","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV22excludeTagsKeepContentSaySSGSgvp":{"name":"excludeTagsKeepContent","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV11keepContentAA13XPathPatternsVSgvp":{"name":"keepContent","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV14excludeContentAA13XPathPatternsVSgvp":{"name":"excludeContent","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV17keepTagAttributesSaySSGSgvp":{"name":"keepTagAttributes","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV20excludeTagAttributesSaySSGSgvp":{"name":"excludeTagAttributes","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsVACSaySSGSg21excludeTagsCompletely_AE0eF11KeepContentAA13XPathPatternsVSg04keepI0AJ0eI0AE0L13TagAttributesAE0emN0tcfc":{"name":"init(excludeTagsCompletely:excludeTagsKeepContent:keepContent:excludeContent:keepTagAttributes:excludeTagAttributes:)","abstract":"

Initialize a HtmlSettings with member variables.

","parent_name":"HtmlSettings"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Histogram"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Histogram"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Histogram"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Histogram"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV5fieldSSSgvp":{"name":"field","abstract":"

The field where the aggregation is located in the document.

","parent_name":"Histogram"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV8intervalSiSgvp":{"name":"interval","abstract":"

Interval of the aggregation. (For ‘histogram’ type).

","parent_name":"Histogram"},"Structs/GenericQueryAggregation.html#/s:11DiscoveryV123GenericQueryAggregationV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"GenericQueryAggregation"},"Structs/GenericQueryAggregation.html#/s:11DiscoveryV123GenericQueryAggregationV7resultsSayAA0E6ResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"GenericQueryAggregation"},"Structs/GenericQueryAggregation.html#/s:11DiscoveryV123GenericQueryAggregationV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"GenericQueryAggregation"},"Structs/GenericQueryAggregation.html#/s:11DiscoveryV123GenericQueryAggregationV12aggregationsSayAA0dE0OGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"GenericQueryAggregation"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV5levelSiSgvp":{"name":"level","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV7minSizeSiSgvp":{"name":"minSize","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV7maxSizeSiSgvp":{"name":"maxSize","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV4boldSbSgvp":{"name":"bold","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV6italicSbSgvp":{"name":"italic","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV4nameSSSgvp":{"name":"name","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingVACSiSg5level_AD7minSizeAD03maxG0SbSg4boldAH6italicSSSg4nametcfc":{"name":"init(level:minSize:maxSize:bold:italic:name:)","abstract":"

Initialize a FontSetting with member variables.

","parent_name":"FontSetting"},"Structs/Filter.html#/s:11DiscoveryV16FilterV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Filter"},"Structs/Filter.html#/s:11DiscoveryV16FilterV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Filter"},"Structs/Filter.html#/s:11DiscoveryV16FilterV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Filter"},"Structs/Filter.html#/s:11DiscoveryV16FilterV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Filter"},"Structs/Filter.html#/s:11DiscoveryV16FilterV5matchSSSgvp":{"name":"match","abstract":"

The match the aggregated results queried for.

","parent_name":"Filter"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO6nestedA2EmF":{"name":"nested","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO6stringA2EmF":{"name":"string","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO4dateA2EmF":{"name":"date","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO4longA2EmF":{"name":"long","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO7integerA2EmF":{"name":"integer","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO5shortA2EmF":{"name":"short","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO4byteA2EmF":{"name":"byte","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO6doubleA2EmF":{"name":"double","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO5floatA2EmF":{"name":"float","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO7booleanA2EmF":{"name":"boolean","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO6binaryA2EmF":{"name":"binary","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html":{"name":"FieldType","abstract":"

The type of the field.

","parent_name":"Field"},"Structs/Field.html#/s:11DiscoveryV15FieldV9fieldNameSSSgvp":{"name":"fieldName","abstract":"

The name of the field.

","parent_name":"Field"},"Structs/Field.html#/s:11DiscoveryV15FieldV9fieldTypeSSSgvp":{"name":"fieldType","abstract":"

The type of the field.

","parent_name":"Field"},"Structs/Expansions.html#/s:11DiscoveryV110ExpansionsV10expansionsSayAA9ExpansionVGvp":{"name":"expansions","abstract":"

An array of query expansion definitions.","parent_name":"Expansions"},"Structs/Expansions.html#/s:11DiscoveryV110ExpansionsVACSayAA9ExpansionVG10expansions_tcfc":{"name":"init(expansions:)","abstract":"

Initialize a Expansions with member variables.

","parent_name":"Expansions"},"Structs/Expansion.html#/s:11DiscoveryV19ExpansionV10inputTermsSaySSGSgvp":{"name":"inputTerms","abstract":"

A list of terms that will be expanded for this expansion. If specified, only the items in this list are expanded.

","parent_name":"Expansion"},"Structs/Expansion.html#/s:11DiscoveryV19ExpansionV13expandedTermsSaySSGvp":{"name":"expandedTerms","abstract":"

A list of terms that this expansion will be expanded to. If specified without input_terms, it also functions as","parent_name":"Expansion"},"Structs/Expansion.html#/s:11DiscoveryV19ExpansionVACSaySSG13expandedTerms_ADSg05inputE0tcfc":{"name":"init(expandedTerms:inputTerms:)","abstract":"

Initialize a Expansion with member variables.

","parent_name":"Expansion"},"Structs/EnvironmentDocuments.html#/s:11DiscoveryV120EnvironmentDocumentsV7indexedSiSgvp":{"name":"indexed","abstract":"

Number of documents indexed for the environment.

","parent_name":"EnvironmentDocuments"},"Structs/EnvironmentDocuments.html#/s:11DiscoveryV120EnvironmentDocumentsV14maximumAllowedSiSgvp":{"name":"maximumAllowed","abstract":"

Total number of documents allowed in the environment’s capacity.

","parent_name":"EnvironmentDocuments"},"Structs/Environment/Status.html#/s:11DiscoveryV111EnvironmentV6StatusO6activeA2EmF":{"name":"active","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Environment/Status.html#/s:11DiscoveryV111EnvironmentV6StatusO7pendingA2EmF":{"name":"pending","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Environment/Status.html#/s:11DiscoveryV111EnvironmentV6StatusO11maintenanceA2EmF":{"name":"maintenance","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Environment/Status.html":{"name":"Status","abstract":"

Status of the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV13environmentIDSSSgvp":{"name":"environmentID","abstract":"

Unique identifier for the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV4nameSSSgvp":{"name":"name","abstract":"

Name that identifies the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV11descriptionSSSgvp":{"name":"description","abstract":"

Description of the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV7createdSSSgvp":{"name":"created","abstract":"

Creation date of the environment, in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV7updatedSSSgvp":{"name":"updated","abstract":"

Date of most recent environment update, in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV6statusSSSgvp":{"name":"status","abstract":"

Status of the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV8readOnlySbSgvp":{"name":"readOnly","abstract":"

If true, then the environment contains read-only collections which are maintained by IBM.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV4sizeSiSgvp":{"name":"size","abstract":"

Deprecated**: Size of the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV13indexCapacityAA05IndexE0VSgvp":{"name":"indexCapacity","abstract":"

Details about the resource usage and capacity of the environment.

","parent_name":"Environment"},"Structs/EnrichmentOptions.html#/s:11DiscoveryV117EnrichmentOptionsV8featuresAA03NluC8FeaturesVSgvp":{"name":"features","abstract":"

An object representing the enrichment features that will be applied to the specified field.

","parent_name":"EnrichmentOptions"},"Structs/EnrichmentOptions.html#/s:11DiscoveryV117EnrichmentOptionsV5modelSSSgvp":{"name":"model","abstract":"

For use with elements enrichments only.* The element extraction model to use. Models available are: contract.

","parent_name":"EnrichmentOptions"},"Structs/EnrichmentOptions.html#/s:11DiscoveryV117EnrichmentOptionsVAcA03NluC8FeaturesVSg8features_SSSg5modeltcfc":{"name":"init(features:model:)","abstract":"

Initialize a EnrichmentOptions with member variables.

","parent_name":"EnrichmentOptions"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV11descriptionSSSgvp":{"name":"description","abstract":"

Describes what the enrichment step does.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV16destinationFieldSSvp":{"name":"destinationField","abstract":"

Field where enrichments will be stored. This field must already exist or be at most 1 level deeper than an existing","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV11sourceFieldSSvp":{"name":"sourceField","abstract":"

Field to be enriched.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV9overwriteSbSgvp":{"name":"overwrite","abstract":"

Indicates that the enrichments will overwrite the destination_field field if it already exists.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV14enrichmentNameSSvp":{"name":"enrichmentName","abstract":"

Name of the enrichment service to call. Current options are natural_language_understanding and elements.","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV22ignoreDownstreamErrorsSbSgvp":{"name":"ignoreDownstreamErrors","abstract":"

If true, then most errors generated during the enrichment process will be treated as warnings and will not cause","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV7optionsAA0C7OptionsVSgvp":{"name":"options","abstract":"

A list of options specific to the enrichment.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentVACSS16destinationField_SS06sourceE0SS14enrichmentNameSSSg11descriptionSbSg9overwriteAI22ignoreDownstreamErrorsAA0C7OptionsVSg7optionstcfc":{"name":"init(destinationField:sourceField:enrichmentName:description:overwrite:ignoreDownstreamErrors:options:)","abstract":"

Initialize a Enrichment with member variables.

","parent_name":"Enrichment"},"Structs/DocumentStatus/FileType.html#/s:11DiscoveryV114DocumentStatusV8FileTypeO3pdfA2EmF":{"name":"pdf","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/DocumentStatus/FileType.html#/s:11DiscoveryV114DocumentStatusV8FileTypeO4htmlA2EmF":{"name":"html","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/DocumentStatus/FileType.html#/s:11DiscoveryV114DocumentStatusV8FileTypeO4wordA2EmF":{"name":"word","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/DocumentStatus/FileType.html#/s:11DiscoveryV114DocumentStatusV8FileTypeO4jsonA2EmF":{"name":"json","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/DocumentStatus/Status.html#/s:11DiscoveryV114DocumentStatusV0D0O9availableA2EmF":{"name":"available","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DocumentStatus/Status.html#/s:11DiscoveryV114DocumentStatusV0D0O20availableWithNoticesA2EmF":{"name":"availableWithNotices","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DocumentStatus/Status.html#/s:11DiscoveryV114DocumentStatusV0D0O6failedA2EmF":{"name":"failed","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DocumentStatus/Status.html#/s:11DiscoveryV114DocumentStatusV0D0O10processingA2EmF":{"name":"processing","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DocumentStatus/Status.html":{"name":"Status","abstract":"

Status of the document in the ingestion process.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus/FileType.html":{"name":"FileType","abstract":"

The type of the original source file.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV10documentIDSSvp":{"name":"documentID","abstract":"

The unique identifier of the document.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV15configurationIDSSSgvp":{"name":"configurationID","abstract":"

The unique identifier for the configuration.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV7createdSSSgvp":{"name":"created","abstract":"

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

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV7updatedSSSgvp":{"name":"updated","abstract":"

Date of the most recent document update, in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV6statusSSvp":{"name":"status","abstract":"

Status of the document in the ingestion process.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV17statusDescriptionSSvp":{"name":"statusDescription","abstract":"

Description of the document status.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV8filenameSSSgvp":{"name":"filename","abstract":"

Name of the original source file (if available).

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV8fileTypeSSSgvp":{"name":"fileType","abstract":"

The type of the original source file.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV4sha1SSSgvp":{"name":"sha1","abstract":"

The SHA-1 hash of the original source file (formatted as a hexadecimal string).

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV7noticesSayAA6NoticeVGvp":{"name":"notices","abstract":"

Array of notices produced by the document-ingestion process.

","parent_name":"DocumentStatus"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO9htmlInputA2EmF":{"name":"htmlInput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO10htmlOutputA2EmF":{"name":"htmlOutput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO10jsonOutputA2EmF":{"name":"jsonOutput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO24jsonNormalizationsOutputA2EmF":{"name":"jsonNormalizationsOutput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO17enrichmentsOutputA2EmF":{"name":"enrichmentsOutput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO20normalizationsOutputA2EmF":{"name":"normalizationsOutput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html":{"name":"Step","abstract":"

Undocumented

","parent_name":"DocumentSnapshot"},"Structs/DocumentSnapshot.html#/s:11DiscoveryV116DocumentSnapshotV4stepSSSgvp":{"name":"step","abstract":"

Undocumented

","parent_name":"DocumentSnapshot"},"Structs/DocumentSnapshot.html#/s:11DiscoveryV116DocumentSnapshotV8snapshots10DictionaryVySSAA4JSONOGSgvp":{"name":"snapshot","abstract":"

Undocumented

","parent_name":"DocumentSnapshot"},"Structs/DocumentCounts.html#/s:11DiscoveryV114DocumentCountsV9availableSiSgvp":{"name":"available","abstract":"

The total number of available documents in the collection.

","parent_name":"DocumentCounts"},"Structs/DocumentCounts.html#/s:11DiscoveryV114DocumentCountsV10processingSiSgvp":{"name":"processing","abstract":"

The number of documents in the collection that are currently being processed.

","parent_name":"DocumentCounts"},"Structs/DocumentCounts.html#/s:11DiscoveryV114DocumentCountsV6failedSiSgvp":{"name":"failed","abstract":"

The number of documents in the collection that failed to be ingested.

","parent_name":"DocumentCounts"},"Structs/DocumentAccepted/Status.html#/s:11DiscoveryV116DocumentAcceptedV6StatusO10processingA2EmF":{"name":"processing","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DocumentAccepted/Status.html":{"name":"Status","abstract":"

Status of the document in the ingestion process.

","parent_name":"DocumentAccepted"},"Structs/DocumentAccepted.html#/s:11DiscoveryV116DocumentAcceptedV10documentIDSSSgvp":{"name":"documentID","abstract":"

The unique identifier of the ingested document.

","parent_name":"DocumentAccepted"},"Structs/DocumentAccepted.html#/s:11DiscoveryV116DocumentAcceptedV6statusSSSgvp":{"name":"status","abstract":"

Status of the document in the ingestion process.

","parent_name":"DocumentAccepted"},"Structs/DocumentAccepted.html#/s:11DiscoveryV116DocumentAcceptedV7noticesSayAA6NoticeVGSgvp":{"name":"notices","abstract":"

Array of notices produced by the document-ingestion process.

","parent_name":"DocumentAccepted"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV9usedBytesSiSgvp":{"name":"usedBytes","abstract":"

Number of bytes used on the environment’s disk capacity.

","parent_name":"DiskUsage"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV19maximumAllowedBytesSiSgvp":{"name":"maximumAllowedBytes","abstract":"

Total number of bytes available in the environment’s disk capacity.

","parent_name":"DiskUsage"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV10totalBytesSiSgvp":{"name":"totalBytes","abstract":"

Deprecated**: Total number of bytes available in the environment’s disk capacity.

","parent_name":"DiskUsage"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV4usedSSSgvp":{"name":"used","abstract":"

Deprecated**: Amount of disk capacity used, in KB or GB format.

","parent_name":"DiskUsage"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV5totalSSSgvp":{"name":"total","abstract":"

Deprecated**: Total amount of the environment’s disk capacity, in KB or GB format.

","parent_name":"DiskUsage"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV11percentUsedSdSgvp":{"name":"percentUsed","abstract":"

Deprecated**: Percentage of the environment’s disk capacity that is being used.

","parent_name":"DiskUsage"},"Structs/DeleteEnvironmentResponse/Status.html#/s:11DiscoveryV125DeleteEnvironmentResponseV6StatusO7deletedA2EmF":{"name":"deleted","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DeleteEnvironmentResponse/Status.html":{"name":"Status","abstract":"

Status of the environment.

","parent_name":"DeleteEnvironmentResponse"},"Structs/DeleteEnvironmentResponse.html#/s:11DiscoveryV125DeleteEnvironmentResponseV13environmentIDSSvp":{"name":"environmentID","abstract":"

The unique identifier for the environment.

","parent_name":"DeleteEnvironmentResponse"},"Structs/DeleteEnvironmentResponse.html#/s:11DiscoveryV125DeleteEnvironmentResponseV6statusSSvp":{"name":"status","abstract":"

Status of the environment.

","parent_name":"DeleteEnvironmentResponse"},"Structs/DeleteDocumentResponse/Status.html#/s:11DiscoveryV122DeleteDocumentResponseV6StatusO7deletedA2EmF":{"name":"deleted","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DeleteDocumentResponse/Status.html":{"name":"Status","abstract":"

Status of the document. A deleted document has the status deleted.

","parent_name":"DeleteDocumentResponse"},"Structs/DeleteDocumentResponse.html#/s:11DiscoveryV122DeleteDocumentResponseV10documentIDSSSgvp":{"name":"documentID","abstract":"

The unique identifier of the document.

","parent_name":"DeleteDocumentResponse"},"Structs/DeleteDocumentResponse.html#/s:11DiscoveryV122DeleteDocumentResponseV6statusSSSgvp":{"name":"status","abstract":"

Status of the document. A deleted document has the status deleted.

","parent_name":"DeleteDocumentResponse"},"Structs/DeleteConfigurationResponse/Status.html#/s:11DiscoveryV127DeleteConfigurationResponseV6StatusO7deletedA2EmF":{"name":"deleted","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DeleteConfigurationResponse/Status.html":{"name":"Status","abstract":"

Status of the configuration. A deleted configuration has the status deleted.

","parent_name":"DeleteConfigurationResponse"},"Structs/DeleteConfigurationResponse.html#/s:11DiscoveryV127DeleteConfigurationResponseV15configurationIDSSvp":{"name":"configurationID","abstract":"

The unique identifier for the configuration.

","parent_name":"DeleteConfigurationResponse"},"Structs/DeleteConfigurationResponse.html#/s:11DiscoveryV127DeleteConfigurationResponseV6statusSSvp":{"name":"status","abstract":"

Status of the configuration. A deleted configuration has the status deleted.

","parent_name":"DeleteConfigurationResponse"},"Structs/DeleteConfigurationResponse.html#/s:11DiscoveryV127DeleteConfigurationResponseV7noticesSayAA6NoticeVGSgvp":{"name":"notices","abstract":"

An array of notice messages, if any.

","parent_name":"DeleteConfigurationResponse"},"Structs/DeleteCollectionResponse/Status.html#/s:11DiscoveryV124DeleteCollectionResponseV6StatusO7deletedA2EmF":{"name":"deleted","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DeleteCollectionResponse/Status.html":{"name":"Status","abstract":"

The status of the collection. The status of a successful deletion operation is deleted.

","parent_name":"DeleteCollectionResponse"},"Structs/DeleteCollectionResponse.html#/s:11DiscoveryV124DeleteCollectionResponseV12collectionIDSSvp":{"name":"collectionID","abstract":"

The unique identifier of the collection that is being deleted.

","parent_name":"DeleteCollectionResponse"},"Structs/DeleteCollectionResponse.html#/s:11DiscoveryV124DeleteCollectionResponseV6statusSSvp":{"name":"status","abstract":"

The status of the collection. The status of a successful deletion operation is deleted.

","parent_name":"DeleteCollectionResponse"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2enA2EmF":{"name":"en","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2esA2EmF":{"name":"es","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2deA2EmF":{"name":"de","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2arA2EmF":{"name":"ar","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2frA2EmF":{"name":"fr","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2itA2EmF":{"name":"it","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2jaA2EmF":{"name":"ja","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2koA2EmF":{"name":"ko","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2ptA2EmF":{"name":"pt","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html":{"name":"Language","abstract":"

The language of the documents stored in the collection, in the form of an ISO 639-1 language code.

","parent_name":"CreateCollectionRequest"},"Structs/CreateCollectionRequest.html#/s:11DiscoveryV123CreateCollectionRequestV4nameSSvp":{"name":"name","abstract":"

The name of the collection to be created.

","parent_name":"CreateCollectionRequest"},"Structs/CreateCollectionRequest.html#/s:11DiscoveryV123CreateCollectionRequestV11descriptionSSSgvp":{"name":"description","abstract":"

A description of the collection.

","parent_name":"CreateCollectionRequest"},"Structs/CreateCollectionRequest.html#/s:11DiscoveryV123CreateCollectionRequestV15configurationIDSSSgvp":{"name":"configurationID","abstract":"

The ID of the configuration in which the collection is to be created.

","parent_name":"CreateCollectionRequest"},"Structs/CreateCollectionRequest.html#/s:11DiscoveryV123CreateCollectionRequestV8languageSSSgvp":{"name":"language","abstract":"

The language of the documents stored in the collection, in the form of an ISO 639-1 language code.

","parent_name":"CreateCollectionRequest"},"Structs/CreateCollectionRequest.html#/s:11DiscoveryV123CreateCollectionRequestVACSS4name_SSSg11descriptionAE15configurationIDAE8languagetcfc":{"name":"init(name:description:configurationID:language:)","abstract":"

Initialize a CreateCollectionRequest with member variables.

","parent_name":"CreateCollectionRequest"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsV3pdfAA11PdfSettingsVSgvp":{"name":"pdf","abstract":"

A list of PDF conversion settings.

","parent_name":"Conversions"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsV4wordAA12WordSettingsVSgvp":{"name":"word","abstract":"

A list of Word conversion settings.

","parent_name":"Conversions"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsV4htmlAA12HtmlSettingsVSgvp":{"name":"html","abstract":"

A list of HTML conversion settings.

","parent_name":"Conversions"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsV7segmentAA15SegmentSettingsVSgvp":{"name":"segment","abstract":"

A list of Document Segmentation settings.

","parent_name":"Conversions"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsV18jsonNormalizationsSayAA22NormalizationOperationVGSgvp":{"name":"jsonNormalizations","abstract":"

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are","parent_name":"Conversions"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsVAcA11PdfSettingsVSg3pdf_AA04WordE0VSg4wordAA04HtmlE0VSg4htmlAA07SegmentE0VSg7segmentSayAA22NormalizationOperationVGSg18jsonNormalizationstcfc":{"name":"init(pdf:word:html:segment:jsonNormalizations:)","abstract":"

Initialize a Conversions with member variables.

","parent_name":"Conversions"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV15configurationIDSSSgvp":{"name":"configurationID","abstract":"

The unique identifier of the configuration.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV4nameSSvp":{"name":"name","abstract":"

The name of the configuration.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV7createdSSSgvp":{"name":"created","abstract":"

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

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp of when the configuration was last updated in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the configuration, if available.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV11conversionsAA11ConversionsVSgvp":{"name":"conversions","abstract":"

The document conversion settings for the configuration.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV11enrichmentsSayAA10EnrichmentVGSgvp":{"name":"enrichments","abstract":"

An array of document enrichment settings for the configuration.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV14normalizationsSayAA22NormalizationOperationVGSgvp":{"name":"normalizations","abstract":"

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationVACSS4name_SSSg15configurationIDAE7createdAE7updatedAE11descriptionAA11ConversionsVSg11conversionsSayAA10EnrichmentVGSg11enrichmentsSayAA22NormalizationOperationVGSg14normalizationstcfc":{"name":"init(name:configurationID:created:updated:description:conversions:enrichments:normalizations:)","abstract":"

Initialize a Configuration with member variables.

","parent_name":"Configuration"},"Structs/CollectionUsage.html#/s:11DiscoveryV115CollectionUsageV9availableSiSgvp":{"name":"available","abstract":"

Number of active collections in the environment.

","parent_name":"CollectionUsage"},"Structs/CollectionUsage.html#/s:11DiscoveryV115CollectionUsageV14maximumAllowedSiSgvp":{"name":"maximumAllowed","abstract":"

Total number of collections allowed in the environment.

","parent_name":"CollectionUsage"},"Structs/CollectionDiskUsage.html#/s:11DiscoveryV119CollectionDiskUsageV9usedBytesSiSgvp":{"name":"usedBytes","abstract":"

Number of bytes used by the collection.

","parent_name":"CollectionDiskUsage"},"Structs/Collection/Status.html#/s:11DiscoveryV110CollectionV6StatusO6activeA2EmF":{"name":"active","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Collection/Status.html#/s:11DiscoveryV110CollectionV6StatusO7pendingA2EmF":{"name":"pending","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Collection/Status.html#/s:11DiscoveryV110CollectionV6StatusO11maintenanceA2EmF":{"name":"maintenance","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Collection/Status.html":{"name":"Status","abstract":"

The status of the collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV12collectionIDSSSgvp":{"name":"collectionID","abstract":"

The unique identifier of the collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV4nameSSSgvp":{"name":"name","abstract":"

The name of the collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV7createdSSSgvp":{"name":"created","abstract":"

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

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp of when the collection was last updated in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV6statusSSSgvp":{"name":"status","abstract":"

The status of the collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV15configurationIDSSSgvp":{"name":"configurationID","abstract":"

The unique identifier of the collection’s configuration.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV8languageSSSgvp":{"name":"language","abstract":"

The language of the documents stored in the collection. Permitted values include en (English), de (German), and","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV14documentCountsAA08DocumentE0VSgvp":{"name":"documentCounts","abstract":"

The object providing information about the documents in the collection. Present only when retrieving details of a","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV9diskUsageAA0c4DiskE0VSgvp":{"name":"diskUsage","abstract":"

The object providing information about the disk usage of the collection. Present only when retrieving details of a","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV14trainingStatusAA08TrainingE0VSgvp":{"name":"trainingStatus","abstract":"

Provides information about the status of relevance training for collection.

","parent_name":"Collection"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Calculation"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Calculation"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Calculation"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Calculation"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV5fieldSSSgvp":{"name":"field","abstract":"

The field where the aggregation is located in the document.

","parent_name":"Calculation"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV5valueSdSgvp":{"name":"value","abstract":"

Value of the aggregation.

","parent_name":"Calculation"},"Structs/AggregationResult.html#/s:11DiscoveryV117AggregationResultV3keySSSgvp":{"name":"key","abstract":"

Key that matched the aggregation type.

","parent_name":"AggregationResult"},"Structs/AggregationResult.html#/s:11DiscoveryV117AggregationResultV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"AggregationResult"},"Structs/AggregationResult.html#/s:11DiscoveryV117AggregationResultV12aggregationsSayAA05QueryC0OGSgvp":{"name":"aggregations","abstract":"

Aggregations returned in the case of chained aggregations.

","parent_name":"AggregationResult"},"Structs/AggregationResult.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"AggregationResult"},"Structs/AggregationResult.html":{"name":"AggregationResult","abstract":"

AggregationResult.

"},"Structs/Calculation.html":{"name":"Calculation","abstract":"

Calculation.

"},"Structs/Collection.html":{"name":"Collection","abstract":"

A collection for storing documents.

"},"Structs/CollectionDiskUsage.html":{"name":"CollectionDiskUsage","abstract":"

Summary of the disk usage statistics for this collection.

"},"Structs/CollectionUsage.html":{"name":"CollectionUsage","abstract":"

Summary of the collection usage in the environment.

"},"Structs/Configuration.html":{"name":"Configuration","abstract":"

A custom configuration for the environment.

"},"Structs/Conversions.html":{"name":"Conversions","abstract":"

Document conversion settings.

"},"Structs/CreateCollectionRequest.html":{"name":"CreateCollectionRequest","abstract":"

CreateCollectionRequest.

"},"Structs/DeleteCollectionResponse.html":{"name":"DeleteCollectionResponse","abstract":"

DeleteCollectionResponse.

"},"Structs/DeleteConfigurationResponse.html":{"name":"DeleteConfigurationResponse","abstract":"

DeleteConfigurationResponse.

"},"Structs/DeleteDocumentResponse.html":{"name":"DeleteDocumentResponse","abstract":"

DeleteDocumentResponse.

"},"Structs/DeleteEnvironmentResponse.html":{"name":"DeleteEnvironmentResponse","abstract":"

DeleteEnvironmentResponse.

"},"Structs/DiskUsage.html":{"name":"DiskUsage","abstract":"

Summary of the disk usage statistics for the environment.

"},"Structs/DocumentAccepted.html":{"name":"DocumentAccepted","abstract":"

DocumentAccepted.

"},"Structs/DocumentCounts.html":{"name":"DocumentCounts","abstract":"

DocumentCounts.

"},"Structs/DocumentSnapshot.html":{"name":"DocumentSnapshot","abstract":"

DocumentSnapshot.

"},"Structs/DocumentStatus.html":{"name":"DocumentStatus","abstract":"

Status information about a submitted document.

"},"Structs/Enrichment.html":{"name":"Enrichment","abstract":"

Enrichment.

"},"Structs/EnrichmentOptions.html":{"name":"EnrichmentOptions","abstract":"

Options which are specific to a particular enrichment.

"},"Structs/Environment.html":{"name":"Environment","abstract":"

Details about an environment.

"},"Structs/EnvironmentDocuments.html":{"name":"EnvironmentDocuments","abstract":"

Summary of the document usage statistics for the environment.

"},"Structs/Expansion.html":{"name":"Expansion","abstract":"

An expansion definition. Each object respresents one set of expandable strings. For example, you could have expansions for the word hot in one object, and expansions for the word cold in another.

"},"Structs/Expansions.html":{"name":"Expansions","abstract":"

The query expansion definitions for the specified collection.

"},"Structs/Field.html":{"name":"Field","abstract":"

Field.

"},"Structs/Filter.html":{"name":"Filter","abstract":"

Filter.

"},"Structs/FontSetting.html":{"name":"FontSetting","abstract":"

FontSetting.

"},"Structs/GenericQueryAggregation.html":{"name":"GenericQueryAggregation","abstract":"

An aggregation produced by the Discovery service to analyze the input provided.

"},"Structs/Histogram.html":{"name":"Histogram","abstract":"

Histogram.

"},"Structs/HtmlSettings.html":{"name":"HtmlSettings","abstract":"

A list of HTML conversion settings.

"},"Structs/IndexCapacity.html":{"name":"IndexCapacity","abstract":"

Details about the resource usage and capacity of the environment.

"},"Structs/ListCollectionFieldsResponse.html":{"name":"ListCollectionFieldsResponse","abstract":"

The list of fetched fields.

"},"Structs/ListCollectionsResponse.html":{"name":"ListCollectionsResponse","abstract":"

ListCollectionsResponse.

"},"Structs/ListConfigurationsResponse.html":{"name":"ListConfigurationsResponse","abstract":"

ListConfigurationsResponse.

"},"Structs/ListEnvironmentsResponse.html":{"name":"ListEnvironmentsResponse","abstract":"

ListEnvironmentsResponse.

"},"Structs/MemoryUsage.html":{"name":"MemoryUsage","abstract":"

Deprecated**: Summary of the memory usage statistics for this environment.

"},"Structs/Nested.html":{"name":"Nested","abstract":"

Nested.

"},"Structs/NluEnrichmentCategories.html":{"name":"NluEnrichmentCategories","abstract":"

An object that indicates the Categories enrichment will be applied to the specified field.

"},"Structs/NluEnrichmentEmotion.html":{"name":"NluEnrichmentEmotion","abstract":"

An object specifying the emotion detection enrichment and related parameters.

"},"Structs/NluEnrichmentEntities.html":{"name":"NluEnrichmentEntities","abstract":"

An object speficying the Entities enrichment and related parameters.

"},"Structs/NluEnrichmentFeatures.html":{"name":"NluEnrichmentFeatures","abstract":"

NluEnrichmentFeatures.

"},"Structs/NluEnrichmentKeywords.html":{"name":"NluEnrichmentKeywords","abstract":"

An object specifying the Keyword enrichment and related parameters.

"},"Structs/NluEnrichmentRelations.html":{"name":"NluEnrichmentRelations","abstract":"

An object specifying the relations enrichment and related parameters.

"},"Structs/NluEnrichmentSemanticRoles.html":{"name":"NluEnrichmentSemanticRoles","abstract":"

An object specifiying the semantic roles enrichment and related parameters.

"},"Structs/NluEnrichmentSentiment.html":{"name":"NluEnrichmentSentiment","abstract":"

An object specifying the sentiment extraction enrichment and related parameters.

"},"Structs/NormalizationOperation.html":{"name":"NormalizationOperation","abstract":"

NormalizationOperation.

"},"Structs/Notice.html":{"name":"Notice","abstract":"

A notice produced for the collection.

"},"Structs/PdfHeadingDetection.html":{"name":"PdfHeadingDetection","abstract":"

PdfHeadingDetection.

"},"Structs/PdfSettings.html":{"name":"PdfSettings","abstract":"

A list of PDF conversion settings.

"},"Structs/QueryEntities.html":{"name":"QueryEntities","abstract":"

QueryEntities.

"},"Structs/QueryEntitiesContext.html":{"name":"QueryEntitiesContext","abstract":"

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

"},"Structs/QueryEntitiesEntity.html":{"name":"QueryEntitiesEntity","abstract":"

A text string that appears within the entity text field.

"},"Structs/QueryEntitiesResponse.html":{"name":"QueryEntitiesResponse","abstract":"

An array of entities resulting from the query.

"},"Structs/QueryEntitiesResponseItem.html":{"name":"QueryEntitiesResponseItem","abstract":"

Object containing Entity query response information.

"},"Structs/QueryEvidence.html":{"name":"QueryEvidence","abstract":"

Description of evidence location supporting Knoweldge Graph query result.

"},"Structs/QueryEvidenceEntity.html":{"name":"QueryEvidenceEntity","abstract":"

Entity description and location within evidence field.

"},"Structs/QueryFilterType.html":{"name":"QueryFilterType","abstract":"

QueryFilterType.

"},"Structs/QueryNoticesResponse.html":{"name":"QueryNoticesResponse","abstract":"

QueryNoticesResponse.

"},"Structs/QueryNoticesResult.html":{"name":"QueryNoticesResult","abstract":"

QueryNoticesResult.

"},"Structs/QueryPassages.html":{"name":"QueryPassages","abstract":"

QueryPassages.

"},"Structs/QueryRelations.html":{"name":"QueryRelations","abstract":"

A respresentation of a relationship query.

"},"Structs/QueryRelationsArgument.html":{"name":"QueryRelationsArgument","abstract":"

QueryRelationsArgument.

"},"Structs/QueryRelationsEntity.html":{"name":"QueryRelationsEntity","abstract":"

QueryRelationsEntity.

"},"Structs/QueryRelationsFilter.html":{"name":"QueryRelationsFilter","abstract":"

QueryRelationsFilter.

"},"Structs/QueryRelationsRelationship.html":{"name":"QueryRelationsRelationship","abstract":"

QueryRelationsRelationship.

"},"Structs/QueryRelationsResponse.html":{"name":"QueryRelationsResponse","abstract":"

QueryRelationsResponse.

"},"Structs/QueryResponse.html":{"name":"QueryResponse","abstract":"

A response containing the documents and aggregations for the query.

"},"Structs/QueryResult.html":{"name":"QueryResult","abstract":"

QueryResult.

"},"Structs/QueryResultMetadata.html":{"name":"QueryResultMetadata","abstract":"

Metadata of a query result.

"},"Structs/SegmentSettings.html":{"name":"SegmentSettings","abstract":"

A list of Document Segmentation settings.

"},"Structs/Term.html":{"name":"Term","abstract":"

Term.

"},"Structs/TestDocument.html":{"name":"TestDocument","abstract":"

TestDocument.

"},"Structs/Timeslice.html":{"name":"Timeslice","abstract":"

Timeslice.

"},"Structs/TopHits.html":{"name":"TopHits","abstract":"

TopHits.

"},"Structs/TopHitsResults.html":{"name":"TopHitsResults","abstract":"

TopHitsResults.

"},"Structs/TrainingDataSet.html":{"name":"TrainingDataSet","abstract":"

TrainingDataSet.

"},"Structs/TrainingExample.html":{"name":"TrainingExample","abstract":"

TrainingExample.

"},"Structs/TrainingExampleList.html":{"name":"TrainingExampleList","abstract":"

TrainingExampleList.

"},"Structs/TrainingQuery.html":{"name":"TrainingQuery","abstract":"

TrainingQuery.

"},"Structs/TrainingStatus.html":{"name":"TrainingStatus","abstract":"

TrainingStatus.

"},"Structs/WordHeadingDetection.html":{"name":"WordHeadingDetection","abstract":"

WordHeadingDetection.

"},"Structs/WordSettings.html":{"name":"WordSettings","abstract":"

A list of Word conversion settings.

"},"Structs/WordStyle.html":{"name":"WordStyle","abstract":"

WordStyle.

"},"Structs/XPathPatterns.html":{"name":"XPathPatterns","abstract":"

XPathPatterns.

"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO013serializationD0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO08encodingD0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO011fileManagerD0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:11DiscoveryV14JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO4termAcA4TermVcACmF":{"name":"term","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO6filterAcA6FilterVcACmF":{"name":"filter","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO6nestedAcA6NestedVcACmF":{"name":"nested","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO9histogramAcA9HistogramVcACmF":{"name":"histogram","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO9timesliceAcA9TimesliceVcACmF":{"name":"timeslice","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO7topHitsAcA03TopF0VcACmF":{"name":"topHits","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO11uniqueCountAcA11CalculationVcACmF":{"name":"uniqueCount","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO3maxAcA11CalculationVcACmF":{"name":"max","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO3minAcA11CalculationVcACmF":{"name":"min","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO7averageAcA11CalculationVcACmF":{"name":"average","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO3sumAcA11CalculationVcACmF":{"name":"sum","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO7genericAcA07GenericcD0VcACmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html":{"name":"QueryAggregation","abstract":"

An aggregation produced by the Discovery service to analyze the input provided.

"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/Discovery.html#/s:11DiscoveryV10A0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

Create a Discovery object.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a Discovery object.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a Discovery object.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C17createEnvironmentySS4name_SSSg11descriptionSiSg4sizes10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createEnvironment(name:description:size:headers:failure:success:)","abstract":"

Create an environment.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16listEnvironmentsySSSg4name_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA04ListD8ResponseVc7successtF":{"name":"listEnvironments(name:headers:failure:success:)","abstract":"

List environments.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14getEnvironmentySS13environmentID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getEnvironment(environmentID:headers:failure:success:)","abstract":"

Get environment info.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C17updateEnvironmentySS13environmentID_SSSg4nameAF11descriptions10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateEnvironment(environmentID:name:description:headers:failure:success:)","abstract":"

Update an environment.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C17deleteEnvironmentySS13environmentID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteD8ResponseVc7successtF":{"name":"deleteEnvironment(environmentID:headers:failure:success:)","abstract":"

Delete environment.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C10listFieldsySS13environmentID_SaySSG13collectionIdss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA014ListCollectionD8ResponseVc7successtF":{"name":"listFields(environmentID:collectionIds:headers:failure:success:)","abstract":"

List fields across collections.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C19createConfigurationySS13environmentID_AA0D0V13configurations10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAGc7successtF":{"name":"createConfiguration(environmentID:configuration:headers:failure:success:)","abstract":"

Add configuration.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C18listConfigurationsySS13environmentID_SSSg4names10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA04ListD8ResponseVc7successtF":{"name":"listConfigurations(environmentID:name:headers:failure:success:)","abstract":"

List configurations.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16getConfigurationySS13environmentID_SS013configurationF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getConfiguration(environmentID:configurationID:headers:failure:success:)","abstract":"

Get configuration details.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C19updateConfigurationySS13environmentID_SS013configurationF0AA0D0V0G0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAHc7successtF":{"name":"updateConfiguration(environmentID:configurationID:configuration:headers:failure:success:)","abstract":"

Update a configuration.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C19deleteConfigurationySS13environmentID_SS013configurationF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteD8ResponseVc7successtF":{"name":"deleteConfiguration(environmentID:configurationID:headers:failure:success:)","abstract":"

Delete a configuration.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C30testConfigurationInEnvironmentySS13environmentID_SSSg13configurationAF4stepAF0iH010Foundation3URLVSg4fileAF8metadataAF0M11ContentTypes10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA12TestDocumentVc7successtF":{"name":"testConfigurationInEnvironment(environmentID:configuration:step:configurationID:file:metadata:fileContentType:headers:failure:success:)","abstract":"

Test configuration.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16createCollectionySS13environmentID_AA06CreateD7RequestV10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createCollection(environmentID:properties:headers:failure:success:)","abstract":"

Create a collection.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C15listCollectionsySS13environmentID_SSSg4names10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA04ListD8ResponseVc7successtF":{"name":"listCollections(environmentID:name:headers:failure:success:)","abstract":"

List collections.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C13getCollectionySS13environmentID_SS010collectionF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getCollection(environmentID:collectionID:headers:failure:success:)","abstract":"

Get collection details.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16updateCollectionySS13environmentID_SS010collectionF0SS4nameSSSg11descriptionAH013configurationF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateCollection(environmentID:collectionID:name:description:configurationID:headers:failure:success:)","abstract":"

Update a collection.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16deleteCollectionySS13environmentID_SS010collectionF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteD8ResponseVc7successtF":{"name":"deleteCollection(environmentID:collectionID:headers:failure:success:)","abstract":"

Delete a collection.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C20listCollectionFieldsySS13environmentID_SS010collectionG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA04ListdE8ResponseVc7successtF":{"name":"listCollectionFields(environmentID:collectionID:headers:failure:success:)","abstract":"

List collection fields.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14listExpansionsySS13environmentID_SS010collectionF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"listExpansions(environmentID:collectionID:headers:failure:success:)","abstract":"

Get the expansion list.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16createExpansionsySS13environmentID_SS010collectionF0SayAA9ExpansionVG10expansionss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createExpansions(environmentID:collectionID:expansions:headers:failure:success:)","abstract":"

Create or update expansion list.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16deleteExpansionsySS13environmentID_SS010collectionF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteExpansions(environmentID:collectionID:headers:failure:success:)","abstract":"

Delete the expansion list.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C11addDocumentySS13environmentID_SS010collectionF010Foundation3URLVSg4fileSSSg8metadataAL0J11ContentTypes10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D8AcceptedVc7successtF":{"name":"addDocument(environmentID:collectionID:file:metadata:fileContentType:headers:failure:success:)","abstract":"

Add a document.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C17getDocumentStatusySS13environmentID_SS010collectionG0SS08documentG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"getDocumentStatus(environmentID:collectionID:documentID:headers:failure:success:)","abstract":"

Get document details.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14updateDocumentySS13environmentID_SS010collectionF0SS08documentF010Foundation3URLVSg4fileSSSg8metadataAM0K11ContentTypes10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D8AcceptedVc7successtF":{"name":"updateDocument(environmentID:collectionID:documentID:file:metadata:fileContentType:headers:failure:success:)","abstract":"

Update a document.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14deleteDocumentySS13environmentID_SS010collectionF0SS08documentF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteD8ResponseVc7successtF":{"name":"deleteDocument(environmentID:collectionID:documentID:headers:failure:success:)","abstract":"

Delete a document.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C5queryySS13environmentID_SS010collectionE0SSSg6filterAgdG20naturalLanguageQuerySbSg8passagesAG11aggregationSiSg5countSaySSGSg12returnFieldsAM6offsetAP4sortAJ9highlightAP0kO0AM0K5CountAM0K10CharactersAJ11deduplicateAG0U5FieldAJ7similarAP0W11DocumentIdsAP0wO0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0J8ResponseVc7successtF":{"name":"query(environmentID:collectionID:filter:query:naturalLanguageQuery:passages:aggregation:count:returnFields:offset:sort:highlight:passagesFields:passagesCount:passagesCharacters:deduplicate:deduplicateField:similar:similarDocumentIds:similarFields:headers:failure:success:)","abstract":"

Query your collection.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C12queryNoticesySS13environmentID_SS010collectionF0SSSg6filterAG0C0AG20naturalLanguageQuerySbSg8passagesAG11aggregationSiSg5countSaySSGSg12returnFieldsAN6offsetAQ4sortAK9highlightAQ0lP0AN0L5CountAN0L10CharactersAG16deduplicateFieldAK7similarAQ0X11DocumentIdsAQ0xP0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0kD8ResponseVc7successtF":{"name":"queryNotices(environmentID:collectionID:filter:query:naturalLanguageQuery:passages:aggregation:count:returnFields:offset:sort:highlight:passagesFields:passagesCount:passagesCharacters:deduplicateField:similar:similarDocumentIds:similarFields:headers:failure:success:)","abstract":"

Query system notices.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14federatedQueryySS13environmentID_SaySSG13collectionIdsSSSg6filterAH5queryAH015naturalLanguageD0AH11aggregationSiSg5countAFSg12returnFieldsAM6offsetAO4sortSbSg9highlightAS11deduplicateAH0T5FieldAS7similarAO0v8DocumentH0AO0vP0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D8ResponseVc7successtF":{"name":"federatedQuery(environmentID:collectionIds:filter:query:naturalLanguageQuery:aggregation:count:returnFields:offset:sort:highlight:deduplicate:deduplicateField:similar:similarDocumentIds:similarFields:headers:failure:success:)","abstract":"

Query documents in multiple collections.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C21federatedQueryNoticesySS13environmentID_SaySSG13collectionIdsSSSg6filterAH5queryAH015naturalLanguageD0AH11aggregationSiSg5countAFSg12returnFieldsAM6offsetAO4sortSbSg9highlightAH16deduplicateFieldAS7similarAO0w8DocumentI0AO0wQ0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE8ResponseVc7successtF":{"name":"federatedQueryNotices(environmentID:collectionIds:filter:query:naturalLanguageQuery:aggregation:count:returnFields:offset:sort:highlight:deduplicateField:similar:similarDocumentIds:similarFields:headers:failure:success:)","abstract":"

Query multiple collection system notices.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C13queryEntitiesySS13environmentID_SS010collectionF0AA05QueryD0V06entityH0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0hD8ResponseVc7successtF":{"name":"queryEntities(environmentID:collectionID:entityQuery:headers:failure:success:)","abstract":"

Knowledge Graph entity query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14queryRelationsySS13environmentID_SS010collectionF0AA05QueryD0V012relationshipH0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0hD8ResponseVc7successtF":{"name":"queryRelations(environmentID:collectionID:relationshipQuery:headers:failure:success:)","abstract":"

Knowledge Graph relationship query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16listTrainingDataySS13environmentID_SS010collectionG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE3SetVc7successtF":{"name":"listTrainingData(environmentID:collectionID:headers:failure:success:)","abstract":"

List training data.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C15addTrainingDataySS13environmentID_SS010collectionG0SSSg20naturalLanguageQueryAG6filterSayAA0D7ExampleVGSg8exampless10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dK0Vc7successtF":{"name":"addTrainingData(environmentID:collectionID:naturalLanguageQuery:filter:examples:headers:failure:success:)","abstract":"

Add query to training data.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C21deleteAllTrainingDataySS13environmentID_SS010collectionH0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteAllTrainingData(environmentID:collectionID:headers:failure:success:)","abstract":"

Delete all training data.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C15getTrainingDataySS13environmentID_SS010collectionG0SS05queryG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D5QueryVc7successtF":{"name":"getTrainingData(environmentID:collectionID:queryID:headers:failure:success:)","abstract":"

Get details about a query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C18deleteTrainingDataySS13environmentID_SS010collectionG0SS05queryG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteTrainingData(environmentID:collectionID:queryID:headers:failure:success:)","abstract":"

Delete a training data query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C20listTrainingExamplesySS13environmentID_SS010collectionG0SS05queryG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D11ExampleListVc7successtF":{"name":"listTrainingExamples(environmentID:collectionID:queryID:headers:failure:success:)","abstract":"

List examples for a training data query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C21createTrainingExampleySS13environmentID_SS010collectionG0SS05queryG0SSSg08documentG0AH14crossReferenceSiSg9relevances10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"createTrainingExample(environmentID:collectionID:queryID:documentID:crossReference:relevance:headers:failure:success:)","abstract":"

Add example to training data query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C21deleteTrainingExampleySS13environmentID_SS010collectionG0SS05queryG0SS07exampleG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteTrainingExample(environmentID:collectionID:queryID:exampleID:headers:failure:success:)","abstract":"

Delete example for training data query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C21updateTrainingExampleySS13environmentID_SS010collectionG0SS05queryG0SS07exampleG0SSSg14crossReferenceSiSg9relevances10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"updateTrainingExample(environmentID:collectionID:queryID:exampleID:crossReference:relevance:headers:failure:success:)","abstract":"

Change label or cross reference for example.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C18getTrainingExampleySS13environmentID_SS010collectionG0SS05queryG0SS07exampleG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"getTrainingExample(environmentID:collectionID:queryID:exampleID:headers:failure:success:)","abstract":"

Get details for training data example.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

Delete labeled data.

","parent_name":"Discovery"},"Classes/Discovery.html":{"name":"Discovery","abstract":"

The IBM Watson™ Discovery Service is a cognitive search and content analytics engine that you can add to"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/docSet.dsidx b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/docSet.dsidx index b3a9c5199..29845e893 100644 Binary files a/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/docSet.dsidx and b/docs/swift-api/services/DiscoveryV1/docsets/.docset/Contents/Resources/docSet.dsidx differ diff --git a/docs/swift-api/services/DiscoveryV1/docsets/.tgz b/docs/swift-api/services/DiscoveryV1/docsets/.tgz index 125420e4e..9828c8473 100644 Binary files a/docs/swift-api/services/DiscoveryV1/docsets/.tgz and b/docs/swift-api/services/DiscoveryV1/docsets/.tgz differ diff --git a/docs/swift-api/services/DiscoveryV1/index.html b/docs/swift-api/services/DiscoveryV1/index.html index 8a73a27de..802a67864 100644 --- a/docs/swift-api/services/DiscoveryV1/index.html +++ b/docs/swift-api/services/DiscoveryV1/index.html @@ -178,9 +178,6 @@ - @@ -400,7 +397,8 @@

Services

  • Assistant
  • Discovery
  • -
  • Language Translator
  • +
  • Language Translator V2
  • +
  • Language Translator V3
  • Natural Language Classifier
  • Natural Language Understanding
  • Personality Insights
  • @@ -445,7 +443,7 @@

    Swift Package Manager

    Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

    dependencies: [
    -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
    +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
     ]
     

    Service Instances

    @@ -488,7 +486,7 @@

    Username and Password

    API Key

    -

    Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

    +

    Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

    let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
     

    Using IAM

    @@ -723,7 +721,12 @@

    Private Data Collections

  • IBM Discovery - Documentation
  • IBM Discovery - Demo
-

Language Translator

+

Language Translator V2

+ +

Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

@@ -734,6 +737,25 @@

Language Translator

let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} + +

Language Translator V3

+ +

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

+ +

The following example demonstrates how to use the Language Translator service:

+
import LanguageTranslatorV3
+
+let username = "your-username-here"
+let password = "your-password-here"
+let version = "yyyy-mm-dd" // use today's date for the most recent version
+let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
+
 let failure = { (error: Error) in print(error) }
 let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
 languageTranslator.translate(request: request, failure: failure) {
@@ -1124,7 +1146,7 @@ 

Visual Recognition

let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -1132,6 +1154,10 @@

Visual Recognition

print(classifiedImages) }
+ +

Note: a different initializer is used for authentication with instances created before May 23, 2018:

+
let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
+

Using Core ML

The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

@@ -1183,7 +1209,7 @@

Bundlin diff --git a/docs/swift-api/services/DiscoveryV1/search.json b/docs/swift-api/services/DiscoveryV1/search.json index 5d36cb42a..e7f878f4a 100644 --- a/docs/swift-api/services/DiscoveryV1/search.json +++ b/docs/swift-api/services/DiscoveryV1/search.json @@ -1 +1 @@ -{"Structs/XPathPatterns.html#/s:11DiscoveryV113XPathPatternsV6xpathsSaySSGSgvp":{"name":"xpaths","abstract":"

Undocumented

","parent_name":"XPathPatterns"},"Structs/XPathPatterns.html#/s:11DiscoveryV113XPathPatternsVACSaySSGSg6xpaths_tcfc":{"name":"init(xpaths:)","abstract":"

Initialize a XPathPatterns with member variables.

","parent_name":"XPathPatterns"},"Structs/WordStyle.html#/s:11DiscoveryV19WordStyleV5levelSiSgvp":{"name":"level","abstract":"

Undocumented

","parent_name":"WordStyle"},"Structs/WordStyle.html#/s:11DiscoveryV19WordStyleV5namesSaySSGSgvp":{"name":"names","abstract":"

Undocumented

","parent_name":"WordStyle"},"Structs/WordStyle.html#/s:11DiscoveryV19WordStyleVACSiSg5level_SaySSGSg5namestcfc":{"name":"init(level:names:)","abstract":"

Initialize a WordStyle with member variables.

","parent_name":"WordStyle"},"Structs/WordSettings.html#/s:11DiscoveryV112WordSettingsV7headingAA0C16HeadingDetectionVSgvp":{"name":"heading","abstract":"

Undocumented

","parent_name":"WordSettings"},"Structs/WordSettings.html#/s:11DiscoveryV112WordSettingsVAcA0C16HeadingDetectionVSg7heading_tcfc":{"name":"init(heading:)","abstract":"

Initialize a WordSettings with member variables.

","parent_name":"WordSettings"},"Structs/WordHeadingDetection.html#/s:11DiscoveryV120WordHeadingDetectionV5fontsSayAA11FontSettingVGSgvp":{"name":"fonts","abstract":"

Undocumented

","parent_name":"WordHeadingDetection"},"Structs/WordHeadingDetection.html#/s:11DiscoveryV120WordHeadingDetectionV6stylesSayAA0C5StyleVGSgvp":{"name":"styles","abstract":"

Undocumented

","parent_name":"WordHeadingDetection"},"Structs/WordHeadingDetection.html#/s:11DiscoveryV120WordHeadingDetectionVACSayAA11FontSettingVGSg5fonts_SayAA0C5StyleVGSg6stylestcfc":{"name":"init(fonts:styles:)","abstract":"

Initialize a WordHeadingDetection with member variables.

","parent_name":"WordHeadingDetection"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV13totalExamplesSiSgvp":{"name":"totalExamples","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV9availableSbSgvp":{"name":"available","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV10processingSbSgvp":{"name":"processing","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV19minimumQueriesAddedSbSgvp":{"name":"minimumQueriesAdded","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV20minimumExamplesAddedSbSgvp":{"name":"minimumExamplesAdded","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV24sufficientLabelDiversitySbSgvp":{"name":"sufficientLabelDiversity","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV7noticesSiSgvp":{"name":"notices","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV19successfullyTrainedSSSgvp":{"name":"successfullyTrained","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV11dataUpdatedSSSgvp":{"name":"dataUpdated","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingQuery.html#/s:11DiscoveryV113TrainingQueryV7queryIDSSSgvp":{"name":"queryID","abstract":"

Undocumented

","parent_name":"TrainingQuery"},"Structs/TrainingQuery.html#/s:11DiscoveryV113TrainingQueryV015naturalLanguageD0SSSgvp":{"name":"naturalLanguageQuery","abstract":"

Undocumented

","parent_name":"TrainingQuery"},"Structs/TrainingQuery.html#/s:11DiscoveryV113TrainingQueryV6filterSSSgvp":{"name":"filter","abstract":"

Undocumented

","parent_name":"TrainingQuery"},"Structs/TrainingQuery.html#/s:11DiscoveryV113TrainingQueryV8examplesSayAA0C7ExampleVGSgvp":{"name":"examples","abstract":"

Undocumented

","parent_name":"TrainingQuery"},"Structs/TrainingExampleList.html#/s:11DiscoveryV119TrainingExampleListV8examplesSayAA0cD0VGSgvp":{"name":"examples","abstract":"

Undocumented

","parent_name":"TrainingExampleList"},"Structs/TrainingExample.html#/s:11DiscoveryV115TrainingExampleV10documentIDSSSgvp":{"name":"documentID","abstract":"

Undocumented

","parent_name":"TrainingExample"},"Structs/TrainingExample.html#/s:11DiscoveryV115TrainingExampleV14crossReferenceSSSgvp":{"name":"crossReference","abstract":"

Undocumented

","parent_name":"TrainingExample"},"Structs/TrainingExample.html#/s:11DiscoveryV115TrainingExampleV9relevanceSiSgvp":{"name":"relevance","abstract":"

Undocumented

","parent_name":"TrainingExample"},"Structs/TrainingExample.html#/s:11DiscoveryV115TrainingExampleVACSSSg10documentID_AD14crossReferenceSiSg9relevancetcfc":{"name":"init(documentID:crossReference:relevance:)","abstract":"

Initialize a TrainingExample with member variables.

","parent_name":"TrainingExample"},"Structs/TrainingDataSet.html#/s:11DiscoveryV115TrainingDataSetV13environmentIDSSSgvp":{"name":"environmentID","abstract":"

Undocumented

","parent_name":"TrainingDataSet"},"Structs/TrainingDataSet.html#/s:11DiscoveryV115TrainingDataSetV12collectionIDSSSgvp":{"name":"collectionID","abstract":"

Undocumented

","parent_name":"TrainingDataSet"},"Structs/TrainingDataSet.html#/s:11DiscoveryV115TrainingDataSetV7queriesSayAA0C5QueryVGSgvp":{"name":"queries","abstract":"

Undocumented

","parent_name":"TrainingDataSet"},"Structs/TopHitsResults.html#/s:11DiscoveryV114TopHitsResultsV08matchingE0SiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"TopHitsResults"},"Structs/TopHitsResults.html#/s:11DiscoveryV114TopHitsResultsV4hitsSayAA11QueryResultVGSgvp":{"name":"hits","abstract":"

Top results returned by the aggregation.

","parent_name":"TopHitsResults"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"TopHits"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"TopHits"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"TopHits"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"TopHits"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV4sizeSiSgvp":{"name":"size","abstract":"

Number of top hits returned by the aggregation.

","parent_name":"TopHits"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV4hitsAA0cD7ResultsVSgvp":{"name":"hits","abstract":"

Undocumented

","parent_name":"TopHits"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV5fieldSSSgvp":{"name":"field","abstract":"

The field where the aggregation is located in the document.

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV8intervalSSSgvp":{"name":"interval","abstract":"

Interval of the aggregation. Valid date interval values are second/seconds minute/minutes, hour/hours, day/days, week/weeks, month/months, and year/years.

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV7anomalySbSgvp":{"name":"anomaly","abstract":"

Used to inducate that anomaly detection should be performed. Anomaly detection is used to locate unusual datapoints within a time series.

","parent_name":"Timeslice"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV15configurationIDSSSgvp":{"name":"configurationID","abstract":"

The unique identifier for the configuration.

","parent_name":"TestDocument"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV6statusSSSgvp":{"name":"status","abstract":"

Status of the preview operation.

","parent_name":"TestDocument"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV18enrichedFieldUnitsSiSgvp":{"name":"enrichedFieldUnits","abstract":"

The number of 10-kB chunks of field data that were enriched. This can be used to estimate the cost of running a real ingestion.

","parent_name":"TestDocument"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV17originalMediaTypeSSSgvp":{"name":"originalMediaType","abstract":"

Format of the test document.

","parent_name":"TestDocument"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV9snapshotsSayAA0D8SnapshotVGSgvp":{"name":"snapshots","abstract":"

An array of objects that describe each step in the preview process.

","parent_name":"TestDocument"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV7noticesSayAA6NoticeVGSgvp":{"name":"notices","abstract":"

An array of notice messages about the preview operation.

","parent_name":"TestDocument"},"Structs/Term.html#/s:11DiscoveryV14TermV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Term"},"Structs/Term.html#/s:11DiscoveryV14TermV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Term"},"Structs/Term.html#/s:11DiscoveryV14TermV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Term"},"Structs/Term.html#/s:11DiscoveryV14TermV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Term"},"Structs/Term.html#/s:11DiscoveryV14TermV5fieldSSSgvp":{"name":"field","abstract":"

The field where the aggregation is located in the document.

","parent_name":"Term"},"Structs/Term.html#/s:11DiscoveryV14TermV5countSiSgvp":{"name":"count","abstract":"

Undocumented

","parent_name":"Term"},"Structs/SegmentSettings.html#/s:11DiscoveryV115SegmentSettingsV7enabledSbSgvp":{"name":"enabled","abstract":"

Enables/disables the Document Segmentation feature.

","parent_name":"SegmentSettings"},"Structs/SegmentSettings.html#/s:11DiscoveryV115SegmentSettingsV12selectorTagsSaySSGSgvp":{"name":"selectorTags","abstract":"

Defines the heading level that splits into document segments. Valid values are h1, h2, h3, h4, h5, h6.

","parent_name":"SegmentSettings"},"Structs/SegmentSettings.html#/s:11DiscoveryV115SegmentSettingsVACSbSg7enabled_SaySSGSg12selectorTagstcfc":{"name":"init(enabled:selectorTags:)","abstract":"

Initialize a SegmentSettings with member variables.

","parent_name":"SegmentSettings"},"Structs/QueryResultMetadata.html#/s:11DiscoveryV119QueryResultMetadataV5scoreSdSgvp":{"name":"score","abstract":"

The confidence score of the result’s analysis. A higher score indicating greater confidence.

","parent_name":"QueryResultMetadata"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV2idSSSgvp":{"name":"id","abstract":"

The unique identifier of the document.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV5scoreSdSgvp":{"name":"score","abstract":"

Deprecated* This field is now part of the result_metadata object.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Metadata of the document.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV12collectionIDSSSgvp":{"name":"collectionID","abstract":"

The collection ID of the collection containing the document for this result.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV14resultMetadataAA0cdF0VSgvp":{"name":"resultMetadata","abstract":"

Metadata of the query result.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"QueryResult"},"Structs/QueryResponse.html#/s:11DiscoveryV113QueryResponseV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Undocumented

","parent_name":"QueryResponse"},"Structs/QueryResponse.html#/s:11DiscoveryV113QueryResponseV7resultsSayAA0C6ResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"QueryResponse"},"Structs/QueryResponse.html#/s:11DiscoveryV113QueryResponseV12aggregationsSayAA0C11AggregationOGSgvp":{"name":"aggregations","abstract":"

Undocumented

","parent_name":"QueryResponse"},"Structs/QueryResponse.html#/s:11DiscoveryV113QueryResponseV8passagesSayAA0C8PassagesVGSgvp":{"name":"passages","abstract":"

Undocumented

","parent_name":"QueryResponse"},"Structs/QueryResponse.html#/s:11DiscoveryV113QueryResponseV17duplicatesRemovedSiSgvp":{"name":"duplicatesRemoved","abstract":"

Undocumented

","parent_name":"QueryResponse"},"Structs/QueryRelationsResponse.html#/s:11DiscoveryV122QueryRelationsResponseV9relationsSayAA0cD12RelationshipVGSgvp":{"name":"relations","abstract":"

Undocumented

","parent_name":"QueryRelationsResponse"},"Structs/QueryRelationsRelationship.html#/s:11DiscoveryV126QueryRelationsRelationshipV4typeSSSgvp":{"name":"type","abstract":"

The identified relationship type.

","parent_name":"QueryRelationsRelationship"},"Structs/QueryRelationsRelationship.html#/s:11DiscoveryV126QueryRelationsRelationshipV9frequencySiSgvp":{"name":"frequency","abstract":"

The number of times the relationship is mentioned.

","parent_name":"QueryRelationsRelationship"},"Structs/QueryRelationsRelationship.html#/s:11DiscoveryV126QueryRelationsRelationshipV9argumentsSayAA0cD8ArgumentVGSgvp":{"name":"arguments","abstract":"

Information about the relationship.

","parent_name":"QueryRelationsRelationship"},"Structs/QueryRelationsRelationship.html#/s:11DiscoveryV126QueryRelationsRelationshipV8evidenceSayAA0C8EvidenceVGSgvp":{"name":"evidence","abstract":"

List of different evidentiary items to support the result.

","parent_name":"QueryRelationsRelationship"},"Structs/QueryRelationsFilter.html#/s:11DiscoveryV120QueryRelationsFilterV13relationTypesAA0cE4TypeVSgvp":{"name":"relationTypes","abstract":"

A list of relation types to include or exclude from the query.

","parent_name":"QueryRelationsFilter"},"Structs/QueryRelationsFilter.html#/s:11DiscoveryV120QueryRelationsFilterV11entityTypesAA0cE4TypeVSgvp":{"name":"entityTypes","abstract":"

A list of entity types to include or exclude from the query.

","parent_name":"QueryRelationsFilter"},"Structs/QueryRelationsFilter.html#/s:11DiscoveryV120QueryRelationsFilterV11documentIdsSaySSGSgvp":{"name":"documentIds","abstract":"

A comma-separated list of document IDs to include in the query.

","parent_name":"QueryRelationsFilter"},"Structs/QueryRelationsFilter.html#/s:11DiscoveryV120QueryRelationsFilterVAcA0cE4TypeVSg13relationTypes_AF06entityH0SaySSGSg11documentIdstcfc":{"name":"init(relationTypes:entityTypes:documentIds:)","abstract":"

Initialize a QueryRelationsFilter with member variables.

","parent_name":"QueryRelationsFilter"},"Structs/QueryRelationsEntity.html#/s:11DiscoveryV120QueryRelationsEntityV4textSSSgvp":{"name":"text","abstract":"

Entity text content.

","parent_name":"QueryRelationsEntity"},"Structs/QueryRelationsEntity.html#/s:11DiscoveryV120QueryRelationsEntityV4typeSSSgvp":{"name":"type","abstract":"

The type of the specified entity.

","parent_name":"QueryRelationsEntity"},"Structs/QueryRelationsEntity.html#/s:11DiscoveryV120QueryRelationsEntityV5exactSbSgvp":{"name":"exact","abstract":"

If false, implicit querying is performed. The default is false.

","parent_name":"QueryRelationsEntity"},"Structs/QueryRelationsEntity.html#/s:11DiscoveryV120QueryRelationsEntityVACSSSg4text_AD4typeSbSg5exacttcfc":{"name":"init(text:type:exact:)","abstract":"

Initialize a QueryRelationsEntity with member variables.

","parent_name":"QueryRelationsEntity"},"Structs/QueryRelationsArgument.html#/s:11DiscoveryV122QueryRelationsArgumentV8entitiesSayAA0C14EntitiesEntityVGSgvp":{"name":"entities","abstract":"

Undocumented

","parent_name":"QueryRelationsArgument"},"Structs/QueryRelations/Sort.html#/s:11DiscoveryV114QueryRelationsV4SortO5scoreA2EmF":{"name":"score","abstract":"

Undocumented

","parent_name":"Sort"},"Structs/QueryRelations/Sort.html#/s:11DiscoveryV114QueryRelationsV4SortO9frequencyA2EmF":{"name":"frequency","abstract":"

Undocumented

","parent_name":"Sort"},"Structs/QueryRelations/Sort.html":{"name":"Sort","abstract":"

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times each entity is identified. The default is score.

","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV8entitiesSayAA0cD6EntityVGSgvp":{"name":"entities","abstract":"

An array of entities to find relationships for.

","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV7contextAA0C15EntitiesContextVSgvp":{"name":"context","abstract":"

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV4sortSSSgvp":{"name":"sort","abstract":"

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times each entity is identified. The default is score.

","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV6filterAA0cD6FilterVSgvp":{"name":"filter","abstract":"

Filters to apply to the relationship query.

","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV5countSiSgvp":{"name":"count","abstract":"

The number of results to return. The default is 10. The maximum is 1000.

","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV13evidenceCountSiSgvp":{"name":"evidenceCount","abstract":"

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items per query is 10,000.

","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsVACSayAA0cD6EntityVGSg8entities_AA0C15EntitiesContextVSg7contextSSSg4sortAA0cD6FilterVSg6filterSiSg5countAS13evidenceCounttcfc":{"name":"init(entities:context:sort:filter:count:evidenceCount:)","abstract":"

Initialize a QueryRelations with member variables.

","parent_name":"QueryRelations"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV10documentIDSSSgvp":{"name":"documentID","abstract":"

The unique identifier of the document from which the passage has been extracted.

","parent_name":"QueryPassages"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV12passageScoreSdSgvp":{"name":"passageScore","abstract":"

The confidence score of the passages’s analysis. A higher score indicates greater confidence.

","parent_name":"QueryPassages"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV11passageTextSSSgvp":{"name":"passageText","abstract":"

The content of the extracted passage.

","parent_name":"QueryPassages"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV11startOffsetSiSgvp":{"name":"startOffset","abstract":"

The position of the first character of the extracted passage in the originating field.

","parent_name":"QueryPassages"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV9endOffsetSiSgvp":{"name":"endOffset","abstract":"

The position of the last character of the extracted passage in the originating field.

","parent_name":"QueryPassages"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV5fieldSSSgvp":{"name":"field","abstract":"

The label of the field from which the passage has been extracted.

","parent_name":"QueryPassages"},"Structs/QueryNoticesResult/FileType.html#/s:11DiscoveryV118QueryNoticesResultV8FileTypeO3pdfA2EmF":{"name":"pdf","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/QueryNoticesResult/FileType.html#/s:11DiscoveryV118QueryNoticesResultV8FileTypeO4htmlA2EmF":{"name":"html","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/QueryNoticesResult/FileType.html#/s:11DiscoveryV118QueryNoticesResultV8FileTypeO4wordA2EmF":{"name":"word","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/QueryNoticesResult/FileType.html#/s:11DiscoveryV118QueryNoticesResultV8FileTypeO4jsonA2EmF":{"name":"json","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/QueryNoticesResult/FileType.html":{"name":"FileType","abstract":"

The type of the original source file.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV2idSSSgvp":{"name":"id","abstract":"

The unique identifier of the document.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV5scoreSdSgvp":{"name":"score","abstract":"

Deprecated* This field is now part of the result_metadata object.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Metadata of the document.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV12collectionIDSSSgvp":{"name":"collectionID","abstract":"

The collection ID of the collection containing the document for this result.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV14resultMetadataAA0ceG0VSgvp":{"name":"resultMetadata","abstract":"

Metadata of the query result.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV4codeSiSgvp":{"name":"code","abstract":"

The internal status code returned by the ingestion subsystem indicating the overall result of ingesting the source document.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV8filenameSSSgvp":{"name":"filename","abstract":"

Name of the original source file (if available).

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV8fileTypeSSSgvp":{"name":"fileType","abstract":"

The type of the original source file.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV4sha1SSSgvp":{"name":"sha1","abstract":"

The SHA-1 hash of the original source file (formatted as a hexadecimal string).

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV7noticesSayAA6NoticeVGSgvp":{"name":"notices","abstract":"

Array of notices for the document.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResponse.html#/s:11DiscoveryV120QueryNoticesResponseV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Undocumented

","parent_name":"QueryNoticesResponse"},"Structs/QueryNoticesResponse.html#/s:11DiscoveryV120QueryNoticesResponseV7resultsSayAA0cD6ResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"QueryNoticesResponse"},"Structs/QueryNoticesResponse.html#/s:11DiscoveryV120QueryNoticesResponseV12aggregationsSayAA0C11AggregationOGSgvp":{"name":"aggregations","abstract":"

Undocumented

","parent_name":"QueryNoticesResponse"},"Structs/QueryNoticesResponse.html#/s:11DiscoveryV120QueryNoticesResponseV8passagesSayAA0C8PassagesVGSgvp":{"name":"passages","abstract":"

Undocumented

","parent_name":"QueryNoticesResponse"},"Structs/QueryNoticesResponse.html#/s:11DiscoveryV120QueryNoticesResponseV17duplicatesRemovedSiSgvp":{"name":"duplicatesRemoved","abstract":"

Undocumented

","parent_name":"QueryNoticesResponse"},"Structs/QueryFilterType.html#/s:11DiscoveryV115QueryFilterTypeV7excludeSaySSGSgvp":{"name":"exclude","abstract":"

A comma-separated list of types to exclude.

","parent_name":"QueryFilterType"},"Structs/QueryFilterType.html#/s:11DiscoveryV115QueryFilterTypeV7includeSaySSGSgvp":{"name":"include","abstract":"

A comma-separated list of types to include. All other types are excluded.

","parent_name":"QueryFilterType"},"Structs/QueryFilterType.html#/s:11DiscoveryV115QueryFilterTypeVACSaySSGSg7exclude_AE7includetcfc":{"name":"init(exclude:include:)","abstract":"

Initialize a QueryFilterType with member variables.

","parent_name":"QueryFilterType"},"Structs/QueryEvidenceEntity.html#/s:11DiscoveryV119QueryEvidenceEntityV4typeSSSgvp":{"name":"type","abstract":"

The entity type for this entity. Possible types vary based on model used.

","parent_name":"QueryEvidenceEntity"},"Structs/QueryEvidenceEntity.html#/s:11DiscoveryV119QueryEvidenceEntityV4textSSSgvp":{"name":"text","abstract":"

The original text of this entity as found in the evidence field.

","parent_name":"QueryEvidenceEntity"},"Structs/QueryEvidenceEntity.html#/s:11DiscoveryV119QueryEvidenceEntityV11startOffsetSiSgvp":{"name":"startOffset","abstract":"

The start location of the entity text in the identified field. This value is inclusive.

","parent_name":"QueryEvidenceEntity"},"Structs/QueryEvidenceEntity.html#/s:11DiscoveryV119QueryEvidenceEntityV9endOffsetSiSgvp":{"name":"endOffset","abstract":"

The end location of the entity text in the identified field. This value is exclusive.

","parent_name":"QueryEvidenceEntity"},"Structs/QueryEvidence.html#/s:11DiscoveryV113QueryEvidenceV10documentIDSSSgvp":{"name":"documentID","abstract":"

The docuemnt ID (as indexed in Discovery) of the evidence location.

","parent_name":"QueryEvidence"},"Structs/QueryEvidence.html#/s:11DiscoveryV113QueryEvidenceV5fieldSSSgvp":{"name":"field","abstract":"

The field of the document where the supporting evidence was identified.

","parent_name":"QueryEvidence"},"Structs/QueryEvidence.html#/s:11DiscoveryV113QueryEvidenceV11startOffsetSiSgvp":{"name":"startOffset","abstract":"

The start location of the evidence in the identified field. This value is inclusive.

","parent_name":"QueryEvidence"},"Structs/QueryEvidence.html#/s:11DiscoveryV113QueryEvidenceV9endOffsetSiSgvp":{"name":"endOffset","abstract":"

The end location of the evidence in the identified field. This value is inclusive.

","parent_name":"QueryEvidence"},"Structs/QueryEvidence.html#/s:11DiscoveryV113QueryEvidenceV8entitiesSayAA0cD6EntityVGSgvp":{"name":"entities","abstract":"

An array of entity objects that show evidence of the result.

","parent_name":"QueryEvidence"},"Structs/QueryEntitiesResponseItem.html#/s:11DiscoveryV125QueryEntitiesResponseItemV4textSSSgvp":{"name":"text","abstract":"

Entity text content.

","parent_name":"QueryEntitiesResponseItem"},"Structs/QueryEntitiesResponseItem.html#/s:11DiscoveryV125QueryEntitiesResponseItemV4typeSSSgvp":{"name":"type","abstract":"

The type of the result entity.

","parent_name":"QueryEntitiesResponseItem"},"Structs/QueryEntitiesResponseItem.html#/s:11DiscoveryV125QueryEntitiesResponseItemV8evidenceSayAA0C8EvidenceVGSgvp":{"name":"evidence","abstract":"

List of different evidentiary items to support the result.

","parent_name":"QueryEntitiesResponseItem"},"Structs/QueryEntitiesResponse.html#/s:11DiscoveryV121QueryEntitiesResponseV8entitiesSayAA0cdE4ItemVGSgvp":{"name":"entities","abstract":"

Undocumented

","parent_name":"QueryEntitiesResponse"},"Structs/QueryEntitiesEntity.html#/s:11DiscoveryV119QueryEntitiesEntityV4textSSSgvp":{"name":"text","abstract":"

Entity text content.

","parent_name":"QueryEntitiesEntity"},"Structs/QueryEntitiesEntity.html#/s:11DiscoveryV119QueryEntitiesEntityV4typeSSSgvp":{"name":"type","abstract":"

The type of the specified entity.

","parent_name":"QueryEntitiesEntity"},"Structs/QueryEntitiesEntity.html#/s:11DiscoveryV119QueryEntitiesEntityVACSSSg4text_AD4typetcfc":{"name":"init(text:type:)","abstract":"

Initialize a QueryEntitiesEntity with member variables.

","parent_name":"QueryEntitiesEntity"},"Structs/QueryEntitiesContext.html#/s:11DiscoveryV120QueryEntitiesContextV4textSSSgvp":{"name":"text","abstract":"

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

","parent_name":"QueryEntitiesContext"},"Structs/QueryEntitiesContext.html#/s:11DiscoveryV120QueryEntitiesContextVACSSSg4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a QueryEntitiesContext with member variables.

","parent_name":"QueryEntitiesContext"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesV7featureSSSgvp":{"name":"feature","abstract":"

The entity query feature to perform. Supported features are disambiguate and similar_entities.

","parent_name":"QueryEntities"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesV6entityAA0cD6EntityVSgvp":{"name":"entity","abstract":"

A text string that appears within the entity text field.

","parent_name":"QueryEntities"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesV7contextAA0cD7ContextVSgvp":{"name":"context","abstract":"

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

","parent_name":"QueryEntities"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesV5countSiSgvp":{"name":"count","abstract":"

The number of results to return. The default is 10. The maximum is 1000.

","parent_name":"QueryEntities"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesV13evidenceCountSiSgvp":{"name":"evidenceCount","abstract":"

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items per query is 10,000.

","parent_name":"QueryEntities"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesVACSSSg7feature_AA0cD6EntityVSg6entityAA0cD7ContextVSg7contextSiSg5countAN13evidenceCounttcfc":{"name":"init(feature:entity:context:count:evidenceCount:)","abstract":"

Initialize a QueryEntities with member variables.

","parent_name":"QueryEntities"},"Structs/PdfSettings.html#/s:11DiscoveryV111PdfSettingsV7headingAA0C16HeadingDetectionVSgvp":{"name":"heading","abstract":"

Undocumented

","parent_name":"PdfSettings"},"Structs/PdfSettings.html#/s:11DiscoveryV111PdfSettingsVAcA0C16HeadingDetectionVSg7heading_tcfc":{"name":"init(heading:)","abstract":"

Initialize a PdfSettings with member variables.

","parent_name":"PdfSettings"},"Structs/PdfHeadingDetection.html#/s:11DiscoveryV119PdfHeadingDetectionV5fontsSayAA11FontSettingVGSgvp":{"name":"fonts","abstract":"

Undocumented

","parent_name":"PdfHeadingDetection"},"Structs/PdfHeadingDetection.html#/s:11DiscoveryV119PdfHeadingDetectionVACSayAA11FontSettingVGSg5fonts_tcfc":{"name":"init(fonts:)","abstract":"

Initialize a PdfHeadingDetection with member variables.

","parent_name":"PdfHeadingDetection"},"Structs/Notice/Severity.html#/s:11DiscoveryV16NoticeV8SeverityO7warningA2EmF":{"name":"warning","abstract":"

Undocumented

","parent_name":"Severity"},"Structs/Notice/Severity.html#/s:11DiscoveryV16NoticeV8SeverityO5errorA2EmF":{"name":"error","abstract":"

Undocumented

","parent_name":"Severity"},"Structs/Notice/Severity.html":{"name":"Severity","abstract":"

Severity level of the notice.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV8noticeIDSSSgvp":{"name":"noticeID","abstract":"

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.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV7createdSSSgvp":{"name":"created","abstract":"

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

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV10documentIDSSSgvp":{"name":"documentID","abstract":"

Unique identifier of the document.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV7queryIDSSSgvp":{"name":"queryID","abstract":"

Unique identifier of the query used for relevance training.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV8severitySSSgvp":{"name":"severity","abstract":"

Severity level of the notice.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV4stepSSSgvp":{"name":"step","abstract":"

Ingestion or training step in which the notice occurred.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the notice.

","parent_name":"Notice"},"Structs/NormalizationOperation/Operation.html#/s:11DiscoveryV122NormalizationOperationV0D0O4copyA2EmF":{"name":"copy","abstract":"

Undocumented

","parent_name":"Operation"},"Structs/NormalizationOperation/Operation.html#/s:11DiscoveryV122NormalizationOperationV0D0O4moveA2EmF":{"name":"move","abstract":"

Undocumented

","parent_name":"Operation"},"Structs/NormalizationOperation/Operation.html#/s:11DiscoveryV122NormalizationOperationV0D0O5mergeA2EmF":{"name":"merge","abstract":"

Undocumented

","parent_name":"Operation"},"Structs/NormalizationOperation/Operation.html#/s:11DiscoveryV122NormalizationOperationV0D0O6removeA2EmF":{"name":"remove","abstract":"

Undocumented

","parent_name":"Operation"},"Structs/NormalizationOperation/Operation.html#/s:11DiscoveryV122NormalizationOperationV0D0O11removeNullsA2EmF":{"name":"removeNulls","abstract":"

Undocumented

","parent_name":"Operation"},"Structs/NormalizationOperation/Operation.html":{"name":"Operation","abstract":"

Identifies what type of operation to perform.","parent_name":"NormalizationOperation"},"Structs/NormalizationOperation.html#/s:11DiscoveryV122NormalizationOperationV9operationSSSgvp":{"name":"operation","abstract":"

Identifies what type of operation to perform.

","parent_name":"NormalizationOperation"},"Structs/NormalizationOperation.html#/s:11DiscoveryV122NormalizationOperationV11sourceFieldSSSgvp":{"name":"sourceField","abstract":"

The source field for the operation.

","parent_name":"NormalizationOperation"},"Structs/NormalizationOperation.html#/s:11DiscoveryV122NormalizationOperationV16destinationFieldSSSgvp":{"name":"destinationField","abstract":"

The destination field for the operation.

","parent_name":"NormalizationOperation"},"Structs/NormalizationOperation.html#/s:11DiscoveryV122NormalizationOperationVACSSSg9operation_AD11sourceFieldAD011destinationG0tcfc":{"name":"init(operation:sourceField:destinationField:)","abstract":"

Initialize a NormalizationOperation with member variables.

","parent_name":"NormalizationOperation"},"Structs/NluEnrichmentSentiment.html#/s:11DiscoveryV122NluEnrichmentSentimentV8documentSbSgvp":{"name":"document","abstract":"

When true, sentiment analysis is performed on the entire field.

","parent_name":"NluEnrichmentSentiment"},"Structs/NluEnrichmentSentiment.html#/s:11DiscoveryV122NluEnrichmentSentimentV7targetsSaySSGSgvp":{"name":"targets","abstract":"

A comma-separated list of target strings that will have any associated sentiment analyzed.

","parent_name":"NluEnrichmentSentiment"},"Structs/NluEnrichmentSentiment.html#/s:11DiscoveryV122NluEnrichmentSentimentVACSbSg8document_SaySSGSg7targetstcfc":{"name":"init(document:targets:)","abstract":"

Initialize a NluEnrichmentSentiment with member variables.

","parent_name":"NluEnrichmentSentiment"},"Structs/NluEnrichmentSemanticRoles.html#/s:11DiscoveryV126NluEnrichmentSemanticRolesV8entitiesSbSgvp":{"name":"entities","abstract":"

When true entities are extracted from the identified sentence parts.

","parent_name":"NluEnrichmentSemanticRoles"},"Structs/NluEnrichmentSemanticRoles.html#/s:11DiscoveryV126NluEnrichmentSemanticRolesV8keywordsSbSgvp":{"name":"keywords","abstract":"

When true, keywords are extracted from the identified sentence parts.

","parent_name":"NluEnrichmentSemanticRoles"},"Structs/NluEnrichmentSemanticRoles.html#/s:11DiscoveryV126NluEnrichmentSemanticRolesV5limitSiSgvp":{"name":"limit","abstract":"

The maximum number of semantic roles enrichments to extact from each instance of the specified field.

","parent_name":"NluEnrichmentSemanticRoles"},"Structs/NluEnrichmentSemanticRoles.html#/s:11DiscoveryV126NluEnrichmentSemanticRolesVACSbSg8entities_AD8keywordsSiSg5limittcfc":{"name":"init(entities:keywords:limit:)","abstract":"

Initialize a NluEnrichmentSemanticRoles with member variables.

","parent_name":"NluEnrichmentSemanticRoles"},"Structs/NluEnrichmentRelations.html#/s:11DiscoveryV122NluEnrichmentRelationsV5modelSSSgvp":{"name":"model","abstract":"

For use with natural_language_understanding enrichments only.* The enrichement model to use with relationship extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge Graph en-news, the default isen-news.

","parent_name":"NluEnrichmentRelations"},"Structs/NluEnrichmentRelations.html#/s:11DiscoveryV122NluEnrichmentRelationsVACSSSg5model_tcfc":{"name":"init(model:)","abstract":"

Initialize a NluEnrichmentRelations with member variables.

","parent_name":"NluEnrichmentRelations"},"Structs/NluEnrichmentKeywords.html#/s:11DiscoveryV121NluEnrichmentKeywordsV9sentimentSbSgvp":{"name":"sentiment","abstract":"

When true, sentiment analysis of keywords will be performed on the specified field.

","parent_name":"NluEnrichmentKeywords"},"Structs/NluEnrichmentKeywords.html#/s:11DiscoveryV121NluEnrichmentKeywordsV7emotionSbSgvp":{"name":"emotion","abstract":"

When true, emotion detection of keywords will be performed on the specified field.

","parent_name":"NluEnrichmentKeywords"},"Structs/NluEnrichmentKeywords.html#/s:11DiscoveryV121NluEnrichmentKeywordsV5limitSiSgvp":{"name":"limit","abstract":"

The maximum number of keywords to extract for each instance of the specified field.

","parent_name":"NluEnrichmentKeywords"},"Structs/NluEnrichmentKeywords.html#/s:11DiscoveryV121NluEnrichmentKeywordsVACSbSg9sentiment_AD7emotionSiSg5limittcfc":{"name":"init(sentiment:emotion:limit:)","abstract":"

Initialize a NluEnrichmentKeywords with member variables.

","parent_name":"NluEnrichmentKeywords"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV8keywordsAA0cD8KeywordsVSgvp":{"name":"keywords","abstract":"

An object specifying the Keyword enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV8entitiesAA0cD8EntitiesVSgvp":{"name":"entities","abstract":"

An object speficying the Entities enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV9sentimentAA0cD9SentimentVSgvp":{"name":"sentiment","abstract":"

An object specifying the sentiment extraction enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV7emotionAA0cD7EmotionVSgvp":{"name":"emotion","abstract":"

An object specifying the emotion detection enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV10categoriesAA0cD10CategoriesVSgvp":{"name":"categories","abstract":"

An object specifying the categories enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV13semanticRolesAA0cd8SemanticG0VSgvp":{"name":"semanticRoles","abstract":"

An object specifiying the semantic roles enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV9relationsAA0cD9RelationsVSgvp":{"name":"relations","abstract":"

An object specifying the relations enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesVAcA0cD8KeywordsVSg8keywords_AA0cD8EntitiesVSg8entitiesAA0cD9SentimentVSg9sentimentAA0cD7EmotionVSg7emotionAA0cD10CategoriesVSg10categoriesAA0cD13SemanticRolesVSg08semanticQ0AA0cD9RelationsVSg9relationstcfc":{"name":"init(keywords:entities:sentiment:emotion:categories:semanticRoles:relations:)","abstract":"

Initialize a NluEnrichmentFeatures with member variables.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV9sentimentSbSgvp":{"name":"sentiment","abstract":"

When true, sentiment analysis of entities will be performed on the specified field.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV7emotionSbSgvp":{"name":"emotion","abstract":"

When true, emotion detection of entities will be performed on the specified field.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV5limitSiSgvp":{"name":"limit","abstract":"

The maximum number of entities to extract for each instance of the specified field.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV8mentionsSbSgvp":{"name":"mentions","abstract":"

When true, the number of mentions of each identified entity is recorded. The default is false.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV12mentionTypesSbSgvp":{"name":"mentionTypes","abstract":"

When true, the types of mentions for each idetifieid entity is recorded. The default is false.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV16sentenceLocationSbSgvp":{"name":"sentenceLocation","abstract":"

When true, a list of sentence locations for each instance of each identified entity is recorded. The default is false.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV5modelSSSgvp":{"name":"model","abstract":"

The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge Studio, the public model for use with Knowledge Graph en-news, or the default public model alchemy.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesVACSbSg9sentiment_AD7emotionSiSg5limitAD8mentionsAD12mentionTypesAD16sentenceLocationSSSg5modeltcfc":{"name":"init(sentiment:emotion:limit:mentions:mentionTypes:sentenceLocation:model:)","abstract":"

Initialize a NluEnrichmentEntities with member variables.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEmotion.html#/s:11DiscoveryV120NluEnrichmentEmotionV8documentSbSgvp":{"name":"document","abstract":"

When true, emotion detection is performed on the entire field.

","parent_name":"NluEnrichmentEmotion"},"Structs/NluEnrichmentEmotion.html#/s:11DiscoveryV120NluEnrichmentEmotionV7targetsSaySSGSgvp":{"name":"targets","abstract":"

A comma-separated list of target strings that will have any associated emotions detected.

","parent_name":"NluEnrichmentEmotion"},"Structs/NluEnrichmentEmotion.html#/s:11DiscoveryV120NluEnrichmentEmotionVACSbSg8document_SaySSGSg7targetstcfc":{"name":"init(document:targets:)","abstract":"

Initialize a NluEnrichmentEmotion with member variables.

","parent_name":"NluEnrichmentEmotion"},"Structs/NluEnrichmentCategories.html#/s:11DiscoveryV123NluEnrichmentCategoriesV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"NluEnrichmentCategories"},"Structs/NluEnrichmentCategories.html#/s:11DiscoveryV123NluEnrichmentCategoriesVACs10DictionaryVySSAA4JSONOG20additionalProperties_tcfc":{"name":"init(additionalProperties:)","abstract":"

Initialize a NluEnrichmentCategories.

","parent_name":"NluEnrichmentCategories"},"Structs/NluEnrichmentCategories.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"NluEnrichmentCategories"},"Structs/NluEnrichmentCategories.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"NluEnrichmentCategories"},"Structs/Nested.html#/s:11DiscoveryV16NestedV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Nested"},"Structs/Nested.html#/s:11DiscoveryV16NestedV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Nested"},"Structs/Nested.html#/s:11DiscoveryV16NestedV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Nested"},"Structs/Nested.html#/s:11DiscoveryV16NestedV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Nested"},"Structs/Nested.html#/s:11DiscoveryV16NestedV4pathSSSgvp":{"name":"path","abstract":"

The area of the results the aggregation was restricted to.

","parent_name":"Nested"},"Structs/MemoryUsage.html#/s:11DiscoveryV111MemoryUsageV9usedBytesSiSgvp":{"name":"usedBytes","abstract":"

Deprecated**: Number of bytes used in the environment’s memory capacity.

","parent_name":"MemoryUsage"},"Structs/MemoryUsage.html#/s:11DiscoveryV111MemoryUsageV10totalBytesSiSgvp":{"name":"totalBytes","abstract":"

Deprecated**: Total number of bytes available in the environment’s memory capacity.

","parent_name":"MemoryUsage"},"Structs/MemoryUsage.html#/s:11DiscoveryV111MemoryUsageV4usedSSSgvp":{"name":"used","abstract":"

Deprecated**: Amount of memory capacity used, in KB or GB format.

","parent_name":"MemoryUsage"},"Structs/MemoryUsage.html#/s:11DiscoveryV111MemoryUsageV5totalSSSgvp":{"name":"total","abstract":"

Deprecated**: Total amount of the environment’s memory capacity, in KB or GB format.

","parent_name":"MemoryUsage"},"Structs/MemoryUsage.html#/s:11DiscoveryV111MemoryUsageV11percentUsedSdSgvp":{"name":"percentUsed","abstract":"

Deprecated**: Percentage of the environment’s memory capacity that is being used.

","parent_name":"MemoryUsage"},"Structs/ListEnvironmentsResponse.html#/s:11DiscoveryV124ListEnvironmentsResponseV12environmentsSayAA11EnvironmentVGSgvp":{"name":"environments","abstract":"

An array of [environments] that are available for the service instance.

","parent_name":"ListEnvironmentsResponse"},"Structs/ListConfigurationsResponse.html#/s:11DiscoveryV126ListConfigurationsResponseV14configurationsSayAA13ConfigurationVGSgvp":{"name":"configurations","abstract":"

An array of Configurations that are available for the service instance.

","parent_name":"ListConfigurationsResponse"},"Structs/ListCollectionsResponse.html#/s:11DiscoveryV123ListCollectionsResponseV11collectionsSayAA10CollectionVGSgvp":{"name":"collections","abstract":"

An array containing information about each collection in the environment.

","parent_name":"ListCollectionsResponse"},"Structs/ListCollectionFieldsResponse.html#/s:11DiscoveryV128ListCollectionFieldsResponseV6fieldsSayAA5FieldVGSgvp":{"name":"fields","abstract":"

An array containing information about each field in the collections.

","parent_name":"ListCollectionFieldsResponse"},"Structs/IndexCapacity.html#/s:11DiscoveryV113IndexCapacityV9documentsAA20EnvironmentDocumentsVSgvp":{"name":"documents","abstract":"

Summary of the document usage statistics for the environment.

","parent_name":"IndexCapacity"},"Structs/IndexCapacity.html#/s:11DiscoveryV113IndexCapacityV9diskUsageAA04DiskF0VSgvp":{"name":"diskUsage","abstract":"

Summary of the disk usage of the environment.

","parent_name":"IndexCapacity"},"Structs/IndexCapacity.html#/s:11DiscoveryV113IndexCapacityV11collectionsAA15CollectionUsageVSgvp":{"name":"collections","abstract":"

Summary of the collection usage in the environment.

","parent_name":"IndexCapacity"},"Structs/IndexCapacity.html#/s:11DiscoveryV113IndexCapacityV11memoryUsageAA06MemoryF0VSgvp":{"name":"memoryUsage","abstract":"

Deprecated**: Summary of the memory usage of the environment.

","parent_name":"IndexCapacity"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV21excludeTagsCompletelySaySSGSgvp":{"name":"excludeTagsCompletely","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV22excludeTagsKeepContentSaySSGSgvp":{"name":"excludeTagsKeepContent","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV11keepContentAA13XPathPatternsVSgvp":{"name":"keepContent","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV14excludeContentAA13XPathPatternsVSgvp":{"name":"excludeContent","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV17keepTagAttributesSaySSGSgvp":{"name":"keepTagAttributes","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV20excludeTagAttributesSaySSGSgvp":{"name":"excludeTagAttributes","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsVACSaySSGSg21excludeTagsCompletely_AE0eF11KeepContentAA13XPathPatternsVSg04keepI0AJ0eI0AE0L13TagAttributesAE0emN0tcfc":{"name":"init(excludeTagsCompletely:excludeTagsKeepContent:keepContent:excludeContent:keepTagAttributes:excludeTagAttributes:)","abstract":"

Initialize a HtmlSettings with member variables.

","parent_name":"HtmlSettings"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Histogram"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Histogram"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Histogram"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Histogram"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV5fieldSSSgvp":{"name":"field","abstract":"

The field where the aggregation is located in the document.

","parent_name":"Histogram"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV8intervalSiSgvp":{"name":"interval","abstract":"

Interval of the aggregation. (For ‘histogram’ type).

","parent_name":"Histogram"},"Structs/GenericQueryAggregation.html#/s:11DiscoveryV123GenericQueryAggregationV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"GenericQueryAggregation"},"Structs/GenericQueryAggregation.html#/s:11DiscoveryV123GenericQueryAggregationV7resultsSayAA0E6ResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"GenericQueryAggregation"},"Structs/GenericQueryAggregation.html#/s:11DiscoveryV123GenericQueryAggregationV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"GenericQueryAggregation"},"Structs/GenericQueryAggregation.html#/s:11DiscoveryV123GenericQueryAggregationV12aggregationsSayAA0dE0OGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"GenericQueryAggregation"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV5levelSiSgvp":{"name":"level","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV7minSizeSiSgvp":{"name":"minSize","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV7maxSizeSiSgvp":{"name":"maxSize","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV4boldSbSgvp":{"name":"bold","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV6italicSbSgvp":{"name":"italic","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV4nameSSSgvp":{"name":"name","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingVACSiSg5level_AD7minSizeAD03maxG0SbSg4boldAH6italicSSSg4nametcfc":{"name":"init(level:minSize:maxSize:bold:italic:name:)","abstract":"

Initialize a FontSetting with member variables.

","parent_name":"FontSetting"},"Structs/Filter.html#/s:11DiscoveryV16FilterV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Filter"},"Structs/Filter.html#/s:11DiscoveryV16FilterV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Filter"},"Structs/Filter.html#/s:11DiscoveryV16FilterV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Filter"},"Structs/Filter.html#/s:11DiscoveryV16FilterV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Filter"},"Structs/Filter.html#/s:11DiscoveryV16FilterV5matchSSSgvp":{"name":"match","abstract":"

The match the aggregated results queried for.

","parent_name":"Filter"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO6nestedA2EmF":{"name":"nested","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO6stringA2EmF":{"name":"string","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO4dateA2EmF":{"name":"date","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO4longA2EmF":{"name":"long","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO7integerA2EmF":{"name":"integer","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO5shortA2EmF":{"name":"short","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO4byteA2EmF":{"name":"byte","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO6doubleA2EmF":{"name":"double","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO5floatA2EmF":{"name":"float","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO7booleanA2EmF":{"name":"boolean","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO6binaryA2EmF":{"name":"binary","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html":{"name":"FieldType","abstract":"

The type of the field.

","parent_name":"Field"},"Structs/Field.html#/s:11DiscoveryV15FieldV9fieldNameSSSgvp":{"name":"fieldName","abstract":"

The name of the field.

","parent_name":"Field"},"Structs/Field.html#/s:11DiscoveryV15FieldV9fieldTypeSSSgvp":{"name":"fieldType","abstract":"

The type of the field.

","parent_name":"Field"},"Structs/Expansions.html#/s:11DiscoveryV110ExpansionsV10expansionsSayAA9ExpansionVGvp":{"name":"expansions","abstract":"

An array of query expansion definitions. Each object in the expansions array represents a term or set of terms that will be expanded into other terms. Each expansion object can be configured so that all terms are expanded to all other terms in the object - bi-directional, or a set list of terms can be expanded into a second list of terms - uni-directional. To create a bi-directional expansion specify an expanded_terms array. When found in a query, all items in the expanded_terms array are then expanded to the other items in the same array. To create a uni-directional expansion, specify both an array of input_terms and an array of expanded_terms. When items in the input_terms array are present in a query, they are expanded using the items listed in the expanded_terms array.

","parent_name":"Expansions"},"Structs/Expansions.html#/s:11DiscoveryV110ExpansionsVACSayAA9ExpansionVG10expansions_tcfc":{"name":"init(expansions:)","abstract":"

Initialize a Expansions with member variables.

","parent_name":"Expansions"},"Structs/Expansion.html#/s:11DiscoveryV19ExpansionV10inputTermsSaySSGSgvp":{"name":"inputTerms","abstract":"

A list of terms that will be expanded for this expansion. If specified, only the items in this list are expanded.

","parent_name":"Expansion"},"Structs/Expansion.html#/s:11DiscoveryV19ExpansionV13expandedTermsSaySSGvp":{"name":"expandedTerms","abstract":"

A list of terms that this expansion will be expanded to. If specified without input_terms, it also functions as the input term list.

","parent_name":"Expansion"},"Structs/Expansion.html#/s:11DiscoveryV19ExpansionVACSaySSG13expandedTerms_ADSg05inputE0tcfc":{"name":"init(expandedTerms:inputTerms:)","abstract":"

Initialize a Expansion with member variables.

","parent_name":"Expansion"},"Structs/EnvironmentDocuments.html#/s:11DiscoveryV120EnvironmentDocumentsV7indexedSiSgvp":{"name":"indexed","abstract":"

Number of documents indexed for the environment.

","parent_name":"EnvironmentDocuments"},"Structs/EnvironmentDocuments.html#/s:11DiscoveryV120EnvironmentDocumentsV14maximumAllowedSiSgvp":{"name":"maximumAllowed","abstract":"

Total number of documents allowed in the environment’s capacity.

","parent_name":"EnvironmentDocuments"},"Structs/Environment/Status.html#/s:11DiscoveryV111EnvironmentV6StatusO6activeA2EmF":{"name":"active","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Environment/Status.html#/s:11DiscoveryV111EnvironmentV6StatusO7pendingA2EmF":{"name":"pending","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Environment/Status.html#/s:11DiscoveryV111EnvironmentV6StatusO11maintenanceA2EmF":{"name":"maintenance","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Environment/Status.html":{"name":"Status","abstract":"

Status of the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV13environmentIDSSSgvp":{"name":"environmentID","abstract":"

Unique identifier for the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV4nameSSSgvp":{"name":"name","abstract":"

Name that identifies the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV11descriptionSSSgvp":{"name":"description","abstract":"

Description of the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV7createdSSSgvp":{"name":"created","abstract":"

Creation date of the environment, in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV7updatedSSSgvp":{"name":"updated","abstract":"

Date of most recent environment update, in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV6statusSSSgvp":{"name":"status","abstract":"

Status of the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV8readOnlySbSgvp":{"name":"readOnly","abstract":"

If true, then the environment contains read-only collections which are maintained by IBM.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV4sizeSiSgvp":{"name":"size","abstract":"

Deprecated**: Size of the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV13indexCapacityAA05IndexE0VSgvp":{"name":"indexCapacity","abstract":"

Details about the resource usage and capacity of the environment.

","parent_name":"Environment"},"Structs/EnrichmentOptions.html#/s:11DiscoveryV117EnrichmentOptionsV8featuresAA03NluC8FeaturesVSgvp":{"name":"features","abstract":"

An object representing the enrichment features that will be applied to the specified field.

","parent_name":"EnrichmentOptions"},"Structs/EnrichmentOptions.html#/s:11DiscoveryV117EnrichmentOptionsV5modelSSSgvp":{"name":"model","abstract":"

For use with elements enrichments only.* The element extraction model to use. Models available are: contract.

","parent_name":"EnrichmentOptions"},"Structs/EnrichmentOptions.html#/s:11DiscoveryV117EnrichmentOptionsVAcA03NluC8FeaturesVSg8features_SSSg5modeltcfc":{"name":"init(features:model:)","abstract":"

Initialize a EnrichmentOptions with member variables.

","parent_name":"EnrichmentOptions"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV11descriptionSSSgvp":{"name":"description","abstract":"

Describes what the enrichment step does.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV16destinationFieldSSvp":{"name":"destinationField","abstract":"

Field where enrichments will be stored. This field must already exist or be at most 1 level deeper than an existing field. For example, if text is a top-level field with no sub-fields, text.foo is a valid destination but text.foo.bar is not.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV11sourceFieldSSvp":{"name":"sourceField","abstract":"

Field to be enriched.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV9overwriteSbSgvp":{"name":"overwrite","abstract":"

Indicates that the enrichments will overwrite the destination_field field if it already exists.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV14enrichmentNameSSvp":{"name":"enrichmentName","abstract":"

Name of the enrichment service to call. Current options are natural_language_understanding and elements. When using natual_language_understanding, the options object must contain Natural Language Understanding Options. When using elements the options object must contain Element Classification options. Additionally, when using the elements enrichment the configuration specified and files ingested must meet all the criteria specified in the documentation Previous API versions also supported alchemy_language.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV22ignoreDownstreamErrorsSbSgvp":{"name":"ignoreDownstreamErrors","abstract":"

If true, then most errors generated during the enrichment process will be treated as warnings and will not cause the document to fail processing.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV7optionsAA0C7OptionsVSgvp":{"name":"options","abstract":"

A list of options specific to the enrichment.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentVACSS16destinationField_SS06sourceE0SS14enrichmentNameSSSg11descriptionSbSg9overwriteAI22ignoreDownstreamErrorsAA0C7OptionsVSg7optionstcfc":{"name":"init(destinationField:sourceField:enrichmentName:description:overwrite:ignoreDownstreamErrors:options:)","abstract":"

Initialize a Enrichment with member variables.

","parent_name":"Enrichment"},"Structs/DocumentStatus/FileType.html#/s:11DiscoveryV114DocumentStatusV8FileTypeO3pdfA2EmF":{"name":"pdf","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/DocumentStatus/FileType.html#/s:11DiscoveryV114DocumentStatusV8FileTypeO4htmlA2EmF":{"name":"html","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/DocumentStatus/FileType.html#/s:11DiscoveryV114DocumentStatusV8FileTypeO4wordA2EmF":{"name":"word","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/DocumentStatus/FileType.html#/s:11DiscoveryV114DocumentStatusV8FileTypeO4jsonA2EmF":{"name":"json","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/DocumentStatus/Status.html#/s:11DiscoveryV114DocumentStatusV0D0O9availableA2EmF":{"name":"available","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DocumentStatus/Status.html#/s:11DiscoveryV114DocumentStatusV0D0O20availableWithNoticesA2EmF":{"name":"availableWithNotices","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DocumentStatus/Status.html#/s:11DiscoveryV114DocumentStatusV0D0O6failedA2EmF":{"name":"failed","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DocumentStatus/Status.html#/s:11DiscoveryV114DocumentStatusV0D0O10processingA2EmF":{"name":"processing","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DocumentStatus/Status.html":{"name":"Status","abstract":"

Status of the document in the ingestion process.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus/FileType.html":{"name":"FileType","abstract":"

The type of the original source file.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV10documentIDSSvp":{"name":"documentID","abstract":"

The unique identifier of the document.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV15configurationIDSSSgvp":{"name":"configurationID","abstract":"

The unique identifier for the configuration.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV7createdSSSgvp":{"name":"created","abstract":"

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

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV7updatedSSSgvp":{"name":"updated","abstract":"

Date of the most recent document update, in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV6statusSSvp":{"name":"status","abstract":"

Status of the document in the ingestion process.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV17statusDescriptionSSvp":{"name":"statusDescription","abstract":"

Description of the document status.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV8filenameSSSgvp":{"name":"filename","abstract":"

Name of the original source file (if available).

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV8fileTypeSSSgvp":{"name":"fileType","abstract":"

The type of the original source file.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV4sha1SSSgvp":{"name":"sha1","abstract":"

The SHA-1 hash of the original source file (formatted as a hexadecimal string).

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV7noticesSayAA6NoticeVGvp":{"name":"notices","abstract":"

Array of notices produced by the document-ingestion process.

","parent_name":"DocumentStatus"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO9htmlInputA2EmF":{"name":"htmlInput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO10htmlOutputA2EmF":{"name":"htmlOutput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO10jsonOutputA2EmF":{"name":"jsonOutput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO24jsonNormalizationsOutputA2EmF":{"name":"jsonNormalizationsOutput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO17enrichmentsOutputA2EmF":{"name":"enrichmentsOutput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO20normalizationsOutputA2EmF":{"name":"normalizationsOutput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html":{"name":"Step","abstract":"

Undocumented

","parent_name":"DocumentSnapshot"},"Structs/DocumentSnapshot.html#/s:11DiscoveryV116DocumentSnapshotV4stepSSSgvp":{"name":"step","abstract":"

Undocumented

","parent_name":"DocumentSnapshot"},"Structs/DocumentSnapshot.html#/s:11DiscoveryV116DocumentSnapshotV8snapshots10DictionaryVySSAA4JSONOGSgvp":{"name":"snapshot","abstract":"

Undocumented

","parent_name":"DocumentSnapshot"},"Structs/DocumentCounts.html#/s:11DiscoveryV114DocumentCountsV9availableSiSgvp":{"name":"available","abstract":"

The total number of available documents in the collection.

","parent_name":"DocumentCounts"},"Structs/DocumentCounts.html#/s:11DiscoveryV114DocumentCountsV10processingSiSgvp":{"name":"processing","abstract":"

The number of documents in the collection that are currently being processed.

","parent_name":"DocumentCounts"},"Structs/DocumentCounts.html#/s:11DiscoveryV114DocumentCountsV6failedSiSgvp":{"name":"failed","abstract":"

The number of documents in the collection that failed to be ingested.

","parent_name":"DocumentCounts"},"Structs/DocumentAccepted/Status.html#/s:11DiscoveryV116DocumentAcceptedV6StatusO10processingA2EmF":{"name":"processing","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DocumentAccepted/Status.html":{"name":"Status","abstract":"

Status of the document in the ingestion process.

","parent_name":"DocumentAccepted"},"Structs/DocumentAccepted.html#/s:11DiscoveryV116DocumentAcceptedV10documentIDSSSgvp":{"name":"documentID","abstract":"

The unique identifier of the ingested document.

","parent_name":"DocumentAccepted"},"Structs/DocumentAccepted.html#/s:11DiscoveryV116DocumentAcceptedV6statusSSSgvp":{"name":"status","abstract":"

Status of the document in the ingestion process.

","parent_name":"DocumentAccepted"},"Structs/DocumentAccepted.html#/s:11DiscoveryV116DocumentAcceptedV7noticesSayAA6NoticeVGSgvp":{"name":"notices","abstract":"

Array of notices produced by the document-ingestion process.

","parent_name":"DocumentAccepted"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV9usedBytesSiSgvp":{"name":"usedBytes","abstract":"

Number of bytes used on the environment’s disk capacity.

","parent_name":"DiskUsage"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV19maximumAllowedBytesSiSgvp":{"name":"maximumAllowedBytes","abstract":"

Total number of bytes available in the environment’s disk capacity.

","parent_name":"DiskUsage"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV10totalBytesSiSgvp":{"name":"totalBytes","abstract":"

Deprecated**: Total number of bytes available in the environment’s disk capacity.

","parent_name":"DiskUsage"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV4usedSSSgvp":{"name":"used","abstract":"

Deprecated**: Amount of disk capacity used, in KB or GB format.

","parent_name":"DiskUsage"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV5totalSSSgvp":{"name":"total","abstract":"

Deprecated**: Total amount of the environment’s disk capacity, in KB or GB format.

","parent_name":"DiskUsage"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV11percentUsedSdSgvp":{"name":"percentUsed","abstract":"

Deprecated**: Percentage of the environment’s disk capacity that is being used.

","parent_name":"DiskUsage"},"Structs/DeleteEnvironmentResponse/Status.html#/s:11DiscoveryV125DeleteEnvironmentResponseV6StatusO7deletedA2EmF":{"name":"deleted","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DeleteEnvironmentResponse/Status.html":{"name":"Status","abstract":"

Status of the environment.

","parent_name":"DeleteEnvironmentResponse"},"Structs/DeleteEnvironmentResponse.html#/s:11DiscoveryV125DeleteEnvironmentResponseV13environmentIDSSvp":{"name":"environmentID","abstract":"

The unique identifier for the environment.

","parent_name":"DeleteEnvironmentResponse"},"Structs/DeleteEnvironmentResponse.html#/s:11DiscoveryV125DeleteEnvironmentResponseV6statusSSvp":{"name":"status","abstract":"

Status of the environment.

","parent_name":"DeleteEnvironmentResponse"},"Structs/DeleteDocumentResponse/Status.html#/s:11DiscoveryV122DeleteDocumentResponseV6StatusO7deletedA2EmF":{"name":"deleted","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DeleteDocumentResponse/Status.html":{"name":"Status","abstract":"

Status of the document. A deleted document has the status deleted.

","parent_name":"DeleteDocumentResponse"},"Structs/DeleteDocumentResponse.html#/s:11DiscoveryV122DeleteDocumentResponseV10documentIDSSSgvp":{"name":"documentID","abstract":"

The unique identifier of the document.

","parent_name":"DeleteDocumentResponse"},"Structs/DeleteDocumentResponse.html#/s:11DiscoveryV122DeleteDocumentResponseV6statusSSSgvp":{"name":"status","abstract":"

Status of the document. A deleted document has the status deleted.

","parent_name":"DeleteDocumentResponse"},"Structs/DeleteConfigurationResponse/Status.html#/s:11DiscoveryV127DeleteConfigurationResponseV6StatusO7deletedA2EmF":{"name":"deleted","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DeleteConfigurationResponse/Status.html":{"name":"Status","abstract":"

Status of the configuration. A deleted configuration has the status deleted.

","parent_name":"DeleteConfigurationResponse"},"Structs/DeleteConfigurationResponse.html#/s:11DiscoveryV127DeleteConfigurationResponseV15configurationIDSSvp":{"name":"configurationID","abstract":"

The unique identifier for the configuration.

","parent_name":"DeleteConfigurationResponse"},"Structs/DeleteConfigurationResponse.html#/s:11DiscoveryV127DeleteConfigurationResponseV6statusSSvp":{"name":"status","abstract":"

Status of the configuration. A deleted configuration has the status deleted.

","parent_name":"DeleteConfigurationResponse"},"Structs/DeleteConfigurationResponse.html#/s:11DiscoveryV127DeleteConfigurationResponseV7noticesSayAA6NoticeVGSgvp":{"name":"notices","abstract":"

An array of notice messages, if any.

","parent_name":"DeleteConfigurationResponse"},"Structs/DeleteCollectionResponse/Status.html#/s:11DiscoveryV124DeleteCollectionResponseV6StatusO7deletedA2EmF":{"name":"deleted","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DeleteCollectionResponse/Status.html":{"name":"Status","abstract":"

The status of the collection. The status of a successful deletion operation is deleted.

","parent_name":"DeleteCollectionResponse"},"Structs/DeleteCollectionResponse.html#/s:11DiscoveryV124DeleteCollectionResponseV12collectionIDSSvp":{"name":"collectionID","abstract":"

The unique identifier of the collection that is being deleted.

","parent_name":"DeleteCollectionResponse"},"Structs/DeleteCollectionResponse.html#/s:11DiscoveryV124DeleteCollectionResponseV6statusSSvp":{"name":"status","abstract":"

The status of the collection. The status of a successful deletion operation is deleted.

","parent_name":"DeleteCollectionResponse"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2enA2EmF":{"name":"en","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2esA2EmF":{"name":"es","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2deA2EmF":{"name":"de","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2arA2EmF":{"name":"ar","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2frA2EmF":{"name":"fr","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2itA2EmF":{"name":"it","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2jaA2EmF":{"name":"ja","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2koA2EmF":{"name":"ko","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2ptA2EmF":{"name":"pt","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html":{"name":"Language","abstract":"

The language of the documents stored in the collection, in the form of an ISO 639-1 language code.

","parent_name":"CreateCollectionRequest"},"Structs/CreateCollectionRequest.html#/s:11DiscoveryV123CreateCollectionRequestV4nameSSvp":{"name":"name","abstract":"

The name of the collection to be created.

","parent_name":"CreateCollectionRequest"},"Structs/CreateCollectionRequest.html#/s:11DiscoveryV123CreateCollectionRequestV11descriptionSSSgvp":{"name":"description","abstract":"

A description of the collection.

","parent_name":"CreateCollectionRequest"},"Structs/CreateCollectionRequest.html#/s:11DiscoveryV123CreateCollectionRequestV15configurationIDSSSgvp":{"name":"configurationID","abstract":"

The ID of the configuration in which the collection is to be created.

","parent_name":"CreateCollectionRequest"},"Structs/CreateCollectionRequest.html#/s:11DiscoveryV123CreateCollectionRequestV8languageSSSgvp":{"name":"language","abstract":"

The language of the documents stored in the collection, in the form of an ISO 639-1 language code.

","parent_name":"CreateCollectionRequest"},"Structs/CreateCollectionRequest.html#/s:11DiscoveryV123CreateCollectionRequestVACSS4name_SSSg11descriptionAE15configurationIDAE8languagetcfc":{"name":"init(name:description:configurationID:language:)","abstract":"

Initialize a CreateCollectionRequest with member variables.

","parent_name":"CreateCollectionRequest"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsV3pdfAA11PdfSettingsVSgvp":{"name":"pdf","abstract":"

A list of PDF conversion settings.

","parent_name":"Conversions"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsV4wordAA12WordSettingsVSgvp":{"name":"word","abstract":"

A list of Word conversion settings.

","parent_name":"Conversions"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsV4htmlAA12HtmlSettingsVSgvp":{"name":"html","abstract":"

A list of HTML conversion settings.

","parent_name":"Conversions"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsV7segmentAA15SegmentSettingsVSgvp":{"name":"segment","abstract":"

A list of Document Segmentation settings.

","parent_name":"Conversions"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsV18jsonNormalizationsSayAA22NormalizationOperationVGSgvp":{"name":"jsonNormalizations","abstract":"

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are executed in the order that they appear in the array.

","parent_name":"Conversions"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsVAcA11PdfSettingsVSg3pdf_AA04WordE0VSg4wordAA04HtmlE0VSg4htmlAA07SegmentE0VSg7segmentSayAA22NormalizationOperationVGSg18jsonNormalizationstcfc":{"name":"init(pdf:word:html:segment:jsonNormalizations:)","abstract":"

Initialize a Conversions with member variables.

","parent_name":"Conversions"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV15configurationIDSSSgvp":{"name":"configurationID","abstract":"

The unique identifier of the configuration.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV4nameSSvp":{"name":"name","abstract":"

The name of the configuration.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV7createdSSSgvp":{"name":"created","abstract":"

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

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp of when the configuration was last updated in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the configuration, if available.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV11conversionsAA11ConversionsVSgvp":{"name":"conversions","abstract":"

The document conversion settings for the configuration.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV11enrichmentsSayAA10EnrichmentVGSgvp":{"name":"enrichments","abstract":"

An array of document enrichment settings for the configuration.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV14normalizationsSayAA22NormalizationOperationVGSgvp":{"name":"normalizations","abstract":"

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are executed in the order that they appear in the array.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationVACSS4name_SSSg15configurationIDAE7createdAE7updatedAE11descriptionAA11ConversionsVSg11conversionsSayAA10EnrichmentVGSg11enrichmentsSayAA22NormalizationOperationVGSg14normalizationstcfc":{"name":"init(name:configurationID:created:updated:description:conversions:enrichments:normalizations:)","abstract":"

Initialize a Configuration with member variables.

","parent_name":"Configuration"},"Structs/CollectionUsage.html#/s:11DiscoveryV115CollectionUsageV9availableSiSgvp":{"name":"available","abstract":"

Number of active collections in the environment.

","parent_name":"CollectionUsage"},"Structs/CollectionUsage.html#/s:11DiscoveryV115CollectionUsageV14maximumAllowedSiSgvp":{"name":"maximumAllowed","abstract":"

Total number of collections allowed in the environment.

","parent_name":"CollectionUsage"},"Structs/CollectionDiskUsage.html#/s:11DiscoveryV119CollectionDiskUsageV9usedBytesSiSgvp":{"name":"usedBytes","abstract":"

Number of bytes used by the collection.

","parent_name":"CollectionDiskUsage"},"Structs/Collection/Status.html#/s:11DiscoveryV110CollectionV6StatusO6activeA2EmF":{"name":"active","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Collection/Status.html#/s:11DiscoveryV110CollectionV6StatusO7pendingA2EmF":{"name":"pending","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Collection/Status.html#/s:11DiscoveryV110CollectionV6StatusO11maintenanceA2EmF":{"name":"maintenance","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Collection/Status.html":{"name":"Status","abstract":"

The status of the collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV12collectionIDSSSgvp":{"name":"collectionID","abstract":"

The unique identifier of the collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV4nameSSSgvp":{"name":"name","abstract":"

The name of the collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV7createdSSSgvp":{"name":"created","abstract":"

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

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp of when the collection was last updated in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV6statusSSSgvp":{"name":"status","abstract":"

The status of the collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV15configurationIDSSSgvp":{"name":"configurationID","abstract":"

The unique identifier of the collection’s configuration.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV8languageSSSgvp":{"name":"language","abstract":"

The language of the documents stored in the collection. Permitted values include en (English), de (German), and es (Spanish).

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV14documentCountsAA08DocumentE0VSgvp":{"name":"documentCounts","abstract":"

The object providing information about the documents in the collection. Present only when retrieving details of a collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV9diskUsageAA0c4DiskE0VSgvp":{"name":"diskUsage","abstract":"

The object providing information about the disk usage of the collection. Present only when retrieving details of a collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV14trainingStatusAA08TrainingE0VSgvp":{"name":"trainingStatus","abstract":"

Provides information about the status of relevance training for collection.

","parent_name":"Collection"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Calculation"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Calculation"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Calculation"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Calculation"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV5fieldSSSgvp":{"name":"field","abstract":"

The field where the aggregation is located in the document.

","parent_name":"Calculation"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV5valueSdSgvp":{"name":"value","abstract":"

Value of the aggregation.

","parent_name":"Calculation"},"Structs/AggregationResult.html#/s:11DiscoveryV117AggregationResultV3keySSSgvp":{"name":"key","abstract":"

Key that matched the aggregation type.

","parent_name":"AggregationResult"},"Structs/AggregationResult.html#/s:11DiscoveryV117AggregationResultV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"AggregationResult"},"Structs/AggregationResult.html#/s:11DiscoveryV117AggregationResultV12aggregationsSayAA05QueryC0OGSgvp":{"name":"aggregations","abstract":"

Aggregations returned in the case of chained aggregations.

","parent_name":"AggregationResult"},"Structs/AggregationResult.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"AggregationResult"},"Structs/AggregationResult.html":{"name":"AggregationResult","abstract":"

AggregationResult.

"},"Structs/Calculation.html":{"name":"Calculation","abstract":"

Calculation.

"},"Structs/Collection.html":{"name":"Collection","abstract":"

A collection for storing documents.

"},"Structs/CollectionDiskUsage.html":{"name":"CollectionDiskUsage","abstract":"

Summary of the disk usage statistics for this collection.

"},"Structs/CollectionUsage.html":{"name":"CollectionUsage","abstract":"

Summary of the collection usage in the environment.

"},"Structs/Configuration.html":{"name":"Configuration","abstract":"

A custom configuration for the environment.

"},"Structs/Conversions.html":{"name":"Conversions","abstract":"

Document conversion settings.

"},"Structs/CreateCollectionRequest.html":{"name":"CreateCollectionRequest","abstract":"

CreateCollectionRequest.

"},"Structs/DeleteCollectionResponse.html":{"name":"DeleteCollectionResponse","abstract":"

DeleteCollectionResponse.

"},"Structs/DeleteConfigurationResponse.html":{"name":"DeleteConfigurationResponse","abstract":"

DeleteConfigurationResponse.

"},"Structs/DeleteDocumentResponse.html":{"name":"DeleteDocumentResponse","abstract":"

DeleteDocumentResponse.

"},"Structs/DeleteEnvironmentResponse.html":{"name":"DeleteEnvironmentResponse","abstract":"

DeleteEnvironmentResponse.

"},"Structs/DiskUsage.html":{"name":"DiskUsage","abstract":"

Summary of the disk usage statistics for the environment.

"},"Structs/DocumentAccepted.html":{"name":"DocumentAccepted","abstract":"

DocumentAccepted.

"},"Structs/DocumentCounts.html":{"name":"DocumentCounts","abstract":"

DocumentCounts.

"},"Structs/DocumentSnapshot.html":{"name":"DocumentSnapshot","abstract":"

DocumentSnapshot.

"},"Structs/DocumentStatus.html":{"name":"DocumentStatus","abstract":"

Status information about a submitted document.

"},"Structs/Enrichment.html":{"name":"Enrichment","abstract":"

Enrichment.

"},"Structs/EnrichmentOptions.html":{"name":"EnrichmentOptions","abstract":"

Options which are specific to a particular enrichment.

"},"Structs/Environment.html":{"name":"Environment","abstract":"

Details about an environment.

"},"Structs/EnvironmentDocuments.html":{"name":"EnvironmentDocuments","abstract":"

Summary of the document usage statistics for the environment.

"},"Structs/Expansion.html":{"name":"Expansion","abstract":"

An expansion definition. Each object respresents one set of expandable strings. For example, you could have expansions for the word hot in one object, and expansions for the word cold in another.

"},"Structs/Expansions.html":{"name":"Expansions","abstract":"

The query expansion definitions for the specified collection.

"},"Structs/Field.html":{"name":"Field","abstract":"

Field.

"},"Structs/Filter.html":{"name":"Filter","abstract":"

Filter.

"},"Structs/FontSetting.html":{"name":"FontSetting","abstract":"

FontSetting.

"},"Structs/GenericQueryAggregation.html":{"name":"GenericQueryAggregation","abstract":"

An aggregation produced by the Discovery service to analyze the input provided.

"},"Structs/Histogram.html":{"name":"Histogram","abstract":"

Histogram.

"},"Structs/HtmlSettings.html":{"name":"HtmlSettings","abstract":"

A list of HTML conversion settings.

"},"Structs/IndexCapacity.html":{"name":"IndexCapacity","abstract":"

Details about the resource usage and capacity of the environment.

"},"Structs/ListCollectionFieldsResponse.html":{"name":"ListCollectionFieldsResponse","abstract":"

The list of fetched fields. The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations. * Fields which contain nested JSON objects are assigned a type of nested. * Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity). * Fields returned from the News collection are prefixed with v{N}-fullnews-t3-{YEAR}.mappings (for example, v5-fullnews-t3-2016.mappings.text.properties.author).

"},"Structs/ListCollectionsResponse.html":{"name":"ListCollectionsResponse","abstract":"

ListCollectionsResponse.

"},"Structs/ListConfigurationsResponse.html":{"name":"ListConfigurationsResponse","abstract":"

ListConfigurationsResponse.

"},"Structs/ListEnvironmentsResponse.html":{"name":"ListEnvironmentsResponse","abstract":"

ListEnvironmentsResponse.

"},"Structs/MemoryUsage.html":{"name":"MemoryUsage","abstract":"

Deprecated**: Summary of the memory usage statistics for this environment.

"},"Structs/Nested.html":{"name":"Nested","abstract":"

Nested.

"},"Structs/NluEnrichmentCategories.html":{"name":"NluEnrichmentCategories","abstract":"

An object that indicates the Categories enrichment will be applied to the specified field.

"},"Structs/NluEnrichmentEmotion.html":{"name":"NluEnrichmentEmotion","abstract":"

An object specifying the emotion detection enrichment and related parameters.

"},"Structs/NluEnrichmentEntities.html":{"name":"NluEnrichmentEntities","abstract":"

An object speficying the Entities enrichment and related parameters.

"},"Structs/NluEnrichmentFeatures.html":{"name":"NluEnrichmentFeatures","abstract":"

NluEnrichmentFeatures.

"},"Structs/NluEnrichmentKeywords.html":{"name":"NluEnrichmentKeywords","abstract":"

An object specifying the Keyword enrichment and related parameters.

"},"Structs/NluEnrichmentRelations.html":{"name":"NluEnrichmentRelations","abstract":"

An object specifying the relations enrichment and related parameters.

"},"Structs/NluEnrichmentSemanticRoles.html":{"name":"NluEnrichmentSemanticRoles","abstract":"

An object specifiying the semantic roles enrichment and related parameters.

"},"Structs/NluEnrichmentSentiment.html":{"name":"NluEnrichmentSentiment","abstract":"

An object specifying the sentiment extraction enrichment and related parameters.

"},"Structs/NormalizationOperation.html":{"name":"NormalizationOperation","abstract":"

NormalizationOperation.

"},"Structs/Notice.html":{"name":"Notice","abstract":"

A notice produced for the collection.

"},"Structs/PdfHeadingDetection.html":{"name":"PdfHeadingDetection","abstract":"

PdfHeadingDetection.

"},"Structs/PdfSettings.html":{"name":"PdfSettings","abstract":"

A list of PDF conversion settings.

"},"Structs/QueryEntities.html":{"name":"QueryEntities","abstract":"

QueryEntities.

"},"Structs/QueryEntitiesContext.html":{"name":"QueryEntitiesContext","abstract":"

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

"},"Structs/QueryEntitiesEntity.html":{"name":"QueryEntitiesEntity","abstract":"

A text string that appears within the entity text field.

"},"Structs/QueryEntitiesResponse.html":{"name":"QueryEntitiesResponse","abstract":"

An array of entities resulting from the query.

"},"Structs/QueryEntitiesResponseItem.html":{"name":"QueryEntitiesResponseItem","abstract":"

Object containing Entity query response information.

"},"Structs/QueryEvidence.html":{"name":"QueryEvidence","abstract":"

Description of evidence location supporting Knoweldge Graph query result.

"},"Structs/QueryEvidenceEntity.html":{"name":"QueryEvidenceEntity","abstract":"

Entity description and location within evidence field.

"},"Structs/QueryFilterType.html":{"name":"QueryFilterType","abstract":"

QueryFilterType.

"},"Structs/QueryNoticesResponse.html":{"name":"QueryNoticesResponse","abstract":"

QueryNoticesResponse.

"},"Structs/QueryNoticesResult.html":{"name":"QueryNoticesResult","abstract":"

QueryNoticesResult.

"},"Structs/QueryPassages.html":{"name":"QueryPassages","abstract":"

QueryPassages.

"},"Structs/QueryRelations.html":{"name":"QueryRelations","abstract":"

A respresentation of a relationship query.

"},"Structs/QueryRelationsArgument.html":{"name":"QueryRelationsArgument","abstract":"

QueryRelationsArgument.

"},"Structs/QueryRelationsEntity.html":{"name":"QueryRelationsEntity","abstract":"

QueryRelationsEntity.

"},"Structs/QueryRelationsFilter.html":{"name":"QueryRelationsFilter","abstract":"

QueryRelationsFilter.

"},"Structs/QueryRelationsRelationship.html":{"name":"QueryRelationsRelationship","abstract":"

QueryRelationsRelationship.

"},"Structs/QueryRelationsResponse.html":{"name":"QueryRelationsResponse","abstract":"

QueryRelationsResponse.

"},"Structs/QueryResponse.html":{"name":"QueryResponse","abstract":"

A response containing the documents and aggregations for the query.

"},"Structs/QueryResult.html":{"name":"QueryResult","abstract":"

QueryResult.

"},"Structs/QueryResultMetadata.html":{"name":"QueryResultMetadata","abstract":"

Metadata of a query result.

"},"Structs/SegmentSettings.html":{"name":"SegmentSettings","abstract":"

A list of Document Segmentation settings.

"},"Structs/Term.html":{"name":"Term","abstract":"

Term.

"},"Structs/TestDocument.html":{"name":"TestDocument","abstract":"

TestDocument.

"},"Structs/Timeslice.html":{"name":"Timeslice","abstract":"

Timeslice.

"},"Structs/TopHits.html":{"name":"TopHits","abstract":"

TopHits.

"},"Structs/TopHitsResults.html":{"name":"TopHitsResults","abstract":"

TopHitsResults.

"},"Structs/TrainingDataSet.html":{"name":"TrainingDataSet","abstract":"

TrainingDataSet.

"},"Structs/TrainingExample.html":{"name":"TrainingExample","abstract":"

TrainingExample.

"},"Structs/TrainingExampleList.html":{"name":"TrainingExampleList","abstract":"

TrainingExampleList.

"},"Structs/TrainingQuery.html":{"name":"TrainingQuery","abstract":"

TrainingQuery.

"},"Structs/TrainingStatus.html":{"name":"TrainingStatus","abstract":"

TrainingStatus.

"},"Structs/WordHeadingDetection.html":{"name":"WordHeadingDetection","abstract":"

WordHeadingDetection.

"},"Structs/WordSettings.html":{"name":"WordSettings","abstract":"

A list of Word conversion settings.

"},"Structs/WordStyle.html":{"name":"WordStyle","abstract":"

WordStyle.

"},"Structs/XPathPatterns.html":{"name":"XPathPatterns","abstract":"

XPathPatterns.

"},"Structs.html#/s:11DiscoveryV111JSONWrapperV":{"name":"JSONWrapper","abstract":"

Used internally to serialize and deserialize JSON."},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO013serializationD0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO08encodingD0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO011fileManagerD0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:11DiscoveryV14JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO4termAcA4TermVcACmF":{"name":"term","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO6filterAcA6FilterVcACmF":{"name":"filter","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO6nestedAcA6NestedVcACmF":{"name":"nested","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO9histogramAcA9HistogramVcACmF":{"name":"histogram","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO9timesliceAcA9TimesliceVcACmF":{"name":"timeslice","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO7topHitsAcA03TopF0VcACmF":{"name":"topHits","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO11uniqueCountAcA11CalculationVcACmF":{"name":"uniqueCount","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO3maxAcA11CalculationVcACmF":{"name":"max","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO3minAcA11CalculationVcACmF":{"name":"min","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO7averageAcA11CalculationVcACmF":{"name":"average","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO3sumAcA11CalculationVcACmF":{"name":"sum","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO7genericAcA07GenericcD0VcACmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html":{"name":"QueryAggregation","abstract":"

An aggregation produced by the Discovery service to analyze the input provided.

"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/Discovery.html#/s:11DiscoveryV10A0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

Create a Discovery object.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a Discovery object.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a Discovery object.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C17createEnvironmentySS4name_SSSg11descriptionSiSg4sizes10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createEnvironment(name:description:size:headers:failure:success:)","abstract":"

Create an environment.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16listEnvironmentsySSSg4name_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA04ListD8ResponseVc7successtF":{"name":"listEnvironments(name:headers:failure:success:)","abstract":"

List environments.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14getEnvironmentySS13environmentID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getEnvironment(environmentID:headers:failure:success:)","abstract":"

Get environment info.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C17updateEnvironmentySS13environmentID_SSSg4nameAF11descriptions10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateEnvironment(environmentID:name:description:headers:failure:success:)","abstract":"

Update an environment.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C17deleteEnvironmentySS13environmentID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteD8ResponseVc7successtF":{"name":"deleteEnvironment(environmentID:headers:failure:success:)","abstract":"

Delete environment.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C10listFieldsySS13environmentID_SaySSG13collectionIdss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA014ListCollectionD8ResponseVc7successtF":{"name":"listFields(environmentID:collectionIds:headers:failure:success:)","abstract":"

List fields across collections.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C19createConfigurationySS13environmentID_AA0D0V13configurations10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAGc7successtF":{"name":"createConfiguration(environmentID:configuration:headers:failure:success:)","abstract":"

Add configuration.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C18listConfigurationsySS13environmentID_SSSg4names10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA04ListD8ResponseVc7successtF":{"name":"listConfigurations(environmentID:name:headers:failure:success:)","abstract":"

List configurations.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16getConfigurationySS13environmentID_SS013configurationF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getConfiguration(environmentID:configurationID:headers:failure:success:)","abstract":"

Get configuration details.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C19updateConfigurationySS13environmentID_SS013configurationF0AA0D0V0G0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAHc7successtF":{"name":"updateConfiguration(environmentID:configurationID:configuration:headers:failure:success:)","abstract":"

Update a configuration.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C19deleteConfigurationySS13environmentID_SS013configurationF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteD8ResponseVc7successtF":{"name":"deleteConfiguration(environmentID:configurationID:headers:failure:success:)","abstract":"

Delete a configuration.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C30testConfigurationInEnvironmentySS13environmentID_SSSg13configurationAF4stepAF0iH010Foundation3URLVSg4fileAF8metadataAF0M11ContentTypes10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA12TestDocumentVc7successtF":{"name":"testConfigurationInEnvironment(environmentID:configuration:step:configurationID:file:metadata:fileContentType:headers:failure:success:)","abstract":"

Test configuration.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16createCollectionySS13environmentID_AA06CreateD7RequestV10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createCollection(environmentID:properties:headers:failure:success:)","abstract":"

Create a collection.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C15listCollectionsySS13environmentID_SSSg4names10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA04ListD8ResponseVc7successtF":{"name":"listCollections(environmentID:name:headers:failure:success:)","abstract":"

List collections.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C13getCollectionySS13environmentID_SS010collectionF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getCollection(environmentID:collectionID:headers:failure:success:)","abstract":"

Get collection details.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16updateCollectionySS13environmentID_SS010collectionF0SS4nameSSSg11descriptionAH013configurationF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateCollection(environmentID:collectionID:name:description:configurationID:headers:failure:success:)","abstract":"

Update a collection.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16deleteCollectionySS13environmentID_SS010collectionF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteD8ResponseVc7successtF":{"name":"deleteCollection(environmentID:collectionID:headers:failure:success:)","abstract":"

Delete a collection.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C20listCollectionFieldsySS13environmentID_SS010collectionG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA04ListdE8ResponseVc7successtF":{"name":"listCollectionFields(environmentID:collectionID:headers:failure:success:)","abstract":"

List collection fields.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14listExpansionsySS13environmentID_SS010collectionF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"listExpansions(environmentID:collectionID:headers:failure:success:)","abstract":"

Get the expansion list.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16createExpansionsySS13environmentID_SS010collectionF0SayAA9ExpansionVG10expansionss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createExpansions(environmentID:collectionID:expansions:headers:failure:success:)","abstract":"

Create or update expansion list.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16deleteExpansionsySS13environmentID_SS010collectionF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteExpansions(environmentID:collectionID:headers:failure:success:)","abstract":"

Delete the expansion list.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C11addDocumentySS13environmentID_SS010collectionF010Foundation3URLVSg4fileSSSg8metadataAL0J11ContentTypes10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D8AcceptedVc7successtF":{"name":"addDocument(environmentID:collectionID:file:metadata:fileContentType:headers:failure:success:)","abstract":"

Add a document.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C17getDocumentStatusySS13environmentID_SS010collectionG0SS08documentG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"getDocumentStatus(environmentID:collectionID:documentID:headers:failure:success:)","abstract":"

Get document details.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14updateDocumentySS13environmentID_SS010collectionF0SS08documentF010Foundation3URLVSg4fileSSSg8metadataAM0K11ContentTypes10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D8AcceptedVc7successtF":{"name":"updateDocument(environmentID:collectionID:documentID:file:metadata:fileContentType:headers:failure:success:)","abstract":"

Update a document.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14deleteDocumentySS13environmentID_SS010collectionF0SS08documentF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteD8ResponseVc7successtF":{"name":"deleteDocument(environmentID:collectionID:documentID:headers:failure:success:)","abstract":"

Delete a document.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C5queryySS13environmentID_SS010collectionE0SSSg6filterAgdG20naturalLanguageQuerySbSg8passagesAG11aggregationSiSg5countSaySSGSg12returnFieldsAM6offsetAP4sortAJ9highlightAP0kO0AM0K5CountAM0K10CharactersAJ11deduplicateAG0U5FieldAJ7similarAP0W11DocumentIdsAP0wO0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0J8ResponseVc7successtF":{"name":"query(environmentID:collectionID:filter:query:naturalLanguageQuery:passages:aggregation:count:returnFields:offset:sort:highlight:passagesFields:passagesCount:passagesCharacters:deduplicate:deduplicateField:similar:similarDocumentIds:similarFields:headers:failure:success:)","abstract":"

Query your collection.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C12queryNoticesySS13environmentID_SS010collectionF0SSSg6filterAG0C0AG20naturalLanguageQuerySbSg8passagesAG11aggregationSiSg5countSaySSGSg12returnFieldsAN6offsetAQ4sortAK9highlightAQ0lP0AN0L5CountAN0L10CharactersAG16deduplicateFieldAK7similarAQ0X11DocumentIdsAQ0xP0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0kD8ResponseVc7successtF":{"name":"queryNotices(environmentID:collectionID:filter:query:naturalLanguageQuery:passages:aggregation:count:returnFields:offset:sort:highlight:passagesFields:passagesCount:passagesCharacters:deduplicateField:similar:similarDocumentIds:similarFields:headers:failure:success:)","abstract":"

Query system notices.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14federatedQueryySS13environmentID_SaySSG13collectionIdsSSSg6filterAH5queryAH015naturalLanguageD0AH11aggregationSiSg5countAFSg12returnFieldsAM6offsetAO4sortSbSg9highlightAS11deduplicateAH0T5FieldAS7similarAO0v8DocumentH0AO0vP0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D8ResponseVc7successtF":{"name":"federatedQuery(environmentID:collectionIds:filter:query:naturalLanguageQuery:aggregation:count:returnFields:offset:sort:highlight:deduplicate:deduplicateField:similar:similarDocumentIds:similarFields:headers:failure:success:)","abstract":"

Query documents in multiple collections.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C21federatedQueryNoticesySS13environmentID_SaySSG13collectionIdsSSSg6filterAH5queryAH015naturalLanguageD0AH11aggregationSiSg5countAFSg12returnFieldsAM6offsetAO4sortSbSg9highlightAH16deduplicateFieldAS7similarAO0w8DocumentI0AO0wQ0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE8ResponseVc7successtF":{"name":"federatedQueryNotices(environmentID:collectionIds:filter:query:naturalLanguageQuery:aggregation:count:returnFields:offset:sort:highlight:deduplicateField:similar:similarDocumentIds:similarFields:headers:failure:success:)","abstract":"

Query multiple collection system notices.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C13queryEntitiesySS13environmentID_SS010collectionF0AA05QueryD0V06entityH0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0hD8ResponseVc7successtF":{"name":"queryEntities(environmentID:collectionID:entityQuery:headers:failure:success:)","abstract":"

Knowledge Graph entity query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14queryRelationsySS13environmentID_SS010collectionF0AA05QueryD0V012relationshipH0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0hD8ResponseVc7successtF":{"name":"queryRelations(environmentID:collectionID:relationshipQuery:headers:failure:success:)","abstract":"

Knowledge Graph relationship query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16listTrainingDataySS13environmentID_SS010collectionG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE3SetVc7successtF":{"name":"listTrainingData(environmentID:collectionID:headers:failure:success:)","abstract":"

List training data.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C15addTrainingDataySS13environmentID_SS010collectionG0SSSg20naturalLanguageQueryAG6filterSayAA0D7ExampleVGSg8exampless10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dK0Vc7successtF":{"name":"addTrainingData(environmentID:collectionID:naturalLanguageQuery:filter:examples:headers:failure:success:)","abstract":"

Add query to training data.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C21deleteAllTrainingDataySS13environmentID_SS010collectionH0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteAllTrainingData(environmentID:collectionID:headers:failure:success:)","abstract":"

Delete all training data.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C15getTrainingDataySS13environmentID_SS010collectionG0SS05queryG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D5QueryVc7successtF":{"name":"getTrainingData(environmentID:collectionID:queryID:headers:failure:success:)","abstract":"

Get details about a query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C18deleteTrainingDataySS13environmentID_SS010collectionG0SS05queryG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteTrainingData(environmentID:collectionID:queryID:headers:failure:success:)","abstract":"

Delete a training data query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C20listTrainingExamplesySS13environmentID_SS010collectionG0SS05queryG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D11ExampleListVc7successtF":{"name":"listTrainingExamples(environmentID:collectionID:queryID:headers:failure:success:)","abstract":"

List examples for a training data query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C21createTrainingExampleySS13environmentID_SS010collectionG0SS05queryG0SSSg08documentG0AH14crossReferenceSiSg9relevances10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"createTrainingExample(environmentID:collectionID:queryID:documentID:crossReference:relevance:headers:failure:success:)","abstract":"

Add example to training data query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C21deleteTrainingExampleySS13environmentID_SS010collectionG0SS05queryG0SS07exampleG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteTrainingExample(environmentID:collectionID:queryID:exampleID:headers:failure:success:)","abstract":"

Delete example for training data query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C21updateTrainingExampleySS13environmentID_SS010collectionG0SS05queryG0SS07exampleG0SSSg14crossReferenceSiSg9relevances10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"updateTrainingExample(environmentID:collectionID:queryID:exampleID:crossReference:relevance:headers:failure:success:)","abstract":"

Change label or cross reference for example.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C18getTrainingExampleySS13environmentID_SS010collectionG0SS05queryG0SS07exampleG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"getTrainingExample(environmentID:collectionID:queryID:exampleID:headers:failure:success:)","abstract":"

Get details for training data example.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

Delete labeled data.

","parent_name":"Discovery"},"Classes/Discovery.html":{"name":"Discovery","abstract":"

The IBM Watson Discovery Service is a cognitive search and content analytics engine that you can add to applications to"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file +{"Structs/XPathPatterns.html#/s:11DiscoveryV113XPathPatternsV6xpathsSaySSGSgvp":{"name":"xpaths","abstract":"

Undocumented

","parent_name":"XPathPatterns"},"Structs/XPathPatterns.html#/s:11DiscoveryV113XPathPatternsVACSaySSGSg6xpaths_tcfc":{"name":"init(xpaths:)","abstract":"

Initialize a XPathPatterns with member variables.

","parent_name":"XPathPatterns"},"Structs/WordStyle.html#/s:11DiscoveryV19WordStyleV5levelSiSgvp":{"name":"level","abstract":"

Undocumented

","parent_name":"WordStyle"},"Structs/WordStyle.html#/s:11DiscoveryV19WordStyleV5namesSaySSGSgvp":{"name":"names","abstract":"

Undocumented

","parent_name":"WordStyle"},"Structs/WordStyle.html#/s:11DiscoveryV19WordStyleVACSiSg5level_SaySSGSg5namestcfc":{"name":"init(level:names:)","abstract":"

Initialize a WordStyle with member variables.

","parent_name":"WordStyle"},"Structs/WordSettings.html#/s:11DiscoveryV112WordSettingsV7headingAA0C16HeadingDetectionVSgvp":{"name":"heading","abstract":"

Undocumented

","parent_name":"WordSettings"},"Structs/WordSettings.html#/s:11DiscoveryV112WordSettingsVAcA0C16HeadingDetectionVSg7heading_tcfc":{"name":"init(heading:)","abstract":"

Initialize a WordSettings with member variables.

","parent_name":"WordSettings"},"Structs/WordHeadingDetection.html#/s:11DiscoveryV120WordHeadingDetectionV5fontsSayAA11FontSettingVGSgvp":{"name":"fonts","abstract":"

Undocumented

","parent_name":"WordHeadingDetection"},"Structs/WordHeadingDetection.html#/s:11DiscoveryV120WordHeadingDetectionV6stylesSayAA0C5StyleVGSgvp":{"name":"styles","abstract":"

Undocumented

","parent_name":"WordHeadingDetection"},"Structs/WordHeadingDetection.html#/s:11DiscoveryV120WordHeadingDetectionVACSayAA11FontSettingVGSg5fonts_SayAA0C5StyleVGSg6stylestcfc":{"name":"init(fonts:styles:)","abstract":"

Initialize a WordHeadingDetection with member variables.

","parent_name":"WordHeadingDetection"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV13totalExamplesSiSgvp":{"name":"totalExamples","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV9availableSbSgvp":{"name":"available","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV10processingSbSgvp":{"name":"processing","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV19minimumQueriesAddedSbSgvp":{"name":"minimumQueriesAdded","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV20minimumExamplesAddedSbSgvp":{"name":"minimumExamplesAdded","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV24sufficientLabelDiversitySbSgvp":{"name":"sufficientLabelDiversity","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV7noticesSiSgvp":{"name":"notices","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV19successfullyTrainedSSSgvp":{"name":"successfullyTrained","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingStatus.html#/s:11DiscoveryV114TrainingStatusV11dataUpdatedSSSgvp":{"name":"dataUpdated","abstract":"

Undocumented

","parent_name":"TrainingStatus"},"Structs/TrainingQuery.html#/s:11DiscoveryV113TrainingQueryV7queryIDSSSgvp":{"name":"queryID","abstract":"

Undocumented

","parent_name":"TrainingQuery"},"Structs/TrainingQuery.html#/s:11DiscoveryV113TrainingQueryV015naturalLanguageD0SSSgvp":{"name":"naturalLanguageQuery","abstract":"

Undocumented

","parent_name":"TrainingQuery"},"Structs/TrainingQuery.html#/s:11DiscoveryV113TrainingQueryV6filterSSSgvp":{"name":"filter","abstract":"

Undocumented

","parent_name":"TrainingQuery"},"Structs/TrainingQuery.html#/s:11DiscoveryV113TrainingQueryV8examplesSayAA0C7ExampleVGSgvp":{"name":"examples","abstract":"

Undocumented

","parent_name":"TrainingQuery"},"Structs/TrainingExampleList.html#/s:11DiscoveryV119TrainingExampleListV8examplesSayAA0cD0VGSgvp":{"name":"examples","abstract":"

Undocumented

","parent_name":"TrainingExampleList"},"Structs/TrainingExample.html#/s:11DiscoveryV115TrainingExampleV10documentIDSSSgvp":{"name":"documentID","abstract":"

Undocumented

","parent_name":"TrainingExample"},"Structs/TrainingExample.html#/s:11DiscoveryV115TrainingExampleV14crossReferenceSSSgvp":{"name":"crossReference","abstract":"

Undocumented

","parent_name":"TrainingExample"},"Structs/TrainingExample.html#/s:11DiscoveryV115TrainingExampleV9relevanceSiSgvp":{"name":"relevance","abstract":"

Undocumented

","parent_name":"TrainingExample"},"Structs/TrainingExample.html#/s:11DiscoveryV115TrainingExampleVACSSSg10documentID_AD14crossReferenceSiSg9relevancetcfc":{"name":"init(documentID:crossReference:relevance:)","abstract":"

Initialize a TrainingExample with member variables.

","parent_name":"TrainingExample"},"Structs/TrainingDataSet.html#/s:11DiscoveryV115TrainingDataSetV13environmentIDSSSgvp":{"name":"environmentID","abstract":"

Undocumented

","parent_name":"TrainingDataSet"},"Structs/TrainingDataSet.html#/s:11DiscoveryV115TrainingDataSetV12collectionIDSSSgvp":{"name":"collectionID","abstract":"

Undocumented

","parent_name":"TrainingDataSet"},"Structs/TrainingDataSet.html#/s:11DiscoveryV115TrainingDataSetV7queriesSayAA0C5QueryVGSgvp":{"name":"queries","abstract":"

Undocumented

","parent_name":"TrainingDataSet"},"Structs/TopHitsResults.html#/s:11DiscoveryV114TopHitsResultsV08matchingE0SiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"TopHitsResults"},"Structs/TopHitsResults.html#/s:11DiscoveryV114TopHitsResultsV4hitsSayAA11QueryResultVGSgvp":{"name":"hits","abstract":"

Top results returned by the aggregation.

","parent_name":"TopHitsResults"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"TopHits"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"TopHits"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"TopHits"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"TopHits"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV4sizeSiSgvp":{"name":"size","abstract":"

Number of top hits returned by the aggregation.

","parent_name":"TopHits"},"Structs/TopHits.html#/s:11DiscoveryV17TopHitsV4hitsAA0cD7ResultsVSgvp":{"name":"hits","abstract":"

Undocumented

","parent_name":"TopHits"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV5fieldSSSgvp":{"name":"field","abstract":"

The field where the aggregation is located in the document.

","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV8intervalSSSgvp":{"name":"interval","abstract":"

Interval of the aggregation. Valid date interval values are second/seconds minute/minutes, hour/hours, day/days,","parent_name":"Timeslice"},"Structs/Timeslice.html#/s:11DiscoveryV19TimesliceV7anomalySbSgvp":{"name":"anomaly","abstract":"

Used to inducate that anomaly detection should be performed. Anomaly detection is used to locate unusual datapoints","parent_name":"Timeslice"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV15configurationIDSSSgvp":{"name":"configurationID","abstract":"

The unique identifier for the configuration.

","parent_name":"TestDocument"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV6statusSSSgvp":{"name":"status","abstract":"

Status of the preview operation.

","parent_name":"TestDocument"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV18enrichedFieldUnitsSiSgvp":{"name":"enrichedFieldUnits","abstract":"

The number of 10-kB chunks of field data that were enriched. This can be used to estimate the cost of running a","parent_name":"TestDocument"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV17originalMediaTypeSSSgvp":{"name":"originalMediaType","abstract":"

Format of the test document.

","parent_name":"TestDocument"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV9snapshotsSayAA0D8SnapshotVGSgvp":{"name":"snapshots","abstract":"

An array of objects that describe each step in the preview process.

","parent_name":"TestDocument"},"Structs/TestDocument.html#/s:11DiscoveryV112TestDocumentV7noticesSayAA6NoticeVGSgvp":{"name":"notices","abstract":"

An array of notice messages about the preview operation.

","parent_name":"TestDocument"},"Structs/Term.html#/s:11DiscoveryV14TermV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Term"},"Structs/Term.html#/s:11DiscoveryV14TermV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Term"},"Structs/Term.html#/s:11DiscoveryV14TermV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Term"},"Structs/Term.html#/s:11DiscoveryV14TermV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Term"},"Structs/Term.html#/s:11DiscoveryV14TermV5fieldSSSgvp":{"name":"field","abstract":"

The field where the aggregation is located in the document.

","parent_name":"Term"},"Structs/Term.html#/s:11DiscoveryV14TermV5countSiSgvp":{"name":"count","abstract":"

Undocumented

","parent_name":"Term"},"Structs/SegmentSettings.html#/s:11DiscoveryV115SegmentSettingsV7enabledSbSgvp":{"name":"enabled","abstract":"

Enables/disables the Document Segmentation feature.

","parent_name":"SegmentSettings"},"Structs/SegmentSettings.html#/s:11DiscoveryV115SegmentSettingsV12selectorTagsSaySSGSgvp":{"name":"selectorTags","abstract":"

Defines the heading level that splits into document segments. Valid values are h1, h2, h3, h4, h5, h6.

","parent_name":"SegmentSettings"},"Structs/SegmentSettings.html#/s:11DiscoveryV115SegmentSettingsVACSbSg7enabled_SaySSGSg12selectorTagstcfc":{"name":"init(enabled:selectorTags:)","abstract":"

Initialize a SegmentSettings with member variables.

","parent_name":"SegmentSettings"},"Structs/QueryResultMetadata.html#/s:11DiscoveryV119QueryResultMetadataV5scoreSdSgvp":{"name":"score","abstract":"

The confidence score of the result’s analysis. A higher score indicating greater confidence.

","parent_name":"QueryResultMetadata"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV2idSSSgvp":{"name":"id","abstract":"

The unique identifier of the document.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV5scoreSdSgvp":{"name":"score","abstract":"

Deprecated* This field is now part of the result_metadata object.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Metadata of the document.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV12collectionIDSSSgvp":{"name":"collectionID","abstract":"

The collection ID of the collection containing the document for this result.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV14resultMetadataAA0cdF0VSgvp":{"name":"resultMetadata","abstract":"

Metadata of the query result.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:11DiscoveryV111QueryResultV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"QueryResult"},"Structs/QueryResult.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"QueryResult"},"Structs/QueryResponse.html#/s:11DiscoveryV113QueryResponseV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Undocumented

","parent_name":"QueryResponse"},"Structs/QueryResponse.html#/s:11DiscoveryV113QueryResponseV7resultsSayAA0C6ResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"QueryResponse"},"Structs/QueryResponse.html#/s:11DiscoveryV113QueryResponseV12aggregationsSayAA0C11AggregationOGSgvp":{"name":"aggregations","abstract":"

Undocumented

","parent_name":"QueryResponse"},"Structs/QueryResponse.html#/s:11DiscoveryV113QueryResponseV8passagesSayAA0C8PassagesVGSgvp":{"name":"passages","abstract":"

Undocumented

","parent_name":"QueryResponse"},"Structs/QueryResponse.html#/s:11DiscoveryV113QueryResponseV17duplicatesRemovedSiSgvp":{"name":"duplicatesRemoved","abstract":"

Undocumented

","parent_name":"QueryResponse"},"Structs/QueryRelationsResponse.html#/s:11DiscoveryV122QueryRelationsResponseV9relationsSayAA0cD12RelationshipVGSgvp":{"name":"relations","abstract":"

Undocumented

","parent_name":"QueryRelationsResponse"},"Structs/QueryRelationsRelationship.html#/s:11DiscoveryV126QueryRelationsRelationshipV4typeSSSgvp":{"name":"type","abstract":"

The identified relationship type.

","parent_name":"QueryRelationsRelationship"},"Structs/QueryRelationsRelationship.html#/s:11DiscoveryV126QueryRelationsRelationshipV9frequencySiSgvp":{"name":"frequency","abstract":"

The number of times the relationship is mentioned.

","parent_name":"QueryRelationsRelationship"},"Structs/QueryRelationsRelationship.html#/s:11DiscoveryV126QueryRelationsRelationshipV9argumentsSayAA0cD8ArgumentVGSgvp":{"name":"arguments","abstract":"

Information about the relationship.

","parent_name":"QueryRelationsRelationship"},"Structs/QueryRelationsRelationship.html#/s:11DiscoveryV126QueryRelationsRelationshipV8evidenceSayAA0C8EvidenceVGSgvp":{"name":"evidence","abstract":"

List of different evidentiary items to support the result.

","parent_name":"QueryRelationsRelationship"},"Structs/QueryRelationsFilter.html#/s:11DiscoveryV120QueryRelationsFilterV13relationTypesAA0cE4TypeVSgvp":{"name":"relationTypes","abstract":"

A list of relation types to include or exclude from the query.

","parent_name":"QueryRelationsFilter"},"Structs/QueryRelationsFilter.html#/s:11DiscoveryV120QueryRelationsFilterV11entityTypesAA0cE4TypeVSgvp":{"name":"entityTypes","abstract":"

A list of entity types to include or exclude from the query.

","parent_name":"QueryRelationsFilter"},"Structs/QueryRelationsFilter.html#/s:11DiscoveryV120QueryRelationsFilterV11documentIdsSaySSGSgvp":{"name":"documentIds","abstract":"

A comma-separated list of document IDs to include in the query.

","parent_name":"QueryRelationsFilter"},"Structs/QueryRelationsFilter.html#/s:11DiscoveryV120QueryRelationsFilterVAcA0cE4TypeVSg13relationTypes_AF06entityH0SaySSGSg11documentIdstcfc":{"name":"init(relationTypes:entityTypes:documentIds:)","abstract":"

Initialize a QueryRelationsFilter with member variables.

","parent_name":"QueryRelationsFilter"},"Structs/QueryRelationsEntity.html#/s:11DiscoveryV120QueryRelationsEntityV4textSSSgvp":{"name":"text","abstract":"

Entity text content.

","parent_name":"QueryRelationsEntity"},"Structs/QueryRelationsEntity.html#/s:11DiscoveryV120QueryRelationsEntityV4typeSSSgvp":{"name":"type","abstract":"

The type of the specified entity.

","parent_name":"QueryRelationsEntity"},"Structs/QueryRelationsEntity.html#/s:11DiscoveryV120QueryRelationsEntityV5exactSbSgvp":{"name":"exact","abstract":"

If false, implicit querying is performed. The default is false.

","parent_name":"QueryRelationsEntity"},"Structs/QueryRelationsEntity.html#/s:11DiscoveryV120QueryRelationsEntityVACSSSg4text_AD4typeSbSg5exacttcfc":{"name":"init(text:type:exact:)","abstract":"

Initialize a QueryRelationsEntity with member variables.

","parent_name":"QueryRelationsEntity"},"Structs/QueryRelationsArgument.html#/s:11DiscoveryV122QueryRelationsArgumentV8entitiesSayAA0C14EntitiesEntityVGSgvp":{"name":"entities","abstract":"

Undocumented

","parent_name":"QueryRelationsArgument"},"Structs/QueryRelations/Sort.html#/s:11DiscoveryV114QueryRelationsV4SortO5scoreA2EmF":{"name":"score","abstract":"

Undocumented

","parent_name":"Sort"},"Structs/QueryRelations/Sort.html#/s:11DiscoveryV114QueryRelationsV4SortO9frequencyA2EmF":{"name":"frequency","abstract":"

Undocumented

","parent_name":"Sort"},"Structs/QueryRelations/Sort.html":{"name":"Sort","abstract":"

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV8entitiesSayAA0cD6EntityVGSgvp":{"name":"entities","abstract":"

An array of entities to find relationships for.

","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV7contextAA0C15EntitiesContextVSgvp":{"name":"context","abstract":"

Entity text to provide context for the queried entity and rank based on that association. For example, if you","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV4sortSSSgvp":{"name":"sort","abstract":"

The sorting method for the relationships, can be score or frequency. frequency is the number of unique times","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV6filterAA0cD6FilterVSgvp":{"name":"filter","abstract":"

Filters to apply to the relationship query.

","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV5countSiSgvp":{"name":"count","abstract":"

The number of results to return. The default is 10. The maximum is 1000.

","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsV13evidenceCountSiSgvp":{"name":"evidenceCount","abstract":"

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items","parent_name":"QueryRelations"},"Structs/QueryRelations.html#/s:11DiscoveryV114QueryRelationsVACSayAA0cD6EntityVGSg8entities_AA0C15EntitiesContextVSg7contextSSSg4sortAA0cD6FilterVSg6filterSiSg5countAS13evidenceCounttcfc":{"name":"init(entities:context:sort:filter:count:evidenceCount:)","abstract":"

Initialize a QueryRelations with member variables.

","parent_name":"QueryRelations"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV10documentIDSSSgvp":{"name":"documentID","abstract":"

The unique identifier of the document from which the passage has been extracted.

","parent_name":"QueryPassages"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV12passageScoreSdSgvp":{"name":"passageScore","abstract":"

The confidence score of the passages’s analysis. A higher score indicates greater confidence.

","parent_name":"QueryPassages"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV11passageTextSSSgvp":{"name":"passageText","abstract":"

The content of the extracted passage.

","parent_name":"QueryPassages"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV11startOffsetSiSgvp":{"name":"startOffset","abstract":"

The position of the first character of the extracted passage in the originating field.

","parent_name":"QueryPassages"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV9endOffsetSiSgvp":{"name":"endOffset","abstract":"

The position of the last character of the extracted passage in the originating field.

","parent_name":"QueryPassages"},"Structs/QueryPassages.html#/s:11DiscoveryV113QueryPassagesV5fieldSSSgvp":{"name":"field","abstract":"

The label of the field from which the passage has been extracted.

","parent_name":"QueryPassages"},"Structs/QueryNoticesResult/FileType.html#/s:11DiscoveryV118QueryNoticesResultV8FileTypeO3pdfA2EmF":{"name":"pdf","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/QueryNoticesResult/FileType.html#/s:11DiscoveryV118QueryNoticesResultV8FileTypeO4htmlA2EmF":{"name":"html","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/QueryNoticesResult/FileType.html#/s:11DiscoveryV118QueryNoticesResultV8FileTypeO4wordA2EmF":{"name":"word","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/QueryNoticesResult/FileType.html#/s:11DiscoveryV118QueryNoticesResultV8FileTypeO4jsonA2EmF":{"name":"json","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/QueryNoticesResult/FileType.html":{"name":"FileType","abstract":"

The type of the original source file.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV2idSSSgvp":{"name":"id","abstract":"

The unique identifier of the document.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV5scoreSdSgvp":{"name":"score","abstract":"

Deprecated* This field is now part of the result_metadata object.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV8metadatas10DictionaryVySSAA4JSONOGSgvp":{"name":"metadata","abstract":"

Metadata of the document.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV12collectionIDSSSgvp":{"name":"collectionID","abstract":"

The collection ID of the collection containing the document for this result.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV14resultMetadataAA0ceG0VSgvp":{"name":"resultMetadata","abstract":"

Metadata of the query result.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV4codeSiSgvp":{"name":"code","abstract":"

The internal status code returned by the ingestion subsystem indicating the overall result of ingesting the source","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV8filenameSSSgvp":{"name":"filename","abstract":"

Name of the original source file (if available).

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV8fileTypeSSSgvp":{"name":"fileType","abstract":"

The type of the original source file.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV4sha1SSSgvp":{"name":"sha1","abstract":"

The SHA-1 hash of the original source file (formatted as a hexadecimal string).

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV7noticesSayAA6NoticeVGSgvp":{"name":"notices","abstract":"

Array of notices for the document.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:11DiscoveryV118QueryNoticesResultV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResult.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"QueryNoticesResult"},"Structs/QueryNoticesResponse.html#/s:11DiscoveryV120QueryNoticesResponseV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Undocumented

","parent_name":"QueryNoticesResponse"},"Structs/QueryNoticesResponse.html#/s:11DiscoveryV120QueryNoticesResponseV7resultsSayAA0cD6ResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"QueryNoticesResponse"},"Structs/QueryNoticesResponse.html#/s:11DiscoveryV120QueryNoticesResponseV12aggregationsSayAA0C11AggregationOGSgvp":{"name":"aggregations","abstract":"

Undocumented

","parent_name":"QueryNoticesResponse"},"Structs/QueryNoticesResponse.html#/s:11DiscoveryV120QueryNoticesResponseV8passagesSayAA0C8PassagesVGSgvp":{"name":"passages","abstract":"

Undocumented

","parent_name":"QueryNoticesResponse"},"Structs/QueryNoticesResponse.html#/s:11DiscoveryV120QueryNoticesResponseV17duplicatesRemovedSiSgvp":{"name":"duplicatesRemoved","abstract":"

Undocumented

","parent_name":"QueryNoticesResponse"},"Structs/QueryFilterType.html#/s:11DiscoveryV115QueryFilterTypeV7excludeSaySSGSgvp":{"name":"exclude","abstract":"

A comma-separated list of types to exclude.

","parent_name":"QueryFilterType"},"Structs/QueryFilterType.html#/s:11DiscoveryV115QueryFilterTypeV7includeSaySSGSgvp":{"name":"include","abstract":"

A comma-separated list of types to include. All other types are excluded.

","parent_name":"QueryFilterType"},"Structs/QueryFilterType.html#/s:11DiscoveryV115QueryFilterTypeVACSaySSGSg7exclude_AE7includetcfc":{"name":"init(exclude:include:)","abstract":"

Initialize a QueryFilterType with member variables.

","parent_name":"QueryFilterType"},"Structs/QueryEvidenceEntity.html#/s:11DiscoveryV119QueryEvidenceEntityV4typeSSSgvp":{"name":"type","abstract":"

The entity type for this entity. Possible types vary based on model used.

","parent_name":"QueryEvidenceEntity"},"Structs/QueryEvidenceEntity.html#/s:11DiscoveryV119QueryEvidenceEntityV4textSSSgvp":{"name":"text","abstract":"

The original text of this entity as found in the evidence field.

","parent_name":"QueryEvidenceEntity"},"Structs/QueryEvidenceEntity.html#/s:11DiscoveryV119QueryEvidenceEntityV11startOffsetSiSgvp":{"name":"startOffset","abstract":"

The start location of the entity text in the identified field. This value is inclusive.

","parent_name":"QueryEvidenceEntity"},"Structs/QueryEvidenceEntity.html#/s:11DiscoveryV119QueryEvidenceEntityV9endOffsetSiSgvp":{"name":"endOffset","abstract":"

The end location of the entity text in the identified field. This value is exclusive.

","parent_name":"QueryEvidenceEntity"},"Structs/QueryEvidence.html#/s:11DiscoveryV113QueryEvidenceV10documentIDSSSgvp":{"name":"documentID","abstract":"

The docuemnt ID (as indexed in Discovery) of the evidence location.

","parent_name":"QueryEvidence"},"Structs/QueryEvidence.html#/s:11DiscoveryV113QueryEvidenceV5fieldSSSgvp":{"name":"field","abstract":"

The field of the document where the supporting evidence was identified.

","parent_name":"QueryEvidence"},"Structs/QueryEvidence.html#/s:11DiscoveryV113QueryEvidenceV11startOffsetSiSgvp":{"name":"startOffset","abstract":"

The start location of the evidence in the identified field. This value is inclusive.

","parent_name":"QueryEvidence"},"Structs/QueryEvidence.html#/s:11DiscoveryV113QueryEvidenceV9endOffsetSiSgvp":{"name":"endOffset","abstract":"

The end location of the evidence in the identified field. This value is inclusive.

","parent_name":"QueryEvidence"},"Structs/QueryEvidence.html#/s:11DiscoveryV113QueryEvidenceV8entitiesSayAA0cD6EntityVGSgvp":{"name":"entities","abstract":"

An array of entity objects that show evidence of the result.

","parent_name":"QueryEvidence"},"Structs/QueryEntitiesResponseItem.html#/s:11DiscoveryV125QueryEntitiesResponseItemV4textSSSgvp":{"name":"text","abstract":"

Entity text content.

","parent_name":"QueryEntitiesResponseItem"},"Structs/QueryEntitiesResponseItem.html#/s:11DiscoveryV125QueryEntitiesResponseItemV4typeSSSgvp":{"name":"type","abstract":"

The type of the result entity.

","parent_name":"QueryEntitiesResponseItem"},"Structs/QueryEntitiesResponseItem.html#/s:11DiscoveryV125QueryEntitiesResponseItemV8evidenceSayAA0C8EvidenceVGSgvp":{"name":"evidence","abstract":"

List of different evidentiary items to support the result.

","parent_name":"QueryEntitiesResponseItem"},"Structs/QueryEntitiesResponse.html#/s:11DiscoveryV121QueryEntitiesResponseV8entitiesSayAA0cdE4ItemVGSgvp":{"name":"entities","abstract":"

Undocumented

","parent_name":"QueryEntitiesResponse"},"Structs/QueryEntitiesEntity.html#/s:11DiscoveryV119QueryEntitiesEntityV4textSSSgvp":{"name":"text","abstract":"

Entity text content.

","parent_name":"QueryEntitiesEntity"},"Structs/QueryEntitiesEntity.html#/s:11DiscoveryV119QueryEntitiesEntityV4typeSSSgvp":{"name":"type","abstract":"

The type of the specified entity.

","parent_name":"QueryEntitiesEntity"},"Structs/QueryEntitiesEntity.html#/s:11DiscoveryV119QueryEntitiesEntityVACSSSg4text_AD4typetcfc":{"name":"init(text:type:)","abstract":"

Initialize a QueryEntitiesEntity with member variables.

","parent_name":"QueryEntitiesEntity"},"Structs/QueryEntitiesContext.html#/s:11DiscoveryV120QueryEntitiesContextV4textSSSgvp":{"name":"text","abstract":"

Entity text to provide context for the queried entity and rank based on that association. For example, if you","parent_name":"QueryEntitiesContext"},"Structs/QueryEntitiesContext.html#/s:11DiscoveryV120QueryEntitiesContextVACSSSg4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a QueryEntitiesContext with member variables.

","parent_name":"QueryEntitiesContext"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesV7featureSSSgvp":{"name":"feature","abstract":"

The entity query feature to perform. Supported features are disambiguate and similar_entities.

","parent_name":"QueryEntities"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesV6entityAA0cD6EntityVSgvp":{"name":"entity","abstract":"

A text string that appears within the entity text field.

","parent_name":"QueryEntities"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesV7contextAA0cD7ContextVSgvp":{"name":"context","abstract":"

Entity text to provide context for the queried entity and rank based on that association. For example, if you","parent_name":"QueryEntities"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesV5countSiSgvp":{"name":"count","abstract":"

The number of results to return. The default is 10. The maximum is 1000.

","parent_name":"QueryEntities"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesV13evidenceCountSiSgvp":{"name":"evidenceCount","abstract":"

The number of evidence items to return for each result. The default is 0. The maximum number of evidence items","parent_name":"QueryEntities"},"Structs/QueryEntities.html#/s:11DiscoveryV113QueryEntitiesVACSSSg7feature_AA0cD6EntityVSg6entityAA0cD7ContextVSg7contextSiSg5countAN13evidenceCounttcfc":{"name":"init(feature:entity:context:count:evidenceCount:)","abstract":"

Initialize a QueryEntities with member variables.

","parent_name":"QueryEntities"},"Structs/PdfSettings.html#/s:11DiscoveryV111PdfSettingsV7headingAA0C16HeadingDetectionVSgvp":{"name":"heading","abstract":"

Undocumented

","parent_name":"PdfSettings"},"Structs/PdfSettings.html#/s:11DiscoveryV111PdfSettingsVAcA0C16HeadingDetectionVSg7heading_tcfc":{"name":"init(heading:)","abstract":"

Initialize a PdfSettings with member variables.

","parent_name":"PdfSettings"},"Structs/PdfHeadingDetection.html#/s:11DiscoveryV119PdfHeadingDetectionV5fontsSayAA11FontSettingVGSgvp":{"name":"fonts","abstract":"

Undocumented

","parent_name":"PdfHeadingDetection"},"Structs/PdfHeadingDetection.html#/s:11DiscoveryV119PdfHeadingDetectionVACSayAA11FontSettingVGSg5fonts_tcfc":{"name":"init(fonts:)","abstract":"

Initialize a PdfHeadingDetection with member variables.

","parent_name":"PdfHeadingDetection"},"Structs/Notice/Severity.html#/s:11DiscoveryV16NoticeV8SeverityO7warningA2EmF":{"name":"warning","abstract":"

Undocumented

","parent_name":"Severity"},"Structs/Notice/Severity.html#/s:11DiscoveryV16NoticeV8SeverityO5errorA2EmF":{"name":"error","abstract":"

Undocumented

","parent_name":"Severity"},"Structs/Notice/Severity.html":{"name":"Severity","abstract":"

Severity level of the notice.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV8noticeIDSSSgvp":{"name":"noticeID","abstract":"

Identifies the notice. Many notices might have the same ID. This field exists so that user applications can","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV7createdSSSgvp":{"name":"created","abstract":"

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

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV10documentIDSSSgvp":{"name":"documentID","abstract":"

Unique identifier of the document.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV7queryIDSSSgvp":{"name":"queryID","abstract":"

Unique identifier of the query used for relevance training.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV8severitySSSgvp":{"name":"severity","abstract":"

Severity level of the notice.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV4stepSSSgvp":{"name":"step","abstract":"

Ingestion or training step in which the notice occurred.

","parent_name":"Notice"},"Structs/Notice.html#/s:11DiscoveryV16NoticeV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the notice.

","parent_name":"Notice"},"Structs/NormalizationOperation/Operation.html#/s:11DiscoveryV122NormalizationOperationV0D0O4copyA2EmF":{"name":"copy","abstract":"

Undocumented

","parent_name":"Operation"},"Structs/NormalizationOperation/Operation.html#/s:11DiscoveryV122NormalizationOperationV0D0O4moveA2EmF":{"name":"move","abstract":"

Undocumented

","parent_name":"Operation"},"Structs/NormalizationOperation/Operation.html#/s:11DiscoveryV122NormalizationOperationV0D0O5mergeA2EmF":{"name":"merge","abstract":"

Undocumented

","parent_name":"Operation"},"Structs/NormalizationOperation/Operation.html#/s:11DiscoveryV122NormalizationOperationV0D0O6removeA2EmF":{"name":"remove","abstract":"

Undocumented

","parent_name":"Operation"},"Structs/NormalizationOperation/Operation.html#/s:11DiscoveryV122NormalizationOperationV0D0O11removeNullsA2EmF":{"name":"removeNulls","abstract":"

Undocumented

","parent_name":"Operation"},"Structs/NormalizationOperation/Operation.html":{"name":"Operation","abstract":"

Identifies what type of operation to perform.","parent_name":"NormalizationOperation"},"Structs/NormalizationOperation.html#/s:11DiscoveryV122NormalizationOperationV9operationSSSgvp":{"name":"operation","abstract":"

Identifies what type of operation to perform.","parent_name":"NormalizationOperation"},"Structs/NormalizationOperation.html#/s:11DiscoveryV122NormalizationOperationV11sourceFieldSSSgvp":{"name":"sourceField","abstract":"

The source field for the operation.

","parent_name":"NormalizationOperation"},"Structs/NormalizationOperation.html#/s:11DiscoveryV122NormalizationOperationV16destinationFieldSSSgvp":{"name":"destinationField","abstract":"

The destination field for the operation.

","parent_name":"NormalizationOperation"},"Structs/NormalizationOperation.html#/s:11DiscoveryV122NormalizationOperationVACSSSg9operation_AD11sourceFieldAD011destinationG0tcfc":{"name":"init(operation:sourceField:destinationField:)","abstract":"

Initialize a NormalizationOperation with member variables.

","parent_name":"NormalizationOperation"},"Structs/NluEnrichmentSentiment.html#/s:11DiscoveryV122NluEnrichmentSentimentV8documentSbSgvp":{"name":"document","abstract":"

When true, sentiment analysis is performed on the entire field.

","parent_name":"NluEnrichmentSentiment"},"Structs/NluEnrichmentSentiment.html#/s:11DiscoveryV122NluEnrichmentSentimentV7targetsSaySSGSgvp":{"name":"targets","abstract":"

A comma-separated list of target strings that will have any associated sentiment analyzed.

","parent_name":"NluEnrichmentSentiment"},"Structs/NluEnrichmentSentiment.html#/s:11DiscoveryV122NluEnrichmentSentimentVACSbSg8document_SaySSGSg7targetstcfc":{"name":"init(document:targets:)","abstract":"

Initialize a NluEnrichmentSentiment with member variables.

","parent_name":"NluEnrichmentSentiment"},"Structs/NluEnrichmentSemanticRoles.html#/s:11DiscoveryV126NluEnrichmentSemanticRolesV8entitiesSbSgvp":{"name":"entities","abstract":"

When true entities are extracted from the identified sentence parts.

","parent_name":"NluEnrichmentSemanticRoles"},"Structs/NluEnrichmentSemanticRoles.html#/s:11DiscoveryV126NluEnrichmentSemanticRolesV8keywordsSbSgvp":{"name":"keywords","abstract":"

When true, keywords are extracted from the identified sentence parts.

","parent_name":"NluEnrichmentSemanticRoles"},"Structs/NluEnrichmentSemanticRoles.html#/s:11DiscoveryV126NluEnrichmentSemanticRolesV5limitSiSgvp":{"name":"limit","abstract":"

The maximum number of semantic roles enrichments to extact from each instance of the specified field.

","parent_name":"NluEnrichmentSemanticRoles"},"Structs/NluEnrichmentSemanticRoles.html#/s:11DiscoveryV126NluEnrichmentSemanticRolesVACSbSg8entities_AD8keywordsSiSg5limittcfc":{"name":"init(entities:keywords:limit:)","abstract":"

Initialize a NluEnrichmentSemanticRoles with member variables.

","parent_name":"NluEnrichmentSemanticRoles"},"Structs/NluEnrichmentRelations.html#/s:11DiscoveryV122NluEnrichmentRelationsV5modelSSSgvp":{"name":"model","abstract":"

For use with natural_language_understanding enrichments only. The enrichement model to use with relationship","parent_name":"NluEnrichmentRelations"},"Structs/NluEnrichmentRelations.html#/s:11DiscoveryV122NluEnrichmentRelationsVACSSSg5model_tcfc":{"name":"init(model:)","abstract":"

Initialize a NluEnrichmentRelations with member variables.

","parent_name":"NluEnrichmentRelations"},"Structs/NluEnrichmentKeywords.html#/s:11DiscoveryV121NluEnrichmentKeywordsV9sentimentSbSgvp":{"name":"sentiment","abstract":"

When true, sentiment analysis of keywords will be performed on the specified field.

","parent_name":"NluEnrichmentKeywords"},"Structs/NluEnrichmentKeywords.html#/s:11DiscoveryV121NluEnrichmentKeywordsV7emotionSbSgvp":{"name":"emotion","abstract":"

When true, emotion detection of keywords will be performed on the specified field.

","parent_name":"NluEnrichmentKeywords"},"Structs/NluEnrichmentKeywords.html#/s:11DiscoveryV121NluEnrichmentKeywordsV5limitSiSgvp":{"name":"limit","abstract":"

The maximum number of keywords to extract for each instance of the specified field.

","parent_name":"NluEnrichmentKeywords"},"Structs/NluEnrichmentKeywords.html#/s:11DiscoveryV121NluEnrichmentKeywordsVACSbSg9sentiment_AD7emotionSiSg5limittcfc":{"name":"init(sentiment:emotion:limit:)","abstract":"

Initialize a NluEnrichmentKeywords with member variables.

","parent_name":"NluEnrichmentKeywords"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV8keywordsAA0cD8KeywordsVSgvp":{"name":"keywords","abstract":"

An object specifying the Keyword enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV8entitiesAA0cD8EntitiesVSgvp":{"name":"entities","abstract":"

An object speficying the Entities enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV9sentimentAA0cD9SentimentVSgvp":{"name":"sentiment","abstract":"

An object specifying the sentiment extraction enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV7emotionAA0cD7EmotionVSgvp":{"name":"emotion","abstract":"

An object specifying the emotion detection enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV10categoriesAA0cD10CategoriesVSgvp":{"name":"categories","abstract":"

An object specifying the categories enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV13semanticRolesAA0cd8SemanticG0VSgvp":{"name":"semanticRoles","abstract":"

An object specifiying the semantic roles enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesV9relationsAA0cD9RelationsVSgvp":{"name":"relations","abstract":"

An object specifying the relations enrichment and related parameters.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentFeatures.html#/s:11DiscoveryV121NluEnrichmentFeaturesVAcA0cD8KeywordsVSg8keywords_AA0cD8EntitiesVSg8entitiesAA0cD9SentimentVSg9sentimentAA0cD7EmotionVSg7emotionAA0cD10CategoriesVSg10categoriesAA0cD13SemanticRolesVSg08semanticQ0AA0cD9RelationsVSg9relationstcfc":{"name":"init(keywords:entities:sentiment:emotion:categories:semanticRoles:relations:)","abstract":"

Initialize a NluEnrichmentFeatures with member variables.

","parent_name":"NluEnrichmentFeatures"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV9sentimentSbSgvp":{"name":"sentiment","abstract":"

When true, sentiment analysis of entities will be performed on the specified field.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV7emotionSbSgvp":{"name":"emotion","abstract":"

When true, emotion detection of entities will be performed on the specified field.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV5limitSiSgvp":{"name":"limit","abstract":"

The maximum number of entities to extract for each instance of the specified field.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV8mentionsSbSgvp":{"name":"mentions","abstract":"

When true, the number of mentions of each identified entity is recorded. The default is false.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV12mentionTypesSbSgvp":{"name":"mentionTypes","abstract":"

When true, the types of mentions for each idetifieid entity is recorded. The default is false.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV16sentenceLocationSbSgvp":{"name":"sentenceLocation","abstract":"

When true, a list of sentence locations for each instance of each identified entity is recorded. The default is","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesV5modelSSSgvp":{"name":"model","abstract":"

The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge Studio, the","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEntities.html#/s:11DiscoveryV121NluEnrichmentEntitiesVACSbSg9sentiment_AD7emotionSiSg5limitAD8mentionsAD12mentionTypesAD16sentenceLocationSSSg5modeltcfc":{"name":"init(sentiment:emotion:limit:mentions:mentionTypes:sentenceLocation:model:)","abstract":"

Initialize a NluEnrichmentEntities with member variables.

","parent_name":"NluEnrichmentEntities"},"Structs/NluEnrichmentEmotion.html#/s:11DiscoveryV120NluEnrichmentEmotionV8documentSbSgvp":{"name":"document","abstract":"

When true, emotion detection is performed on the entire field.

","parent_name":"NluEnrichmentEmotion"},"Structs/NluEnrichmentEmotion.html#/s:11DiscoveryV120NluEnrichmentEmotionV7targetsSaySSGSgvp":{"name":"targets","abstract":"

A comma-separated list of target strings that will have any associated emotions detected.

","parent_name":"NluEnrichmentEmotion"},"Structs/NluEnrichmentEmotion.html#/s:11DiscoveryV120NluEnrichmentEmotionVACSbSg8document_SaySSGSg7targetstcfc":{"name":"init(document:targets:)","abstract":"

Initialize a NluEnrichmentEmotion with member variables.

","parent_name":"NluEnrichmentEmotion"},"Structs/NluEnrichmentCategories.html#/s:11DiscoveryV123NluEnrichmentCategoriesV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"NluEnrichmentCategories"},"Structs/NluEnrichmentCategories.html#/s:11DiscoveryV123NluEnrichmentCategoriesVACs10DictionaryVySSAA4JSONOG20additionalProperties_tcfc":{"name":"init(additionalProperties:)","abstract":"

Initialize a NluEnrichmentCategories.

","parent_name":"NluEnrichmentCategories"},"Structs/NluEnrichmentCategories.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"NluEnrichmentCategories"},"Structs/NluEnrichmentCategories.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"NluEnrichmentCategories"},"Structs/Nested.html#/s:11DiscoveryV16NestedV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Nested"},"Structs/Nested.html#/s:11DiscoveryV16NestedV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Nested"},"Structs/Nested.html#/s:11DiscoveryV16NestedV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Nested"},"Structs/Nested.html#/s:11DiscoveryV16NestedV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Nested"},"Structs/Nested.html#/s:11DiscoveryV16NestedV4pathSSSgvp":{"name":"path","abstract":"

The area of the results the aggregation was restricted to.

","parent_name":"Nested"},"Structs/MemoryUsage.html#/s:11DiscoveryV111MemoryUsageV9usedBytesSiSgvp":{"name":"usedBytes","abstract":"

Deprecated**: Number of bytes used in the environment’s memory capacity.

","parent_name":"MemoryUsage"},"Structs/MemoryUsage.html#/s:11DiscoveryV111MemoryUsageV10totalBytesSiSgvp":{"name":"totalBytes","abstract":"

Deprecated**: Total number of bytes available in the environment’s memory capacity.

","parent_name":"MemoryUsage"},"Structs/MemoryUsage.html#/s:11DiscoveryV111MemoryUsageV4usedSSSgvp":{"name":"used","abstract":"

Deprecated**: Amount of memory capacity used, in KB or GB format.

","parent_name":"MemoryUsage"},"Structs/MemoryUsage.html#/s:11DiscoveryV111MemoryUsageV5totalSSSgvp":{"name":"total","abstract":"

Deprecated**: Total amount of the environment’s memory capacity, in KB or GB format.

","parent_name":"MemoryUsage"},"Structs/MemoryUsage.html#/s:11DiscoveryV111MemoryUsageV11percentUsedSdSgvp":{"name":"percentUsed","abstract":"

Deprecated**: Percentage of the environment’s memory capacity that is being used.

","parent_name":"MemoryUsage"},"Structs/ListEnvironmentsResponse.html#/s:11DiscoveryV124ListEnvironmentsResponseV12environmentsSayAA11EnvironmentVGSgvp":{"name":"environments","abstract":"

An array of [environments] that are available for the service instance.

","parent_name":"ListEnvironmentsResponse"},"Structs/ListConfigurationsResponse.html#/s:11DiscoveryV126ListConfigurationsResponseV14configurationsSayAA13ConfigurationVGSgvp":{"name":"configurations","abstract":"

An array of Configurations that are available for the service instance.

","parent_name":"ListConfigurationsResponse"},"Structs/ListCollectionsResponse.html#/s:11DiscoveryV123ListCollectionsResponseV11collectionsSayAA10CollectionVGSgvp":{"name":"collections","abstract":"

An array containing information about each collection in the environment.

","parent_name":"ListCollectionsResponse"},"Structs/ListCollectionFieldsResponse.html#/s:11DiscoveryV128ListCollectionFieldsResponseV6fieldsSayAA5FieldVGSgvp":{"name":"fields","abstract":"

An array containing information about each field in the collections.

","parent_name":"ListCollectionFieldsResponse"},"Structs/IndexCapacity.html#/s:11DiscoveryV113IndexCapacityV9documentsAA20EnvironmentDocumentsVSgvp":{"name":"documents","abstract":"

Summary of the document usage statistics for the environment.

","parent_name":"IndexCapacity"},"Structs/IndexCapacity.html#/s:11DiscoveryV113IndexCapacityV9diskUsageAA04DiskF0VSgvp":{"name":"diskUsage","abstract":"

Summary of the disk usage of the environment.

","parent_name":"IndexCapacity"},"Structs/IndexCapacity.html#/s:11DiscoveryV113IndexCapacityV11collectionsAA15CollectionUsageVSgvp":{"name":"collections","abstract":"

Summary of the collection usage in the environment.

","parent_name":"IndexCapacity"},"Structs/IndexCapacity.html#/s:11DiscoveryV113IndexCapacityV11memoryUsageAA06MemoryF0VSgvp":{"name":"memoryUsage","abstract":"

Deprecated**: Summary of the memory usage of the environment.

","parent_name":"IndexCapacity"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV21excludeTagsCompletelySaySSGSgvp":{"name":"excludeTagsCompletely","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV22excludeTagsKeepContentSaySSGSgvp":{"name":"excludeTagsKeepContent","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV11keepContentAA13XPathPatternsVSgvp":{"name":"keepContent","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV14excludeContentAA13XPathPatternsVSgvp":{"name":"excludeContent","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV17keepTagAttributesSaySSGSgvp":{"name":"keepTagAttributes","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsV20excludeTagAttributesSaySSGSgvp":{"name":"excludeTagAttributes","abstract":"

Undocumented

","parent_name":"HtmlSettings"},"Structs/HtmlSettings.html#/s:11DiscoveryV112HtmlSettingsVACSaySSGSg21excludeTagsCompletely_AE0eF11KeepContentAA13XPathPatternsVSg04keepI0AJ0eI0AE0L13TagAttributesAE0emN0tcfc":{"name":"init(excludeTagsCompletely:excludeTagsKeepContent:keepContent:excludeContent:keepTagAttributes:excludeTagAttributes:)","abstract":"

Initialize a HtmlSettings with member variables.

","parent_name":"HtmlSettings"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Histogram"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Histogram"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Histogram"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Histogram"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV5fieldSSSgvp":{"name":"field","abstract":"

The field where the aggregation is located in the document.

","parent_name":"Histogram"},"Structs/Histogram.html#/s:11DiscoveryV19HistogramV8intervalSiSgvp":{"name":"interval","abstract":"

Interval of the aggregation. (For ‘histogram’ type).

","parent_name":"Histogram"},"Structs/GenericQueryAggregation.html#/s:11DiscoveryV123GenericQueryAggregationV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"GenericQueryAggregation"},"Structs/GenericQueryAggregation.html#/s:11DiscoveryV123GenericQueryAggregationV7resultsSayAA0E6ResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"GenericQueryAggregation"},"Structs/GenericQueryAggregation.html#/s:11DiscoveryV123GenericQueryAggregationV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"GenericQueryAggregation"},"Structs/GenericQueryAggregation.html#/s:11DiscoveryV123GenericQueryAggregationV12aggregationsSayAA0dE0OGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"GenericQueryAggregation"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV5levelSiSgvp":{"name":"level","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV7minSizeSiSgvp":{"name":"minSize","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV7maxSizeSiSgvp":{"name":"maxSize","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV4boldSbSgvp":{"name":"bold","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV6italicSbSgvp":{"name":"italic","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingV4nameSSSgvp":{"name":"name","abstract":"

Undocumented

","parent_name":"FontSetting"},"Structs/FontSetting.html#/s:11DiscoveryV111FontSettingVACSiSg5level_AD7minSizeAD03maxG0SbSg4boldAH6italicSSSg4nametcfc":{"name":"init(level:minSize:maxSize:bold:italic:name:)","abstract":"

Initialize a FontSetting with member variables.

","parent_name":"FontSetting"},"Structs/Filter.html#/s:11DiscoveryV16FilterV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Filter"},"Structs/Filter.html#/s:11DiscoveryV16FilterV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Filter"},"Structs/Filter.html#/s:11DiscoveryV16FilterV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Filter"},"Structs/Filter.html#/s:11DiscoveryV16FilterV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Filter"},"Structs/Filter.html#/s:11DiscoveryV16FilterV5matchSSSgvp":{"name":"match","abstract":"

The match the aggregated results queried for.

","parent_name":"Filter"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO6nestedA2EmF":{"name":"nested","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO6stringA2EmF":{"name":"string","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO4dateA2EmF":{"name":"date","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO4longA2EmF":{"name":"long","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO7integerA2EmF":{"name":"integer","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO5shortA2EmF":{"name":"short","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO4byteA2EmF":{"name":"byte","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO6doubleA2EmF":{"name":"double","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO5floatA2EmF":{"name":"float","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO7booleanA2EmF":{"name":"boolean","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html#/s:11DiscoveryV15FieldV0C4TypeO6binaryA2EmF":{"name":"binary","abstract":"

Undocumented

","parent_name":"FieldType"},"Structs/Field/FieldType.html":{"name":"FieldType","abstract":"

The type of the field.

","parent_name":"Field"},"Structs/Field.html#/s:11DiscoveryV15FieldV9fieldNameSSSgvp":{"name":"fieldName","abstract":"

The name of the field.

","parent_name":"Field"},"Structs/Field.html#/s:11DiscoveryV15FieldV9fieldTypeSSSgvp":{"name":"fieldType","abstract":"

The type of the field.

","parent_name":"Field"},"Structs/Expansions.html#/s:11DiscoveryV110ExpansionsV10expansionsSayAA9ExpansionVGvp":{"name":"expansions","abstract":"

An array of query expansion definitions.","parent_name":"Expansions"},"Structs/Expansions.html#/s:11DiscoveryV110ExpansionsVACSayAA9ExpansionVG10expansions_tcfc":{"name":"init(expansions:)","abstract":"

Initialize a Expansions with member variables.

","parent_name":"Expansions"},"Structs/Expansion.html#/s:11DiscoveryV19ExpansionV10inputTermsSaySSGSgvp":{"name":"inputTerms","abstract":"

A list of terms that will be expanded for this expansion. If specified, only the items in this list are expanded.

","parent_name":"Expansion"},"Structs/Expansion.html#/s:11DiscoveryV19ExpansionV13expandedTermsSaySSGvp":{"name":"expandedTerms","abstract":"

A list of terms that this expansion will be expanded to. If specified without input_terms, it also functions as","parent_name":"Expansion"},"Structs/Expansion.html#/s:11DiscoveryV19ExpansionVACSaySSG13expandedTerms_ADSg05inputE0tcfc":{"name":"init(expandedTerms:inputTerms:)","abstract":"

Initialize a Expansion with member variables.

","parent_name":"Expansion"},"Structs/EnvironmentDocuments.html#/s:11DiscoveryV120EnvironmentDocumentsV7indexedSiSgvp":{"name":"indexed","abstract":"

Number of documents indexed for the environment.

","parent_name":"EnvironmentDocuments"},"Structs/EnvironmentDocuments.html#/s:11DiscoveryV120EnvironmentDocumentsV14maximumAllowedSiSgvp":{"name":"maximumAllowed","abstract":"

Total number of documents allowed in the environment’s capacity.

","parent_name":"EnvironmentDocuments"},"Structs/Environment/Status.html#/s:11DiscoveryV111EnvironmentV6StatusO6activeA2EmF":{"name":"active","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Environment/Status.html#/s:11DiscoveryV111EnvironmentV6StatusO7pendingA2EmF":{"name":"pending","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Environment/Status.html#/s:11DiscoveryV111EnvironmentV6StatusO11maintenanceA2EmF":{"name":"maintenance","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Environment/Status.html":{"name":"Status","abstract":"

Status of the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV13environmentIDSSSgvp":{"name":"environmentID","abstract":"

Unique identifier for the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV4nameSSSgvp":{"name":"name","abstract":"

Name that identifies the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV11descriptionSSSgvp":{"name":"description","abstract":"

Description of the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV7createdSSSgvp":{"name":"created","abstract":"

Creation date of the environment, in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV7updatedSSSgvp":{"name":"updated","abstract":"

Date of most recent environment update, in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV6statusSSSgvp":{"name":"status","abstract":"

Status of the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV8readOnlySbSgvp":{"name":"readOnly","abstract":"

If true, then the environment contains read-only collections which are maintained by IBM.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV4sizeSiSgvp":{"name":"size","abstract":"

Deprecated**: Size of the environment.

","parent_name":"Environment"},"Structs/Environment.html#/s:11DiscoveryV111EnvironmentV13indexCapacityAA05IndexE0VSgvp":{"name":"indexCapacity","abstract":"

Details about the resource usage and capacity of the environment.

","parent_name":"Environment"},"Structs/EnrichmentOptions.html#/s:11DiscoveryV117EnrichmentOptionsV8featuresAA03NluC8FeaturesVSgvp":{"name":"features","abstract":"

An object representing the enrichment features that will be applied to the specified field.

","parent_name":"EnrichmentOptions"},"Structs/EnrichmentOptions.html#/s:11DiscoveryV117EnrichmentOptionsV5modelSSSgvp":{"name":"model","abstract":"

For use with elements enrichments only.* The element extraction model to use. Models available are: contract.

","parent_name":"EnrichmentOptions"},"Structs/EnrichmentOptions.html#/s:11DiscoveryV117EnrichmentOptionsVAcA03NluC8FeaturesVSg8features_SSSg5modeltcfc":{"name":"init(features:model:)","abstract":"

Initialize a EnrichmentOptions with member variables.

","parent_name":"EnrichmentOptions"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV11descriptionSSSgvp":{"name":"description","abstract":"

Describes what the enrichment step does.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV16destinationFieldSSvp":{"name":"destinationField","abstract":"

Field where enrichments will be stored. This field must already exist or be at most 1 level deeper than an existing","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV11sourceFieldSSvp":{"name":"sourceField","abstract":"

Field to be enriched.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV9overwriteSbSgvp":{"name":"overwrite","abstract":"

Indicates that the enrichments will overwrite the destination_field field if it already exists.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV14enrichmentNameSSvp":{"name":"enrichmentName","abstract":"

Name of the enrichment service to call. Current options are natural_language_understanding and elements.","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV22ignoreDownstreamErrorsSbSgvp":{"name":"ignoreDownstreamErrors","abstract":"

If true, then most errors generated during the enrichment process will be treated as warnings and will not cause","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentV7optionsAA0C7OptionsVSgvp":{"name":"options","abstract":"

A list of options specific to the enrichment.

","parent_name":"Enrichment"},"Structs/Enrichment.html#/s:11DiscoveryV110EnrichmentVACSS16destinationField_SS06sourceE0SS14enrichmentNameSSSg11descriptionSbSg9overwriteAI22ignoreDownstreamErrorsAA0C7OptionsVSg7optionstcfc":{"name":"init(destinationField:sourceField:enrichmentName:description:overwrite:ignoreDownstreamErrors:options:)","abstract":"

Initialize a Enrichment with member variables.

","parent_name":"Enrichment"},"Structs/DocumentStatus/FileType.html#/s:11DiscoveryV114DocumentStatusV8FileTypeO3pdfA2EmF":{"name":"pdf","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/DocumentStatus/FileType.html#/s:11DiscoveryV114DocumentStatusV8FileTypeO4htmlA2EmF":{"name":"html","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/DocumentStatus/FileType.html#/s:11DiscoveryV114DocumentStatusV8FileTypeO4wordA2EmF":{"name":"word","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/DocumentStatus/FileType.html#/s:11DiscoveryV114DocumentStatusV8FileTypeO4jsonA2EmF":{"name":"json","abstract":"

Undocumented

","parent_name":"FileType"},"Structs/DocumentStatus/Status.html#/s:11DiscoveryV114DocumentStatusV0D0O9availableA2EmF":{"name":"available","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DocumentStatus/Status.html#/s:11DiscoveryV114DocumentStatusV0D0O20availableWithNoticesA2EmF":{"name":"availableWithNotices","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DocumentStatus/Status.html#/s:11DiscoveryV114DocumentStatusV0D0O6failedA2EmF":{"name":"failed","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DocumentStatus/Status.html#/s:11DiscoveryV114DocumentStatusV0D0O10processingA2EmF":{"name":"processing","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DocumentStatus/Status.html":{"name":"Status","abstract":"

Status of the document in the ingestion process.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus/FileType.html":{"name":"FileType","abstract":"

The type of the original source file.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV10documentIDSSvp":{"name":"documentID","abstract":"

The unique identifier of the document.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV15configurationIDSSSgvp":{"name":"configurationID","abstract":"

The unique identifier for the configuration.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV7createdSSSgvp":{"name":"created","abstract":"

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

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV7updatedSSSgvp":{"name":"updated","abstract":"

Date of the most recent document update, in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV6statusSSvp":{"name":"status","abstract":"

Status of the document in the ingestion process.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV17statusDescriptionSSvp":{"name":"statusDescription","abstract":"

Description of the document status.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV8filenameSSSgvp":{"name":"filename","abstract":"

Name of the original source file (if available).

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV8fileTypeSSSgvp":{"name":"fileType","abstract":"

The type of the original source file.

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV4sha1SSSgvp":{"name":"sha1","abstract":"

The SHA-1 hash of the original source file (formatted as a hexadecimal string).

","parent_name":"DocumentStatus"},"Structs/DocumentStatus.html#/s:11DiscoveryV114DocumentStatusV7noticesSayAA6NoticeVGvp":{"name":"notices","abstract":"

Array of notices produced by the document-ingestion process.

","parent_name":"DocumentStatus"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO9htmlInputA2EmF":{"name":"htmlInput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO10htmlOutputA2EmF":{"name":"htmlOutput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO10jsonOutputA2EmF":{"name":"jsonOutput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO24jsonNormalizationsOutputA2EmF":{"name":"jsonNormalizationsOutput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO17enrichmentsOutputA2EmF":{"name":"enrichmentsOutput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html#/s:11DiscoveryV116DocumentSnapshotV4StepO20normalizationsOutputA2EmF":{"name":"normalizationsOutput","abstract":"

Undocumented

","parent_name":"Step"},"Structs/DocumentSnapshot/Step.html":{"name":"Step","abstract":"

Undocumented

","parent_name":"DocumentSnapshot"},"Structs/DocumentSnapshot.html#/s:11DiscoveryV116DocumentSnapshotV4stepSSSgvp":{"name":"step","abstract":"

Undocumented

","parent_name":"DocumentSnapshot"},"Structs/DocumentSnapshot.html#/s:11DiscoveryV116DocumentSnapshotV8snapshots10DictionaryVySSAA4JSONOGSgvp":{"name":"snapshot","abstract":"

Undocumented

","parent_name":"DocumentSnapshot"},"Structs/DocumentCounts.html#/s:11DiscoveryV114DocumentCountsV9availableSiSgvp":{"name":"available","abstract":"

The total number of available documents in the collection.

","parent_name":"DocumentCounts"},"Structs/DocumentCounts.html#/s:11DiscoveryV114DocumentCountsV10processingSiSgvp":{"name":"processing","abstract":"

The number of documents in the collection that are currently being processed.

","parent_name":"DocumentCounts"},"Structs/DocumentCounts.html#/s:11DiscoveryV114DocumentCountsV6failedSiSgvp":{"name":"failed","abstract":"

The number of documents in the collection that failed to be ingested.

","parent_name":"DocumentCounts"},"Structs/DocumentAccepted/Status.html#/s:11DiscoveryV116DocumentAcceptedV6StatusO10processingA2EmF":{"name":"processing","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DocumentAccepted/Status.html":{"name":"Status","abstract":"

Status of the document in the ingestion process.

","parent_name":"DocumentAccepted"},"Structs/DocumentAccepted.html#/s:11DiscoveryV116DocumentAcceptedV10documentIDSSSgvp":{"name":"documentID","abstract":"

The unique identifier of the ingested document.

","parent_name":"DocumentAccepted"},"Structs/DocumentAccepted.html#/s:11DiscoveryV116DocumentAcceptedV6statusSSSgvp":{"name":"status","abstract":"

Status of the document in the ingestion process.

","parent_name":"DocumentAccepted"},"Structs/DocumentAccepted.html#/s:11DiscoveryV116DocumentAcceptedV7noticesSayAA6NoticeVGSgvp":{"name":"notices","abstract":"

Array of notices produced by the document-ingestion process.

","parent_name":"DocumentAccepted"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV9usedBytesSiSgvp":{"name":"usedBytes","abstract":"

Number of bytes used on the environment’s disk capacity.

","parent_name":"DiskUsage"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV19maximumAllowedBytesSiSgvp":{"name":"maximumAllowedBytes","abstract":"

Total number of bytes available in the environment’s disk capacity.

","parent_name":"DiskUsage"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV10totalBytesSiSgvp":{"name":"totalBytes","abstract":"

Deprecated**: Total number of bytes available in the environment’s disk capacity.

","parent_name":"DiskUsage"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV4usedSSSgvp":{"name":"used","abstract":"

Deprecated**: Amount of disk capacity used, in KB or GB format.

","parent_name":"DiskUsage"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV5totalSSSgvp":{"name":"total","abstract":"

Deprecated**: Total amount of the environment’s disk capacity, in KB or GB format.

","parent_name":"DiskUsage"},"Structs/DiskUsage.html#/s:11DiscoveryV19DiskUsageV11percentUsedSdSgvp":{"name":"percentUsed","abstract":"

Deprecated**: Percentage of the environment’s disk capacity that is being used.

","parent_name":"DiskUsage"},"Structs/DeleteEnvironmentResponse/Status.html#/s:11DiscoveryV125DeleteEnvironmentResponseV6StatusO7deletedA2EmF":{"name":"deleted","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DeleteEnvironmentResponse/Status.html":{"name":"Status","abstract":"

Status of the environment.

","parent_name":"DeleteEnvironmentResponse"},"Structs/DeleteEnvironmentResponse.html#/s:11DiscoveryV125DeleteEnvironmentResponseV13environmentIDSSvp":{"name":"environmentID","abstract":"

The unique identifier for the environment.

","parent_name":"DeleteEnvironmentResponse"},"Structs/DeleteEnvironmentResponse.html#/s:11DiscoveryV125DeleteEnvironmentResponseV6statusSSvp":{"name":"status","abstract":"

Status of the environment.

","parent_name":"DeleteEnvironmentResponse"},"Structs/DeleteDocumentResponse/Status.html#/s:11DiscoveryV122DeleteDocumentResponseV6StatusO7deletedA2EmF":{"name":"deleted","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DeleteDocumentResponse/Status.html":{"name":"Status","abstract":"

Status of the document. A deleted document has the status deleted.

","parent_name":"DeleteDocumentResponse"},"Structs/DeleteDocumentResponse.html#/s:11DiscoveryV122DeleteDocumentResponseV10documentIDSSSgvp":{"name":"documentID","abstract":"

The unique identifier of the document.

","parent_name":"DeleteDocumentResponse"},"Structs/DeleteDocumentResponse.html#/s:11DiscoveryV122DeleteDocumentResponseV6statusSSSgvp":{"name":"status","abstract":"

Status of the document. A deleted document has the status deleted.

","parent_name":"DeleteDocumentResponse"},"Structs/DeleteConfigurationResponse/Status.html#/s:11DiscoveryV127DeleteConfigurationResponseV6StatusO7deletedA2EmF":{"name":"deleted","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DeleteConfigurationResponse/Status.html":{"name":"Status","abstract":"

Status of the configuration. A deleted configuration has the status deleted.

","parent_name":"DeleteConfigurationResponse"},"Structs/DeleteConfigurationResponse.html#/s:11DiscoveryV127DeleteConfigurationResponseV15configurationIDSSvp":{"name":"configurationID","abstract":"

The unique identifier for the configuration.

","parent_name":"DeleteConfigurationResponse"},"Structs/DeleteConfigurationResponse.html#/s:11DiscoveryV127DeleteConfigurationResponseV6statusSSvp":{"name":"status","abstract":"

Status of the configuration. A deleted configuration has the status deleted.

","parent_name":"DeleteConfigurationResponse"},"Structs/DeleteConfigurationResponse.html#/s:11DiscoveryV127DeleteConfigurationResponseV7noticesSayAA6NoticeVGSgvp":{"name":"notices","abstract":"

An array of notice messages, if any.

","parent_name":"DeleteConfigurationResponse"},"Structs/DeleteCollectionResponse/Status.html#/s:11DiscoveryV124DeleteCollectionResponseV6StatusO7deletedA2EmF":{"name":"deleted","abstract":"

Undocumented

","parent_name":"Status"},"Structs/DeleteCollectionResponse/Status.html":{"name":"Status","abstract":"

The status of the collection. The status of a successful deletion operation is deleted.

","parent_name":"DeleteCollectionResponse"},"Structs/DeleteCollectionResponse.html#/s:11DiscoveryV124DeleteCollectionResponseV12collectionIDSSvp":{"name":"collectionID","abstract":"

The unique identifier of the collection that is being deleted.

","parent_name":"DeleteCollectionResponse"},"Structs/DeleteCollectionResponse.html#/s:11DiscoveryV124DeleteCollectionResponseV6statusSSvp":{"name":"status","abstract":"

The status of the collection. The status of a successful deletion operation is deleted.

","parent_name":"DeleteCollectionResponse"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2enA2EmF":{"name":"en","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2esA2EmF":{"name":"es","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2deA2EmF":{"name":"de","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2arA2EmF":{"name":"ar","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2frA2EmF":{"name":"fr","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2itA2EmF":{"name":"it","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2jaA2EmF":{"name":"ja","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2koA2EmF":{"name":"ko","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html#/s:11DiscoveryV123CreateCollectionRequestV8LanguageO2ptA2EmF":{"name":"pt","abstract":"

Undocumented

","parent_name":"Language"},"Structs/CreateCollectionRequest/Language.html":{"name":"Language","abstract":"

The language of the documents stored in the collection, in the form of an ISO 639-1 language code.

","parent_name":"CreateCollectionRequest"},"Structs/CreateCollectionRequest.html#/s:11DiscoveryV123CreateCollectionRequestV4nameSSvp":{"name":"name","abstract":"

The name of the collection to be created.

","parent_name":"CreateCollectionRequest"},"Structs/CreateCollectionRequest.html#/s:11DiscoveryV123CreateCollectionRequestV11descriptionSSSgvp":{"name":"description","abstract":"

A description of the collection.

","parent_name":"CreateCollectionRequest"},"Structs/CreateCollectionRequest.html#/s:11DiscoveryV123CreateCollectionRequestV15configurationIDSSSgvp":{"name":"configurationID","abstract":"

The ID of the configuration in which the collection is to be created.

","parent_name":"CreateCollectionRequest"},"Structs/CreateCollectionRequest.html#/s:11DiscoveryV123CreateCollectionRequestV8languageSSSgvp":{"name":"language","abstract":"

The language of the documents stored in the collection, in the form of an ISO 639-1 language code.

","parent_name":"CreateCollectionRequest"},"Structs/CreateCollectionRequest.html#/s:11DiscoveryV123CreateCollectionRequestVACSS4name_SSSg11descriptionAE15configurationIDAE8languagetcfc":{"name":"init(name:description:configurationID:language:)","abstract":"

Initialize a CreateCollectionRequest with member variables.

","parent_name":"CreateCollectionRequest"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsV3pdfAA11PdfSettingsVSgvp":{"name":"pdf","abstract":"

A list of PDF conversion settings.

","parent_name":"Conversions"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsV4wordAA12WordSettingsVSgvp":{"name":"word","abstract":"

A list of Word conversion settings.

","parent_name":"Conversions"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsV4htmlAA12HtmlSettingsVSgvp":{"name":"html","abstract":"

A list of HTML conversion settings.

","parent_name":"Conversions"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsV7segmentAA15SegmentSettingsVSgvp":{"name":"segment","abstract":"

A list of Document Segmentation settings.

","parent_name":"Conversions"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsV18jsonNormalizationsSayAA22NormalizationOperationVGSgvp":{"name":"jsonNormalizations","abstract":"

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are","parent_name":"Conversions"},"Structs/Conversions.html#/s:11DiscoveryV111ConversionsVAcA11PdfSettingsVSg3pdf_AA04WordE0VSg4wordAA04HtmlE0VSg4htmlAA07SegmentE0VSg7segmentSayAA22NormalizationOperationVGSg18jsonNormalizationstcfc":{"name":"init(pdf:word:html:segment:jsonNormalizations:)","abstract":"

Initialize a Conversions with member variables.

","parent_name":"Conversions"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV15configurationIDSSSgvp":{"name":"configurationID","abstract":"

The unique identifier of the configuration.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV4nameSSvp":{"name":"name","abstract":"

The name of the configuration.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV7createdSSSgvp":{"name":"created","abstract":"

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

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp of when the configuration was last updated in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the configuration, if available.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV11conversionsAA11ConversionsVSgvp":{"name":"conversions","abstract":"

The document conversion settings for the configuration.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV11enrichmentsSayAA10EnrichmentVGSgvp":{"name":"enrichments","abstract":"

An array of document enrichment settings for the configuration.

","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationV14normalizationsSayAA22NormalizationOperationVGSgvp":{"name":"normalizations","abstract":"

Defines operations that can be used to transform the final output JSON into a normalized form. Operations are","parent_name":"Configuration"},"Structs/Configuration.html#/s:11DiscoveryV113ConfigurationVACSS4name_SSSg15configurationIDAE7createdAE7updatedAE11descriptionAA11ConversionsVSg11conversionsSayAA10EnrichmentVGSg11enrichmentsSayAA22NormalizationOperationVGSg14normalizationstcfc":{"name":"init(name:configurationID:created:updated:description:conversions:enrichments:normalizations:)","abstract":"

Initialize a Configuration with member variables.

","parent_name":"Configuration"},"Structs/CollectionUsage.html#/s:11DiscoveryV115CollectionUsageV9availableSiSgvp":{"name":"available","abstract":"

Number of active collections in the environment.

","parent_name":"CollectionUsage"},"Structs/CollectionUsage.html#/s:11DiscoveryV115CollectionUsageV14maximumAllowedSiSgvp":{"name":"maximumAllowed","abstract":"

Total number of collections allowed in the environment.

","parent_name":"CollectionUsage"},"Structs/CollectionDiskUsage.html#/s:11DiscoveryV119CollectionDiskUsageV9usedBytesSiSgvp":{"name":"usedBytes","abstract":"

Number of bytes used by the collection.

","parent_name":"CollectionDiskUsage"},"Structs/Collection/Status.html#/s:11DiscoveryV110CollectionV6StatusO6activeA2EmF":{"name":"active","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Collection/Status.html#/s:11DiscoveryV110CollectionV6StatusO7pendingA2EmF":{"name":"pending","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Collection/Status.html#/s:11DiscoveryV110CollectionV6StatusO11maintenanceA2EmF":{"name":"maintenance","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Collection/Status.html":{"name":"Status","abstract":"

The status of the collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV12collectionIDSSSgvp":{"name":"collectionID","abstract":"

The unique identifier of the collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV4nameSSSgvp":{"name":"name","abstract":"

The name of the collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV11descriptionSSSgvp":{"name":"description","abstract":"

The description of the collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV7createdSSSgvp":{"name":"created","abstract":"

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

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV7updatedSSSgvp":{"name":"updated","abstract":"

The timestamp of when the collection was last updated in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV6statusSSSgvp":{"name":"status","abstract":"

The status of the collection.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV15configurationIDSSSgvp":{"name":"configurationID","abstract":"

The unique identifier of the collection’s configuration.

","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV8languageSSSgvp":{"name":"language","abstract":"

The language of the documents stored in the collection. Permitted values include en (English), de (German), and","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV14documentCountsAA08DocumentE0VSgvp":{"name":"documentCounts","abstract":"

The object providing information about the documents in the collection. Present only when retrieving details of a","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV9diskUsageAA0c4DiskE0VSgvp":{"name":"diskUsage","abstract":"

The object providing information about the disk usage of the collection. Present only when retrieving details of a","parent_name":"Collection"},"Structs/Collection.html#/s:11DiscoveryV110CollectionV14trainingStatusAA08TrainingE0VSgvp":{"name":"trainingStatus","abstract":"

Provides information about the status of relevance training for collection.

","parent_name":"Collection"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV4typeSSSgvp":{"name":"type","abstract":"

The type of aggregation command used. For example: term, filter, max, min, etc.

","parent_name":"Calculation"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV7resultsSayAA17AggregationResultVGSgvp":{"name":"results","abstract":"

Undocumented

","parent_name":"Calculation"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"Calculation"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV12aggregationsSayAA16QueryAggregationOGSgvp":{"name":"aggregations","abstract":"

Aggregations returned by the Discovery service.

","parent_name":"Calculation"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV5fieldSSSgvp":{"name":"field","abstract":"

The field where the aggregation is located in the document.

","parent_name":"Calculation"},"Structs/Calculation.html#/s:11DiscoveryV111CalculationV5valueSdSgvp":{"name":"value","abstract":"

Value of the aggregation.

","parent_name":"Calculation"},"Structs/AggregationResult.html#/s:11DiscoveryV117AggregationResultV3keySSSgvp":{"name":"key","abstract":"

Key that matched the aggregation type.

","parent_name":"AggregationResult"},"Structs/AggregationResult.html#/s:11DiscoveryV117AggregationResultV15matchingResultsSiSgvp":{"name":"matchingResults","abstract":"

Number of matching results.

","parent_name":"AggregationResult"},"Structs/AggregationResult.html#/s:11DiscoveryV117AggregationResultV12aggregationsSayAA05QueryC0OGSgvp":{"name":"aggregations","abstract":"

Aggregations returned in the case of chained aggregations.

","parent_name":"AggregationResult"},"Structs/AggregationResult.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"AggregationResult"},"Structs/AggregationResult.html":{"name":"AggregationResult","abstract":"

AggregationResult.

"},"Structs/Calculation.html":{"name":"Calculation","abstract":"

Calculation.

"},"Structs/Collection.html":{"name":"Collection","abstract":"

A collection for storing documents.

"},"Structs/CollectionDiskUsage.html":{"name":"CollectionDiskUsage","abstract":"

Summary of the disk usage statistics for this collection.

"},"Structs/CollectionUsage.html":{"name":"CollectionUsage","abstract":"

Summary of the collection usage in the environment.

"},"Structs/Configuration.html":{"name":"Configuration","abstract":"

A custom configuration for the environment.

"},"Structs/Conversions.html":{"name":"Conversions","abstract":"

Document conversion settings.

"},"Structs/CreateCollectionRequest.html":{"name":"CreateCollectionRequest","abstract":"

CreateCollectionRequest.

"},"Structs/DeleteCollectionResponse.html":{"name":"DeleteCollectionResponse","abstract":"

DeleteCollectionResponse.

"},"Structs/DeleteConfigurationResponse.html":{"name":"DeleteConfigurationResponse","abstract":"

DeleteConfigurationResponse.

"},"Structs/DeleteDocumentResponse.html":{"name":"DeleteDocumentResponse","abstract":"

DeleteDocumentResponse.

"},"Structs/DeleteEnvironmentResponse.html":{"name":"DeleteEnvironmentResponse","abstract":"

DeleteEnvironmentResponse.

"},"Structs/DiskUsage.html":{"name":"DiskUsage","abstract":"

Summary of the disk usage statistics for the environment.

"},"Structs/DocumentAccepted.html":{"name":"DocumentAccepted","abstract":"

DocumentAccepted.

"},"Structs/DocumentCounts.html":{"name":"DocumentCounts","abstract":"

DocumentCounts.

"},"Structs/DocumentSnapshot.html":{"name":"DocumentSnapshot","abstract":"

DocumentSnapshot.

"},"Structs/DocumentStatus.html":{"name":"DocumentStatus","abstract":"

Status information about a submitted document.

"},"Structs/Enrichment.html":{"name":"Enrichment","abstract":"

Enrichment.

"},"Structs/EnrichmentOptions.html":{"name":"EnrichmentOptions","abstract":"

Options which are specific to a particular enrichment.

"},"Structs/Environment.html":{"name":"Environment","abstract":"

Details about an environment.

"},"Structs/EnvironmentDocuments.html":{"name":"EnvironmentDocuments","abstract":"

Summary of the document usage statistics for the environment.

"},"Structs/Expansion.html":{"name":"Expansion","abstract":"

An expansion definition. Each object respresents one set of expandable strings. For example, you could have expansions for the word hot in one object, and expansions for the word cold in another.

"},"Structs/Expansions.html":{"name":"Expansions","abstract":"

The query expansion definitions for the specified collection.

"},"Structs/Field.html":{"name":"Field","abstract":"

Field.

"},"Structs/Filter.html":{"name":"Filter","abstract":"

Filter.

"},"Structs/FontSetting.html":{"name":"FontSetting","abstract":"

FontSetting.

"},"Structs/GenericQueryAggregation.html":{"name":"GenericQueryAggregation","abstract":"

An aggregation produced by the Discovery service to analyze the input provided.

"},"Structs/Histogram.html":{"name":"Histogram","abstract":"

Histogram.

"},"Structs/HtmlSettings.html":{"name":"HtmlSettings","abstract":"

A list of HTML conversion settings.

"},"Structs/IndexCapacity.html":{"name":"IndexCapacity","abstract":"

Details about the resource usage and capacity of the environment.

"},"Structs/ListCollectionFieldsResponse.html":{"name":"ListCollectionFieldsResponse","abstract":"

The list of fetched fields.

"},"Structs/ListCollectionsResponse.html":{"name":"ListCollectionsResponse","abstract":"

ListCollectionsResponse.

"},"Structs/ListConfigurationsResponse.html":{"name":"ListConfigurationsResponse","abstract":"

ListConfigurationsResponse.

"},"Structs/ListEnvironmentsResponse.html":{"name":"ListEnvironmentsResponse","abstract":"

ListEnvironmentsResponse.

"},"Structs/MemoryUsage.html":{"name":"MemoryUsage","abstract":"

Deprecated**: Summary of the memory usage statistics for this environment.

"},"Structs/Nested.html":{"name":"Nested","abstract":"

Nested.

"},"Structs/NluEnrichmentCategories.html":{"name":"NluEnrichmentCategories","abstract":"

An object that indicates the Categories enrichment will be applied to the specified field.

"},"Structs/NluEnrichmentEmotion.html":{"name":"NluEnrichmentEmotion","abstract":"

An object specifying the emotion detection enrichment and related parameters.

"},"Structs/NluEnrichmentEntities.html":{"name":"NluEnrichmentEntities","abstract":"

An object speficying the Entities enrichment and related parameters.

"},"Structs/NluEnrichmentFeatures.html":{"name":"NluEnrichmentFeatures","abstract":"

NluEnrichmentFeatures.

"},"Structs/NluEnrichmentKeywords.html":{"name":"NluEnrichmentKeywords","abstract":"

An object specifying the Keyword enrichment and related parameters.

"},"Structs/NluEnrichmentRelations.html":{"name":"NluEnrichmentRelations","abstract":"

An object specifying the relations enrichment and related parameters.

"},"Structs/NluEnrichmentSemanticRoles.html":{"name":"NluEnrichmentSemanticRoles","abstract":"

An object specifiying the semantic roles enrichment and related parameters.

"},"Structs/NluEnrichmentSentiment.html":{"name":"NluEnrichmentSentiment","abstract":"

An object specifying the sentiment extraction enrichment and related parameters.

"},"Structs/NormalizationOperation.html":{"name":"NormalizationOperation","abstract":"

NormalizationOperation.

"},"Structs/Notice.html":{"name":"Notice","abstract":"

A notice produced for the collection.

"},"Structs/PdfHeadingDetection.html":{"name":"PdfHeadingDetection","abstract":"

PdfHeadingDetection.

"},"Structs/PdfSettings.html":{"name":"PdfSettings","abstract":"

A list of PDF conversion settings.

"},"Structs/QueryEntities.html":{"name":"QueryEntities","abstract":"

QueryEntities.

"},"Structs/QueryEntitiesContext.html":{"name":"QueryEntitiesContext","abstract":"

Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for London with the context of England.

"},"Structs/QueryEntitiesEntity.html":{"name":"QueryEntitiesEntity","abstract":"

A text string that appears within the entity text field.

"},"Structs/QueryEntitiesResponse.html":{"name":"QueryEntitiesResponse","abstract":"

An array of entities resulting from the query.

"},"Structs/QueryEntitiesResponseItem.html":{"name":"QueryEntitiesResponseItem","abstract":"

Object containing Entity query response information.

"},"Structs/QueryEvidence.html":{"name":"QueryEvidence","abstract":"

Description of evidence location supporting Knoweldge Graph query result.

"},"Structs/QueryEvidenceEntity.html":{"name":"QueryEvidenceEntity","abstract":"

Entity description and location within evidence field.

"},"Structs/QueryFilterType.html":{"name":"QueryFilterType","abstract":"

QueryFilterType.

"},"Structs/QueryNoticesResponse.html":{"name":"QueryNoticesResponse","abstract":"

QueryNoticesResponse.

"},"Structs/QueryNoticesResult.html":{"name":"QueryNoticesResult","abstract":"

QueryNoticesResult.

"},"Structs/QueryPassages.html":{"name":"QueryPassages","abstract":"

QueryPassages.

"},"Structs/QueryRelations.html":{"name":"QueryRelations","abstract":"

A respresentation of a relationship query.

"},"Structs/QueryRelationsArgument.html":{"name":"QueryRelationsArgument","abstract":"

QueryRelationsArgument.

"},"Structs/QueryRelationsEntity.html":{"name":"QueryRelationsEntity","abstract":"

QueryRelationsEntity.

"},"Structs/QueryRelationsFilter.html":{"name":"QueryRelationsFilter","abstract":"

QueryRelationsFilter.

"},"Structs/QueryRelationsRelationship.html":{"name":"QueryRelationsRelationship","abstract":"

QueryRelationsRelationship.

"},"Structs/QueryRelationsResponse.html":{"name":"QueryRelationsResponse","abstract":"

QueryRelationsResponse.

"},"Structs/QueryResponse.html":{"name":"QueryResponse","abstract":"

A response containing the documents and aggregations for the query.

"},"Structs/QueryResult.html":{"name":"QueryResult","abstract":"

QueryResult.

"},"Structs/QueryResultMetadata.html":{"name":"QueryResultMetadata","abstract":"

Metadata of a query result.

"},"Structs/SegmentSettings.html":{"name":"SegmentSettings","abstract":"

A list of Document Segmentation settings.

"},"Structs/Term.html":{"name":"Term","abstract":"

Term.

"},"Structs/TestDocument.html":{"name":"TestDocument","abstract":"

TestDocument.

"},"Structs/Timeslice.html":{"name":"Timeslice","abstract":"

Timeslice.

"},"Structs/TopHits.html":{"name":"TopHits","abstract":"

TopHits.

"},"Structs/TopHitsResults.html":{"name":"TopHitsResults","abstract":"

TopHitsResults.

"},"Structs/TrainingDataSet.html":{"name":"TrainingDataSet","abstract":"

TrainingDataSet.

"},"Structs/TrainingExample.html":{"name":"TrainingExample","abstract":"

TrainingExample.

"},"Structs/TrainingExampleList.html":{"name":"TrainingExampleList","abstract":"

TrainingExampleList.

"},"Structs/TrainingQuery.html":{"name":"TrainingQuery","abstract":"

TrainingQuery.

"},"Structs/TrainingStatus.html":{"name":"TrainingStatus","abstract":"

TrainingStatus.

"},"Structs/WordHeadingDetection.html":{"name":"WordHeadingDetection","abstract":"

WordHeadingDetection.

"},"Structs/WordSettings.html":{"name":"WordSettings","abstract":"

A list of Word conversion settings.

"},"Structs/WordStyle.html":{"name":"WordStyle","abstract":"

WordStyle.

"},"Structs/XPathPatterns.html":{"name":"XPathPatterns","abstract":"

XPathPatterns.

"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO013serializationD0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO08encodingD0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO011fileManagerD0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:11DiscoveryV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:11DiscoveryV14JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:11DiscoveryV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO4termAcA4TermVcACmF":{"name":"term","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO6filterAcA6FilterVcACmF":{"name":"filter","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO6nestedAcA6NestedVcACmF":{"name":"nested","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO9histogramAcA9HistogramVcACmF":{"name":"histogram","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO9timesliceAcA9TimesliceVcACmF":{"name":"timeslice","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO7topHitsAcA03TopF0VcACmF":{"name":"topHits","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO11uniqueCountAcA11CalculationVcACmF":{"name":"uniqueCount","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO3maxAcA11CalculationVcACmF":{"name":"max","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO3minAcA11CalculationVcACmF":{"name":"min","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO7averageAcA11CalculationVcACmF":{"name":"average","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO3sumAcA11CalculationVcACmF":{"name":"sum","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:11DiscoveryV116QueryAggregationO7genericAcA07GenericcD0VcACmF":{"name":"generic","abstract":"

Undocumented

","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"QueryAggregation"},"Enums/QueryAggregation.html":{"name":"QueryAggregation","abstract":"

An aggregation produced by the Discovery service to analyze the input provided.

"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/Discovery.html#/s:11DiscoveryV10A0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

Create a Discovery object.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a Discovery object.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a Discovery object.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C17createEnvironmentySS4name_SSSg11descriptionSiSg4sizes10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createEnvironment(name:description:size:headers:failure:success:)","abstract":"

Create an environment.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16listEnvironmentsySSSg4name_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA04ListD8ResponseVc7successtF":{"name":"listEnvironments(name:headers:failure:success:)","abstract":"

List environments.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14getEnvironmentySS13environmentID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getEnvironment(environmentID:headers:failure:success:)","abstract":"

Get environment info.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C17updateEnvironmentySS13environmentID_SSSg4nameAF11descriptions10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateEnvironment(environmentID:name:description:headers:failure:success:)","abstract":"

Update an environment.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C17deleteEnvironmentySS13environmentID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteD8ResponseVc7successtF":{"name":"deleteEnvironment(environmentID:headers:failure:success:)","abstract":"

Delete environment.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C10listFieldsySS13environmentID_SaySSG13collectionIdss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA014ListCollectionD8ResponseVc7successtF":{"name":"listFields(environmentID:collectionIds:headers:failure:success:)","abstract":"

List fields across collections.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C19createConfigurationySS13environmentID_AA0D0V13configurations10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAGc7successtF":{"name":"createConfiguration(environmentID:configuration:headers:failure:success:)","abstract":"

Add configuration.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C18listConfigurationsySS13environmentID_SSSg4names10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA04ListD8ResponseVc7successtF":{"name":"listConfigurations(environmentID:name:headers:failure:success:)","abstract":"

List configurations.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16getConfigurationySS13environmentID_SS013configurationF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getConfiguration(environmentID:configurationID:headers:failure:success:)","abstract":"

Get configuration details.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C19updateConfigurationySS13environmentID_SS013configurationF0AA0D0V0G0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAHc7successtF":{"name":"updateConfiguration(environmentID:configurationID:configuration:headers:failure:success:)","abstract":"

Update a configuration.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C19deleteConfigurationySS13environmentID_SS013configurationF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteD8ResponseVc7successtF":{"name":"deleteConfiguration(environmentID:configurationID:headers:failure:success:)","abstract":"

Delete a configuration.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C30testConfigurationInEnvironmentySS13environmentID_SSSg13configurationAF4stepAF0iH010Foundation3URLVSg4fileAF8metadataAF0M11ContentTypes10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA12TestDocumentVc7successtF":{"name":"testConfigurationInEnvironment(environmentID:configuration:step:configurationID:file:metadata:fileContentType:headers:failure:success:)","abstract":"

Test configuration.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16createCollectionySS13environmentID_AA06CreateD7RequestV10propertiess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createCollection(environmentID:properties:headers:failure:success:)","abstract":"

Create a collection.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C15listCollectionsySS13environmentID_SSSg4names10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA04ListD8ResponseVc7successtF":{"name":"listCollections(environmentID:name:headers:failure:success:)","abstract":"

List collections.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C13getCollectionySS13environmentID_SS010collectionF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"getCollection(environmentID:collectionID:headers:failure:success:)","abstract":"

Get collection details.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16updateCollectionySS13environmentID_SS010collectionF0SS4nameSSSg11descriptionAH013configurationF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"updateCollection(environmentID:collectionID:name:description:configurationID:headers:failure:success:)","abstract":"

Update a collection.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16deleteCollectionySS13environmentID_SS010collectionF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteD8ResponseVc7successtF":{"name":"deleteCollection(environmentID:collectionID:headers:failure:success:)","abstract":"

Delete a collection.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C20listCollectionFieldsySS13environmentID_SS010collectionG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA04ListdE8ResponseVc7successtF":{"name":"listCollectionFields(environmentID:collectionID:headers:failure:success:)","abstract":"

List collection fields.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14listExpansionsySS13environmentID_SS010collectionF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"listExpansions(environmentID:collectionID:headers:failure:success:)","abstract":"

Get the expansion list.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16createExpansionsySS13environmentID_SS010collectionF0SayAA9ExpansionVG10expansionss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D0Vc7successtF":{"name":"createExpansions(environmentID:collectionID:expansions:headers:failure:success:)","abstract":"

Create or update expansion list.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16deleteExpansionsySS13environmentID_SS010collectionF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteExpansions(environmentID:collectionID:headers:failure:success:)","abstract":"

Delete the expansion list.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C11addDocumentySS13environmentID_SS010collectionF010Foundation3URLVSg4fileSSSg8metadataAL0J11ContentTypes10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D8AcceptedVc7successtF":{"name":"addDocument(environmentID:collectionID:file:metadata:fileContentType:headers:failure:success:)","abstract":"

Add a document.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C17getDocumentStatusySS13environmentID_SS010collectionG0SS08documentG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"getDocumentStatus(environmentID:collectionID:documentID:headers:failure:success:)","abstract":"

Get document details.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14updateDocumentySS13environmentID_SS010collectionF0SS08documentF010Foundation3URLVSg4fileSSSg8metadataAM0K11ContentTypes10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D8AcceptedVc7successtF":{"name":"updateDocument(environmentID:collectionID:documentID:file:metadata:fileContentType:headers:failure:success:)","abstract":"

Update a document.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14deleteDocumentySS13environmentID_SS010collectionF0SS08documentF0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteD8ResponseVc7successtF":{"name":"deleteDocument(environmentID:collectionID:documentID:headers:failure:success:)","abstract":"

Delete a document.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C5queryySS13environmentID_SS010collectionE0SSSg6filterAgdG20naturalLanguageQuerySbSg8passagesAG11aggregationSiSg5countSaySSGSg12returnFieldsAM6offsetAP4sortAJ9highlightAP0kO0AM0K5CountAM0K10CharactersAJ11deduplicateAG0U5FieldAJ7similarAP0W11DocumentIdsAP0wO0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0J8ResponseVc7successtF":{"name":"query(environmentID:collectionID:filter:query:naturalLanguageQuery:passages:aggregation:count:returnFields:offset:sort:highlight:passagesFields:passagesCount:passagesCharacters:deduplicate:deduplicateField:similar:similarDocumentIds:similarFields:headers:failure:success:)","abstract":"

Query your collection.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C12queryNoticesySS13environmentID_SS010collectionF0SSSg6filterAG0C0AG20naturalLanguageQuerySbSg8passagesAG11aggregationSiSg5countSaySSGSg12returnFieldsAN6offsetAQ4sortAK9highlightAQ0lP0AN0L5CountAN0L10CharactersAG16deduplicateFieldAK7similarAQ0X11DocumentIdsAQ0xP0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0kD8ResponseVc7successtF":{"name":"queryNotices(environmentID:collectionID:filter:query:naturalLanguageQuery:passages:aggregation:count:returnFields:offset:sort:highlight:passagesFields:passagesCount:passagesCharacters:deduplicateField:similar:similarDocumentIds:similarFields:headers:failure:success:)","abstract":"

Query system notices.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14federatedQueryySS13environmentID_SaySSG13collectionIdsSSSg6filterAH5queryAH015naturalLanguageD0AH11aggregationSiSg5countAFSg12returnFieldsAM6offsetAO4sortSbSg9highlightAS11deduplicateAH0T5FieldAS7similarAO0v8DocumentH0AO0vP0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D8ResponseVc7successtF":{"name":"federatedQuery(environmentID:collectionIds:filter:query:naturalLanguageQuery:aggregation:count:returnFields:offset:sort:highlight:deduplicate:deduplicateField:similar:similarDocumentIds:similarFields:headers:failure:success:)","abstract":"

Query documents in multiple collections.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C21federatedQueryNoticesySS13environmentID_SaySSG13collectionIdsSSSg6filterAH5queryAH015naturalLanguageD0AH11aggregationSiSg5countAFSg12returnFieldsAM6offsetAO4sortSbSg9highlightAH16deduplicateFieldAS7similarAO0w8DocumentI0AO0wQ0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE8ResponseVc7successtF":{"name":"federatedQueryNotices(environmentID:collectionIds:filter:query:naturalLanguageQuery:aggregation:count:returnFields:offset:sort:highlight:deduplicateField:similar:similarDocumentIds:similarFields:headers:failure:success:)","abstract":"

Query multiple collection system notices.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C13queryEntitiesySS13environmentID_SS010collectionF0AA05QueryD0V06entityH0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0hD8ResponseVc7successtF":{"name":"queryEntities(environmentID:collectionID:entityQuery:headers:failure:success:)","abstract":"

Knowledge Graph entity query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14queryRelationsySS13environmentID_SS010collectionF0AA05QueryD0V012relationshipH0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0hD8ResponseVc7successtF":{"name":"queryRelations(environmentID:collectionID:relationshipQuery:headers:failure:success:)","abstract":"

Knowledge Graph relationship query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C16listTrainingDataySS13environmentID_SS010collectionG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE3SetVc7successtF":{"name":"listTrainingData(environmentID:collectionID:headers:failure:success:)","abstract":"

List training data.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C15addTrainingDataySS13environmentID_SS010collectionG0SSSg20naturalLanguageQueryAG6filterSayAA0D7ExampleVGSg8exampless10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dK0Vc7successtF":{"name":"addTrainingData(environmentID:collectionID:naturalLanguageQuery:filter:examples:headers:failure:success:)","abstract":"

Add query to training data.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C21deleteAllTrainingDataySS13environmentID_SS010collectionH0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteAllTrainingData(environmentID:collectionID:headers:failure:success:)","abstract":"

Delete all training data.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C15getTrainingDataySS13environmentID_SS010collectionG0SS05queryG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D5QueryVc7successtF":{"name":"getTrainingData(environmentID:collectionID:queryID:headers:failure:success:)","abstract":"

Get details about a query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C18deleteTrainingDataySS13environmentID_SS010collectionG0SS05queryG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteTrainingData(environmentID:collectionID:queryID:headers:failure:success:)","abstract":"

Delete a training data query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C20listTrainingExamplesySS13environmentID_SS010collectionG0SS05queryG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0D11ExampleListVc7successtF":{"name":"listTrainingExamples(environmentID:collectionID:queryID:headers:failure:success:)","abstract":"

List examples for a training data query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C21createTrainingExampleySS13environmentID_SS010collectionG0SS05queryG0SSSg08documentG0AH14crossReferenceSiSg9relevances10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"createTrainingExample(environmentID:collectionID:queryID:documentID:crossReference:relevance:headers:failure:success:)","abstract":"

Add example to training data query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C21deleteTrainingExampleySS13environmentID_SS010collectionG0SS05queryG0SS07exampleG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteTrainingExample(environmentID:collectionID:queryID:exampleID:headers:failure:success:)","abstract":"

Delete example for training data query.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C21updateTrainingExampleySS13environmentID_SS010collectionG0SS05queryG0SS07exampleG0SSSg14crossReferenceSiSg9relevances10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"updateTrainingExample(environmentID:collectionID:queryID:exampleID:crossReference:relevance:headers:failure:success:)","abstract":"

Change label or cross reference for example.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C18getTrainingExampleySS13environmentID_SS010collectionG0SS05queryG0SS07exampleG0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0dE0Vc7successtF":{"name":"getTrainingExample(environmentID:collectionID:queryID:exampleID:headers:failure:success:)","abstract":"

Get details for training data example.

","parent_name":"Discovery"},"Classes/Discovery.html#/s:11DiscoveryV10A0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

Delete labeled data.

","parent_name":"Discovery"},"Classes/Discovery.html":{"name":"Discovery","abstract":"

The IBM Watson™ Discovery Service is a cognitive search and content analytics engine that you can add to"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file diff --git a/docs/swift-api/services/DiscoveryV1/undocumented.json b/docs/swift-api/services/DiscoveryV1/undocumented.json index d3a452532..7d141a63f 100644 --- a/docs/swift-api/services/DiscoveryV1/undocumented.json +++ b/docs/swift-api/services/DiscoveryV1/undocumented.json @@ -9,126 +9,126 @@ }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Calculation.swift", - "line": 25, + "line": 27, "symbol": "Calculation.results", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Collection.swift", - "line": 24, + "line": 26, "symbol": "Collection.Status.active", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Collection.swift", - "line": 25, + "line": 27, "symbol": "Collection.Status.pending", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Collection.swift", - "line": 26, + "line": 28, "symbol": "Collection.Status.maintenance", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/CreateCollectionRequest.swift", - "line": 24, + "line": 26, "symbol": "CreateCollectionRequest.Language.en", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/CreateCollectionRequest.swift", - "line": 25, + "line": 27, "symbol": "CreateCollectionRequest.Language.es", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/CreateCollectionRequest.swift", - "line": 26, + "line": 28, "symbol": "CreateCollectionRequest.Language.de", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/CreateCollectionRequest.swift", - "line": 27, + "line": 29, "symbol": "CreateCollectionRequest.Language.ar", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/CreateCollectionRequest.swift", - "line": 28, + "line": 30, "symbol": "CreateCollectionRequest.Language.fr", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/CreateCollectionRequest.swift", - "line": 29, + "line": 31, "symbol": "CreateCollectionRequest.Language.it", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/CreateCollectionRequest.swift", - "line": 30, + "line": 32, "symbol": "CreateCollectionRequest.Language.ja", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/CreateCollectionRequest.swift", - "line": 31, + "line": 33, "symbol": "CreateCollectionRequest.Language.ko", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/CreateCollectionRequest.swift", - "line": 32, + "line": 34, "symbol": "CreateCollectionRequest.Language.pt", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DeleteCollectionResponse.swift", - "line": 24, + "line": 26, "symbol": "DeleteCollectionResponse.Status.deleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DeleteConfigurationResponse.swift", - "line": 24, + "line": 26, "symbol": "DeleteConfigurationResponse.Status.deleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DeleteDocumentResponse.swift", - "line": 24, + "line": 26, "symbol": "DeleteDocumentResponse.Status.deleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DeleteEnvironmentResponse.swift", - "line": 24, + "line": 26, "symbol": "DeleteEnvironmentResponse.Status.deleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DocumentAccepted.swift", - "line": 24, + "line": 26, "symbol": "DocumentAccepted.Status.processing", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" @@ -198,161 +198,161 @@ }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DocumentStatus.swift", - "line": 24, + "line": 26, "symbol": "DocumentStatus.Status.available", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DocumentStatus.swift", - "line": 25, + "line": 27, "symbol": "DocumentStatus.Status.availableWithNotices", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DocumentStatus.swift", - "line": 26, + "line": 28, "symbol": "DocumentStatus.Status.failed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DocumentStatus.swift", - "line": 27, + "line": 29, "symbol": "DocumentStatus.Status.processing", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DocumentStatus.swift", - "line": 32, + "line": 36, "symbol": "DocumentStatus.FileType.pdf", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DocumentStatus.swift", - "line": 33, + "line": 37, "symbol": "DocumentStatus.FileType.html", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DocumentStatus.swift", - "line": 34, + "line": 38, "symbol": "DocumentStatus.FileType.word", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DocumentStatus.swift", - "line": 35, + "line": 39, "symbol": "DocumentStatus.FileType.json", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Environment.swift", - "line": 24, + "line": 26, "symbol": "Environment.Status.active", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Environment.swift", - "line": 25, + "line": 27, "symbol": "Environment.Status.pending", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Environment.swift", - "line": 26, + "line": 28, "symbol": "Environment.Status.maintenance", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 24, + "line": 26, "symbol": "Field.FieldType.nested", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 25, + "line": 27, "symbol": "Field.FieldType.string", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 26, + "line": 28, "symbol": "Field.FieldType.date", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 27, + "line": 29, "symbol": "Field.FieldType.long", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 28, + "line": 30, "symbol": "Field.FieldType.integer", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 29, + "line": 31, "symbol": "Field.FieldType.short", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 30, + "line": 32, "symbol": "Field.FieldType.byte", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 31, + "line": 33, "symbol": "Field.FieldType.double", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 32, + "line": 34, "symbol": "Field.FieldType.float", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 33, + "line": 35, "symbol": "Field.FieldType.boolean", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 34, + "line": 36, "symbol": "Field.FieldType.binary", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Filter.swift", - "line": 25, + "line": 27, "symbol": "Filter.results", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" @@ -408,7 +408,7 @@ }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Histogram.swift", - "line": 25, + "line": 27, "symbol": "Histogram.results", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" @@ -457,56 +457,56 @@ }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Nested.swift", - "line": 25, + "line": 27, "symbol": "Nested.results", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/NormalizationOperation.swift", - "line": 29, + "line": 42, "symbol": "NormalizationOperation.Operation.copy", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/NormalizationOperation.swift", - "line": 30, + "line": 43, "symbol": "NormalizationOperation.Operation.move", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/NormalizationOperation.swift", - "line": 31, + "line": 44, "symbol": "NormalizationOperation.Operation.merge", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/NormalizationOperation.swift", - "line": 32, + "line": 45, "symbol": "NormalizationOperation.Operation.remove", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/NormalizationOperation.swift", - "line": 33, + "line": 46, "symbol": "NormalizationOperation.Operation.removeNulls", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Notice.swift", - "line": 24, + "line": 26, "symbol": "Notice.Severity.warning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Notice.swift", - "line": 25, + "line": 27, "symbol": "Notice.Severity.error", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" @@ -653,42 +653,42 @@ }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/QueryNoticesResult.swift", - "line": 24, + "line": 26, "symbol": "QueryNoticesResult.FileType.pdf", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/QueryNoticesResult.swift", - "line": 25, + "line": 27, "symbol": "QueryNoticesResult.FileType.html", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/QueryNoticesResult.swift", - "line": 26, + "line": 28, "symbol": "QueryNoticesResult.FileType.word", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/QueryNoticesResult.swift", - "line": 27, + "line": 29, "symbol": "QueryNoticesResult.FileType.json", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/QueryRelations.swift", - "line": 24, + "line": 27, "symbol": "QueryRelations.Sort.score", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/QueryRelations.swift", - "line": 25, + "line": 28, "symbol": "QueryRelations.Sort.frequency", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" @@ -744,35 +744,35 @@ }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Term.swift", - "line": 25, + "line": 27, "symbol": "Term.results", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Term.swift", - "line": 36, + "line": 44, "symbol": "Term.count", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Timeslice.swift", - "line": 25, + "line": 27, "symbol": "Timeslice.results", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/TopHits.swift", - "line": 25, + "line": 27, "symbol": "TopHits.results", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/TopHits.swift", - "line": 36, + "line": 44, "symbol": "TopHits.hits", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" diff --git a/docs/swift-api/services/LanguageTranslatorV2/Classes.html b/docs/swift-api/services/LanguageTranslatorV2/Classes.html index 3917c09a6..e9ab20723 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/Classes.html +++ b/docs/swift-api/services/LanguageTranslatorV2/Classes.html @@ -65,9 +65,6 @@ - @@ -113,7 +110,7 @@

Classes

-

IBM Watson Language Translator translates text from one language to another. The service offers multiple +

IBM Watson™ Language Translator translates text from one language to another. The service offers multiple domain-specific models that you can customize based on your unique terminology and language. Use Language Translator to take news from across the globe and present it in your language, communicate with your customers in their own language, and more.

@@ -136,7 +133,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/Classes/LanguageTranslator.html b/docs/swift-api/services/LanguageTranslatorV2/Classes/LanguageTranslator.html index 733ceb1b6..ce2cefadb 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/Classes/LanguageTranslator.html +++ b/docs/swift-api/services/LanguageTranslatorV2/Classes/LanguageTranslator.html @@ -65,9 +65,6 @@ - @@ -100,7 +97,7 @@

LanguageTranslator

-

IBM Watson Language Translator translates text from one language to another. The service offers multiple +

IBM Watson™ Language Translator translates text from one language to another. The service offers multiple domain-specific models that you can customize based on your unique terminology and language. Use Language Translator to take news from across the globe and present it in your language, communicate with your customers in their own language, and more.

@@ -735,9 +732,10 @@

Parameters

Create model.

-

Uploads a TMX glossary file on top of a domain to customize a translation model. Depending on the size of the -file, training can range from minutes for a glossary to several hours for a large parallel corpus. Glossary files -must be less than 10 MB. The cumulative file size of all uploaded glossary and corpus files is limited to 250 MB.

+

Uploads a TMX glossary file on top of a domain to customize a translation model. +Depending on the size of the file, training can range from minutes for a glossary to several hours for a large +parallel corpus. Glossary files must be less than 10 MB. The cumulative file size of all uploaded glossary and +corpus files is limited to 250 MB.

@@ -795,8 +793,8 @@

Parameters

A TMX file with your customizations. The customizations in the file completely overwrite the domain translaton -data, including high frequency or high confidence phrase translations. You can upload only one glossary with a file -size less than 10 MB per call.

+data, including high frequency or high confidence phrase translations. You can upload only one glossary with a +file size less than 10 MB per call.

@@ -1047,7 +1045,7 @@

Parameters

diff --git a/docs/swift-api/services/LanguageTranslatorV2/Enums.html b/docs/swift-api/services/LanguageTranslatorV2/Enums.html index d29751c3a..5ef02ce4b 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/Enums.html +++ b/docs/swift-api/services/LanguageTranslatorV2/Enums.html @@ -65,9 +65,6 @@ - @@ -165,7 +162,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/Enums/JSON.html b/docs/swift-api/services/LanguageTranslatorV2/Enums/JSON.html index 3a389ebbc..09e4f7adb 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/Enums/JSON.html +++ b/docs/swift-api/services/LanguageTranslatorV2/Enums/JSON.html @@ -65,9 +65,6 @@ - @@ -435,7 +432,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/Enums/RestError.html b/docs/swift-api/services/LanguageTranslatorV2/Enums/RestError.html index f7f127c42..bbc851cd8 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/Enums/RestError.html +++ b/docs/swift-api/services/LanguageTranslatorV2/Enums/RestError.html @@ -65,9 +65,6 @@ - @@ -302,7 +299,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/Structs.html b/docs/swift-api/services/LanguageTranslatorV2/Structs.html index dd14ab2dc..abcdbcc17 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/Structs.html +++ b/docs/swift-api/services/LanguageTranslatorV2/Structs.html @@ -65,9 +65,6 @@ - @@ -418,49 +415,10 @@

Declaration

-
-
- - - -

JSON

-
-
-
    -
  • -
    - - - - JSONWrapper - -
    -
    -
    -
    -
    -
    -

    Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct JSONWrapper
    - -
    -
    -
    -
    -
  • -
-
diff --git a/docs/swift-api/services/LanguageTranslatorV2/Structs/DeleteModelResult.html b/docs/swift-api/services/LanguageTranslatorV2/Structs/DeleteModelResult.html index 0f779ab08..7b8adecb1 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/Structs/DeleteModelResult.html +++ b/docs/swift-api/services/LanguageTranslatorV2/Structs/DeleteModelResult.html @@ -65,9 +65,6 @@ - @@ -138,7 +135,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/Structs/IdentifiableLanguage.html b/docs/swift-api/services/LanguageTranslatorV2/Structs/IdentifiableLanguage.html index d00d59150..8957f234a 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/Structs/IdentifiableLanguage.html +++ b/docs/swift-api/services/LanguageTranslatorV2/Structs/IdentifiableLanguage.html @@ -65,9 +65,6 @@ - @@ -165,7 +162,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/Structs/IdentifiableLanguages.html b/docs/swift-api/services/LanguageTranslatorV2/Structs/IdentifiableLanguages.html index cbf0c4d3b..540191ff3 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/Structs/IdentifiableLanguages.html +++ b/docs/swift-api/services/LanguageTranslatorV2/Structs/IdentifiableLanguages.html @@ -65,9 +65,6 @@ - @@ -138,7 +135,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/Structs/IdentifiedLanguage.html b/docs/swift-api/services/LanguageTranslatorV2/Structs/IdentifiedLanguage.html index adeb0637b..d1ffad8a9 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/Structs/IdentifiedLanguage.html +++ b/docs/swift-api/services/LanguageTranslatorV2/Structs/IdentifiedLanguage.html @@ -65,9 +65,6 @@ - @@ -165,7 +162,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/Structs/IdentifiedLanguages.html b/docs/swift-api/services/LanguageTranslatorV2/Structs/IdentifiedLanguages.html index da27bd713..b7053ccc7 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/Structs/IdentifiedLanguages.html +++ b/docs/swift-api/services/LanguageTranslatorV2/Structs/IdentifiedLanguages.html @@ -65,9 +65,6 @@ - @@ -138,7 +135,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/Structs/TranslateRequest.html b/docs/swift-api/services/LanguageTranslatorV2/Structs/TranslateRequest.html index 12c510efe..8baf927bc 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/Structs/TranslateRequest.html +++ b/docs/swift-api/services/LanguageTranslatorV2/Structs/TranslateRequest.html @@ -65,9 +65,6 @@ - @@ -146,7 +143,8 @@

Declaration

-

Model ID of the translation model to use. If this is specified, the source and target parameters will be ignored. The method requires either a model ID or both the source and target parameters.

+

Model ID of the translation model to use. If this is specified, the source and target parameters will be +ignored. The method requires either a model ID or both the source and target parameters.

@@ -173,7 +171,9 @@

Declaration

-

Language code of the source text language. Use with target as an alternative way to select a translation model. When source and target are set, and a model ID is not set, the system chooses a default model for the language pair (usually the model based on the news domain).

+

Language code of the source text language. Use with target as an alternative way to select a translation model. +When source and target are set, and a model ID is not set, the system chooses a default model for the language +pair (usually the model based on the news domain).

@@ -200,7 +200,8 @@

Declaration

-

Language code of the translation target language. Use with source as an alternative way to select a translation model.

+

Language code of the translation target language. Use with source as an alternative way to select a translation +model.

@@ -234,7 +235,12 @@

Declaration

Declaration

Swift

-
public init(text: [String], modelID: String? = nil, source: String? = nil, target: String? = nil)
+
public init(
+    text: [String],
+    modelID: String? = nil,
+    source: String? = nil,
+    target: String? = nil
+)
@@ -262,7 +268,8 @@

Parameters

-

Model ID of the translation model to use. If this is specified, the source and target parameters will be ignored. The method requires either a model ID or both the source and target parameters.

+

Model ID of the translation model to use. If this is specified, the source and target parameters will be +ignored. The method requires either a model ID or both the source and target parameters.

@@ -274,7 +281,9 @@

Parameters

-

Language code of the source text language. Use with target as an alternative way to select a translation model. When source and target are set, and a model ID is not set, the system chooses a default model for the language pair (usually the model based on the news domain).

+

Language code of the source text language. Use with target as an alternative way to select a translation model. +When source and target are set, and a model ID is not set, the system chooses a default model for the +language pair (usually the model based on the news domain).

@@ -286,7 +295,8 @@

Parameters

-

Language code of the translation target language. Use with source as an alternative way to select a translation model.

+

Language code of the translation target language. Use with source as an alternative way to select a translation +model.

@@ -305,7 +315,7 @@

Return Value

diff --git a/docs/swift-api/services/LanguageTranslatorV2/Structs/Translation.html b/docs/swift-api/services/LanguageTranslatorV2/Structs/Translation.html index d8ea8c1a8..b5297da06 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/Structs/Translation.html +++ b/docs/swift-api/services/LanguageTranslatorV2/Structs/Translation.html @@ -65,9 +65,6 @@ - @@ -138,7 +135,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/Structs/TranslationModel.html b/docs/swift-api/services/LanguageTranslatorV2/Structs/TranslationModel.html index 120c4df42..9a9005699 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/Structs/TranslationModel.html +++ b/docs/swift-api/services/LanguageTranslatorV2/Structs/TranslationModel.html @@ -65,9 +65,6 @@ - @@ -255,7 +252,8 @@

Declaration

-

Model ID of the base model that was used to customize the model. If the model is not a custom model, this will be an empty string.

+

Model ID of the base model that was used to customize the model. If the model is not a custom model, this will be +an empty string.

@@ -309,7 +307,8 @@

Declaration

-

Whether this model can be used as a base for customization. Customized models are not further customizable, and some base models are not customizable.

+

Whether this model can be used as a base for customization. Customized models are not further customizable, and +some base models are not customizable.

@@ -336,7 +335,8 @@

Declaration

-

Whether or not the model is a default model. A default model is the model for a given language pair that will be used when that language pair is specified in the source and target parameters.

+

Whether or not the model is a default model. A default model is the model for a given language pair that will be +used when that language pair is specified in the source and target parameters.

@@ -363,7 +363,8 @@

Declaration

-

Either an empty string, indicating the model is not a custom model, or the ID of the service instance that created the model.

+

Either an empty string, indicating the model is not a custom model, or the ID of the service instance that created +the model.

@@ -409,7 +410,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/Structs/TranslationModel/Status.html b/docs/swift-api/services/LanguageTranslatorV2/Structs/TranslationModel/Status.html index 7e2f3cfcc..162bf525b 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/Structs/TranslationModel/Status.html +++ b/docs/swift-api/services/LanguageTranslatorV2/Structs/TranslationModel/Status.html @@ -65,9 +65,6 @@ - @@ -381,7 +378,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/Structs/TranslationModels.html b/docs/swift-api/services/LanguageTranslatorV2/Structs/TranslationModels.html index 03a9b1b5d..dbf0059dd 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/Structs/TranslationModels.html +++ b/docs/swift-api/services/LanguageTranslatorV2/Structs/TranslationModels.html @@ -65,9 +65,6 @@ - @@ -138,7 +135,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/Structs/TranslationResult.html b/docs/swift-api/services/LanguageTranslatorV2/Structs/TranslationResult.html index 276b83701..21030fb69 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/Structs/TranslationResult.html +++ b/docs/swift-api/services/LanguageTranslatorV2/Structs/TranslationResult.html @@ -65,9 +65,6 @@ - @@ -192,7 +189,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Classes.html b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Classes.html index 3917c09a6..e9ab20723 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Classes.html +++ b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Classes.html @@ -65,9 +65,6 @@ - @@ -113,7 +110,7 @@

Classes

-

IBM Watson Language Translator translates text from one language to another. The service offers multiple +

IBM Watson™ Language Translator translates text from one language to another. The service offers multiple domain-specific models that you can customize based on your unique terminology and language. Use Language Translator to take news from across the globe and present it in your language, communicate with your customers in their own language, and more.

@@ -136,7 +133,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Classes/LanguageTranslator.html b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Classes/LanguageTranslator.html index 733ceb1b6..ce2cefadb 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Classes/LanguageTranslator.html +++ b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Classes/LanguageTranslator.html @@ -65,9 +65,6 @@ - @@ -100,7 +97,7 @@

LanguageTranslator

-

IBM Watson Language Translator translates text from one language to another. The service offers multiple +

IBM Watson™ Language Translator translates text from one language to another. The service offers multiple domain-specific models that you can customize based on your unique terminology and language. Use Language Translator to take news from across the globe and present it in your language, communicate with your customers in their own language, and more.

@@ -735,9 +732,10 @@

Parameters

Create model.

-

Uploads a TMX glossary file on top of a domain to customize a translation model. Depending on the size of the -file, training can range from minutes for a glossary to several hours for a large parallel corpus. Glossary files -must be less than 10 MB. The cumulative file size of all uploaded glossary and corpus files is limited to 250 MB.

+

Uploads a TMX glossary file on top of a domain to customize a translation model. +Depending on the size of the file, training can range from minutes for a glossary to several hours for a large +parallel corpus. Glossary files must be less than 10 MB. The cumulative file size of all uploaded glossary and +corpus files is limited to 250 MB.

@@ -795,8 +793,8 @@

Parameters

A TMX file with your customizations. The customizations in the file completely overwrite the domain translaton -data, including high frequency or high confidence phrase translations. You can upload only one glossary with a file -size less than 10 MB per call.

+data, including high frequency or high confidence phrase translations. You can upload only one glossary with a +file size less than 10 MB per call.

@@ -1047,7 +1045,7 @@

Parameters

diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Enums.html b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Enums.html index d29751c3a..5ef02ce4b 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Enums.html +++ b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Enums.html @@ -65,9 +65,6 @@ - @@ -165,7 +162,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html index 3a389ebbc..09e4f7adb 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html +++ b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html @@ -65,9 +65,6 @@ - @@ -435,7 +432,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html index f7f127c42..bbc851cd8 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html +++ b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html @@ -65,9 +65,6 @@ - @@ -302,7 +299,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs.html b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs.html index dd14ab2dc..abcdbcc17 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs.html +++ b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs.html @@ -65,9 +65,6 @@ - @@ -418,49 +415,10 @@

Declaration

-
-
- - - -

JSON

-
-
-
    -
  • -
    - - - - JSONWrapper - -
    -
    -
    -
    -
    -
    -

    Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct JSONWrapper
    - -
    -
    -
    -
    -
  • -
-
diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/DeleteModelResult.html b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/DeleteModelResult.html index 0f779ab08..7b8adecb1 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/DeleteModelResult.html +++ b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/DeleteModelResult.html @@ -65,9 +65,6 @@ - @@ -138,7 +135,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/IdentifiableLanguage.html b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/IdentifiableLanguage.html index d00d59150..8957f234a 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/IdentifiableLanguage.html +++ b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/IdentifiableLanguage.html @@ -65,9 +65,6 @@ - @@ -165,7 +162,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/IdentifiableLanguages.html b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/IdentifiableLanguages.html index cbf0c4d3b..540191ff3 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/IdentifiableLanguages.html +++ b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/IdentifiableLanguages.html @@ -65,9 +65,6 @@ - @@ -138,7 +135,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/IdentifiedLanguage.html b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/IdentifiedLanguage.html index adeb0637b..d1ffad8a9 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/IdentifiedLanguage.html +++ b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/IdentifiedLanguage.html @@ -65,9 +65,6 @@ - @@ -165,7 +162,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/IdentifiedLanguages.html b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/IdentifiedLanguages.html index da27bd713..b7053ccc7 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/IdentifiedLanguages.html +++ b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/IdentifiedLanguages.html @@ -65,9 +65,6 @@ - @@ -138,7 +135,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/TranslateRequest.html b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/TranslateRequest.html index 12c510efe..8baf927bc 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/TranslateRequest.html +++ b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/TranslateRequest.html @@ -65,9 +65,6 @@ - @@ -146,7 +143,8 @@

Declaration

-

Model ID of the translation model to use. If this is specified, the source and target parameters will be ignored. The method requires either a model ID or both the source and target parameters.

+

Model ID of the translation model to use. If this is specified, the source and target parameters will be +ignored. The method requires either a model ID or both the source and target parameters.

@@ -173,7 +171,9 @@

Declaration

-

Language code of the source text language. Use with target as an alternative way to select a translation model. When source and target are set, and a model ID is not set, the system chooses a default model for the language pair (usually the model based on the news domain).

+

Language code of the source text language. Use with target as an alternative way to select a translation model. +When source and target are set, and a model ID is not set, the system chooses a default model for the language +pair (usually the model based on the news domain).

@@ -200,7 +200,8 @@

Declaration

-

Language code of the translation target language. Use with source as an alternative way to select a translation model.

+

Language code of the translation target language. Use with source as an alternative way to select a translation +model.

@@ -234,7 +235,12 @@

Declaration

Declaration

Swift

-
public init(text: [String], modelID: String? = nil, source: String? = nil, target: String? = nil)
+
public init(
+    text: [String],
+    modelID: String? = nil,
+    source: String? = nil,
+    target: String? = nil
+)
@@ -262,7 +268,8 @@

Parameters

-

Model ID of the translation model to use. If this is specified, the source and target parameters will be ignored. The method requires either a model ID or both the source and target parameters.

+

Model ID of the translation model to use. If this is specified, the source and target parameters will be +ignored. The method requires either a model ID or both the source and target parameters.

@@ -274,7 +281,9 @@

Parameters

-

Language code of the source text language. Use with target as an alternative way to select a translation model. When source and target are set, and a model ID is not set, the system chooses a default model for the language pair (usually the model based on the news domain).

+

Language code of the source text language. Use with target as an alternative way to select a translation model. +When source and target are set, and a model ID is not set, the system chooses a default model for the +language pair (usually the model based on the news domain).

@@ -286,7 +295,8 @@

Parameters

-

Language code of the translation target language. Use with source as an alternative way to select a translation model.

+

Language code of the translation target language. Use with source as an alternative way to select a translation +model.

@@ -305,7 +315,7 @@

Return Value

diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/Translation.html b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/Translation.html index d8ea8c1a8..b5297da06 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/Translation.html +++ b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/Translation.html @@ -65,9 +65,6 @@ - @@ -138,7 +135,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/TranslationModel.html b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/TranslationModel.html index 120c4df42..9a9005699 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/TranslationModel.html +++ b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/TranslationModel.html @@ -65,9 +65,6 @@ - @@ -255,7 +252,8 @@

Declaration

-

Model ID of the base model that was used to customize the model. If the model is not a custom model, this will be an empty string.

+

Model ID of the base model that was used to customize the model. If the model is not a custom model, this will be +an empty string.

@@ -309,7 +307,8 @@

Declaration

-

Whether this model can be used as a base for customization. Customized models are not further customizable, and some base models are not customizable.

+

Whether this model can be used as a base for customization. Customized models are not further customizable, and +some base models are not customizable.

@@ -336,7 +335,8 @@

Declaration

-

Whether or not the model is a default model. A default model is the model for a given language pair that will be used when that language pair is specified in the source and target parameters.

+

Whether or not the model is a default model. A default model is the model for a given language pair that will be +used when that language pair is specified in the source and target parameters.

@@ -363,7 +363,8 @@

Declaration

-

Either an empty string, indicating the model is not a custom model, or the ID of the service instance that created the model.

+

Either an empty string, indicating the model is not a custom model, or the ID of the service instance that created +the model.

@@ -409,7 +410,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/TranslationModel/Status.html b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/TranslationModel/Status.html index 7e2f3cfcc..162bf525b 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/TranslationModel/Status.html +++ b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/TranslationModel/Status.html @@ -65,9 +65,6 @@ - @@ -381,7 +378,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/TranslationModels.html b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/TranslationModels.html index 03a9b1b5d..dbf0059dd 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/TranslationModels.html +++ b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/TranslationModels.html @@ -65,9 +65,6 @@ - @@ -138,7 +135,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/TranslationResult.html b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/TranslationResult.html index 276b83701..21030fb69 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/TranslationResult.html +++ b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/Structs/TranslationResult.html @@ -65,9 +65,6 @@ - @@ -192,7 +189,7 @@

Declaration

diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/index.html b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/index.html index b7ccd7063..c7ac8048c 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/index.html +++ b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/index.html @@ -64,9 +64,6 @@ - @@ -133,7 +130,8 @@

Services

  • Assistant
  • Discovery
  • -
  • Language Translator
  • +
  • Language Translator V2
  • +
  • Language Translator V3
  • Natural Language Classifier
  • Natural Language Understanding
  • Personality Insights
  • @@ -178,7 +176,7 @@

    Swift Package Manager

    Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

    dependencies: [
    -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
    +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
     ]
     

    Service Instances

    @@ -221,7 +219,7 @@

    Username and Password

    API Key

    -

    Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

    +

    Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

    let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
     

    Using IAM

    @@ -456,7 +454,12 @@

    Private Data Collections

  • IBM Discovery - Documentation
  • IBM Discovery - Demo
-

Language Translator

+

Language Translator V2

+ +

Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

@@ -467,6 +470,25 @@

Language Translator

let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} + +

Language Translator V3

+ +

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

+ +

The following example demonstrates how to use the Language Translator service:

+
import LanguageTranslatorV3
+
+let username = "your-username-here"
+let password = "your-password-here"
+let version = "yyyy-mm-dd" // use today's date for the most recent version
+let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
+
 let failure = { (error: Error) in print(error) }
 let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
 languageTranslator.translate(request: request, failure: failure) {
@@ -857,7 +879,7 @@ 

Visual Recognition

let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -865,6 +887,10 @@

Visual Recognition

print(classifiedImages) }
+ +

Note: a different initializer is used for authentication with instances created before May 23, 2018:

+
let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
+

Using Core ML

The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

@@ -916,7 +942,7 @@

Bundlin diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/search.json b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/search.json index 04b486720..ac9dc3f1f 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/search.json +++ b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/Documents/search.json @@ -1 +1 @@ -{"Structs/TranslationResult.html#/s:20LanguageTranslatorV217TranslationResultV9wordCountSivp":{"name":"wordCount","abstract":"

Number of words in the input text.

","parent_name":"TranslationResult"},"Structs/TranslationResult.html#/s:20LanguageTranslatorV217TranslationResultV14characterCountSivp":{"name":"characterCount","abstract":"

Number of characters in the input text.

","parent_name":"TranslationResult"},"Structs/TranslationResult.html#/s:20LanguageTranslatorV217TranslationResultV12translationsSayAA0D0VGvp":{"name":"translations","abstract":"

List of translation output in UTF-8, corresponding to the input text entries.

","parent_name":"TranslationResult"},"Structs/TranslationModels.html#/s:20LanguageTranslatorV217TranslationModelsV6modelsSayAA0D5ModelVGvp":{"name":"models","abstract":"

An array of available models.

","parent_name":"TranslationModels"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO9uploadingA2EmF":{"name":"uploading","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO8uploadedA2EmF":{"name":"uploaded","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO11dispatchingA2EmF":{"name":"dispatching","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO6queuedA2EmF":{"name":"queued","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO8trainingA2EmF":{"name":"training","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO7trainedA2EmF":{"name":"trained","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO10publishingA2EmF":{"name":"publishing","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO9availableA2EmF":{"name":"available","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO7deletedA2EmF":{"name":"deleted","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO5errorA2EmF":{"name":"error","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html":{"name":"Status","abstract":"

Availability of a model.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV7modelIDSSvp":{"name":"modelID","abstract":"

A globally unique string that identifies the underlying model that is used for translation.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV4nameSSSgvp":{"name":"name","abstract":"

Optional name that can be specified when the model is created.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV6sourceSSSgvp":{"name":"source","abstract":"

Translation source language code.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV6targetSSSgvp":{"name":"target","abstract":"

Translation target language code.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV04baseE2IDSSSgvp":{"name":"baseModelID","abstract":"

Model ID of the base model that was used to customize the model. If the model is not a custom model, this will be an empty string.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV6domainSSSgvp":{"name":"domain","abstract":"

The domain of the translation model.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV12customizableSbSgvp":{"name":"customizable","abstract":"

Whether this model can be used as a base for customization. Customized models are not further customizable, and some base models are not customizable.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV07defaultE0SbSgvp":{"name":"defaultModel","abstract":"

Whether or not the model is a default model. A default model is the model for a given language pair that will be used when that language pair is specified in the source and target parameters.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV5ownerSSSgvp":{"name":"owner","abstract":"

Either an empty string, indicating the model is not a custom model, or the ID of the service instance that created the model.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV6statusSSSgvp":{"name":"status","abstract":"

Availability of a model.

","parent_name":"TranslationModel"},"Structs/Translation.html#/s:20LanguageTranslatorV211TranslationV17translationOutputSSvp":{"name":"translationOutput","abstract":"

Translation output in UTF-8.

","parent_name":"Translation"},"Structs/TranslateRequest.html#/s:20LanguageTranslatorV216TranslateRequestV4textSaySSGvp":{"name":"text","abstract":"

Input text in UTF-8 encoding. Multiple entries will result in multiple translations in the response.

","parent_name":"TranslateRequest"},"Structs/TranslateRequest.html#/s:20LanguageTranslatorV216TranslateRequestV7modelIDSSSgvp":{"name":"modelID","abstract":"

Model ID of the translation model to use. If this is specified, the source and target parameters will be ignored. The method requires either a model ID or both the source and target parameters.

","parent_name":"TranslateRequest"},"Structs/TranslateRequest.html#/s:20LanguageTranslatorV216TranslateRequestV6sourceSSSgvp":{"name":"source","abstract":"

Language code of the source text language. Use with target as an alternative way to select a translation model. When source and target are set, and a model ID is not set, the system chooses a default model for the language pair (usually the model based on the news domain).

","parent_name":"TranslateRequest"},"Structs/TranslateRequest.html#/s:20LanguageTranslatorV216TranslateRequestV6targetSSSgvp":{"name":"target","abstract":"

Language code of the translation target language. Use with source as an alternative way to select a translation model.

","parent_name":"TranslateRequest"},"Structs/TranslateRequest.html#/s:20LanguageTranslatorV216TranslateRequestVACSaySSG4text_SSSg7modelIDAF6sourceAF6targettcfc":{"name":"init(text:modelID:source:target:)","abstract":"

Initialize a TranslateRequest with member variables.

","parent_name":"TranslateRequest"},"Structs/IdentifiedLanguages.html#/s:20LanguageTranslatorV219IdentifiedLanguagesV9languagesSayAA0dA0VGvp":{"name":"languages","abstract":"

A ranking of identified languages with confidence scores.

","parent_name":"IdentifiedLanguages"},"Structs/IdentifiedLanguage.html#/s:20LanguageTranslatorV2010IdentifiedA0V8languageSSvp":{"name":"language","abstract":"

The language code for an identified language.

","parent_name":"IdentifiedLanguage"},"Structs/IdentifiedLanguage.html#/s:20LanguageTranslatorV2010IdentifiedA0V10confidenceSdvp":{"name":"confidence","abstract":"

The confidence score for the identified language.

","parent_name":"IdentifiedLanguage"},"Structs/IdentifiableLanguages.html#/s:20LanguageTranslatorV221IdentifiableLanguagesV9languagesSayAA0dA0VGvp":{"name":"languages","abstract":"

A list of all languages that the service can identify.

","parent_name":"IdentifiableLanguages"},"Structs/IdentifiableLanguage.html#/s:20LanguageTranslatorV2012IdentifiableA0V8languageSSvp":{"name":"language","abstract":"

The language code for an identifiable language.

","parent_name":"IdentifiableLanguage"},"Structs/IdentifiableLanguage.html#/s:20LanguageTranslatorV2012IdentifiableA0V4nameSSvp":{"name":"name","abstract":"

The name of the identifiable language.

","parent_name":"IdentifiableLanguage"},"Structs/DeleteModelResult.html#/s:20LanguageTranslatorV217DeleteModelResultV6statusSSvp":{"name":"status","abstract":"

OK indicates that the model was successfully deleted.

","parent_name":"DeleteModelResult"},"Structs/DeleteModelResult.html":{"name":"DeleteModelResult","abstract":"

DeleteModelResult.

"},"Structs/IdentifiableLanguage.html":{"name":"IdentifiableLanguage","abstract":"

IdentifiableLanguage.

"},"Structs/IdentifiableLanguages.html":{"name":"IdentifiableLanguages","abstract":"

IdentifiableLanguages.

"},"Structs/IdentifiedLanguage.html":{"name":"IdentifiedLanguage","abstract":"

IdentifiedLanguage.

"},"Structs/IdentifiedLanguages.html":{"name":"IdentifiedLanguages","abstract":"

IdentifiedLanguages.

"},"Structs/TranslateRequest.html":{"name":"TranslateRequest","abstract":"

TranslateRequest.

"},"Structs/Translation.html":{"name":"Translation","abstract":"

Translation.

"},"Structs/TranslationModel.html":{"name":"TranslationModel","abstract":"

Response payload for models.

"},"Structs/TranslationModels.html":{"name":"TranslationModels","abstract":"

The response type for listing existing translation models.

"},"Structs/TranslationResult.html":{"name":"TranslationResult","abstract":"

TranslationResult.

"},"Structs.html#/s:20LanguageTranslatorV211JSONWrapperV":{"name":"JSONWrapper","abstract":"

Used internally to serialize and deserialize JSON."},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO013serializationE0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO08encodingE0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO011fileManagerE0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0CACSS8username_SS8passwordtcfc":{"name":"init(username:password:)","abstract":"

Create a LanguageTranslator object.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a LanguageTranslator object.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a LanguageTranslator object.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C9translateyAA16TranslateRequestV7request_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA17TranslationResultVc7successtF":{"name":"translate(request:headers:failure:success:)","abstract":"

Translate.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C25listIdentifiableLanguagesys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA0eF0Vc7successtF":{"name":"listIdentifiableLanguages(headers:failure:success:)","abstract":"

List identifiable languages.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C8identifyySS4text_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA19IdentifiedLanguagesVc7successtF":{"name":"identify(text:headers:failure:success:)","abstract":"

Identify language.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C10listModelsySSSg6source_AE6targetSbSg07defaultE0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA011TranslationE0Vc7successtF":{"name":"listModels(source:target:defaultModels:headers:failure:success:)","abstract":"

List models.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C11createModelySS04baseE2ID_SSSg4name10Foundation3URLVSg14forcedGlossaryAK14parallelCorpusAK011monolingualN0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA011TranslationE0Vc7successtF":{"name":"createModel(baseModelID:name:forcedGlossary:parallelCorpus:monolingualCorpus:headers:failure:success:)","abstract":"

Create model.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C11deleteModelySS7modelID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteE6ResultVc7successtF":{"name":"deleteModel(modelID:headers:failure:success:)","abstract":"

Delete model.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C8getModelySS7modelID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA011TranslationE0Vc7successtF":{"name":"getModel(modelID:headers:failure:success:)","abstract":"

Get model details.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html":{"name":"LanguageTranslator","abstract":"

IBM Watson Language Translator translates text from one language to another. The service offers multiple"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file +{"Structs/TranslationResult.html#/s:20LanguageTranslatorV217TranslationResultV9wordCountSivp":{"name":"wordCount","abstract":"

Number of words in the input text.

","parent_name":"TranslationResult"},"Structs/TranslationResult.html#/s:20LanguageTranslatorV217TranslationResultV14characterCountSivp":{"name":"characterCount","abstract":"

Number of characters in the input text.

","parent_name":"TranslationResult"},"Structs/TranslationResult.html#/s:20LanguageTranslatorV217TranslationResultV12translationsSayAA0D0VGvp":{"name":"translations","abstract":"

List of translation output in UTF-8, corresponding to the input text entries.

","parent_name":"TranslationResult"},"Structs/TranslationModels.html#/s:20LanguageTranslatorV217TranslationModelsV6modelsSayAA0D5ModelVGvp":{"name":"models","abstract":"

An array of available models.

","parent_name":"TranslationModels"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO9uploadingA2EmF":{"name":"uploading","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO8uploadedA2EmF":{"name":"uploaded","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO11dispatchingA2EmF":{"name":"dispatching","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO6queuedA2EmF":{"name":"queued","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO8trainingA2EmF":{"name":"training","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO7trainedA2EmF":{"name":"trained","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO10publishingA2EmF":{"name":"publishing","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO9availableA2EmF":{"name":"available","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO7deletedA2EmF":{"name":"deleted","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO5errorA2EmF":{"name":"error","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html":{"name":"Status","abstract":"

Availability of a model.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV7modelIDSSvp":{"name":"modelID","abstract":"

A globally unique string that identifies the underlying model that is used for translation.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV4nameSSSgvp":{"name":"name","abstract":"

Optional name that can be specified when the model is created.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV6sourceSSSgvp":{"name":"source","abstract":"

Translation source language code.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV6targetSSSgvp":{"name":"target","abstract":"

Translation target language code.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV04baseE2IDSSSgvp":{"name":"baseModelID","abstract":"

Model ID of the base model that was used to customize the model. If the model is not a custom model, this will be","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV6domainSSSgvp":{"name":"domain","abstract":"

The domain of the translation model.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV12customizableSbSgvp":{"name":"customizable","abstract":"

Whether this model can be used as a base for customization. Customized models are not further customizable, and","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV07defaultE0SbSgvp":{"name":"defaultModel","abstract":"

Whether or not the model is a default model. A default model is the model for a given language pair that will be","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV5ownerSSSgvp":{"name":"owner","abstract":"

Either an empty string, indicating the model is not a custom model, or the ID of the service instance that created","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV6statusSSSgvp":{"name":"status","abstract":"

Availability of a model.

","parent_name":"TranslationModel"},"Structs/Translation.html#/s:20LanguageTranslatorV211TranslationV17translationOutputSSvp":{"name":"translationOutput","abstract":"

Translation output in UTF-8.

","parent_name":"Translation"},"Structs/TranslateRequest.html#/s:20LanguageTranslatorV216TranslateRequestV4textSaySSGvp":{"name":"text","abstract":"

Input text in UTF-8 encoding. Multiple entries will result in multiple translations in the response.

","parent_name":"TranslateRequest"},"Structs/TranslateRequest.html#/s:20LanguageTranslatorV216TranslateRequestV7modelIDSSSgvp":{"name":"modelID","abstract":"

Model ID of the translation model to use. If this is specified, the source and target parameters will be","parent_name":"TranslateRequest"},"Structs/TranslateRequest.html#/s:20LanguageTranslatorV216TranslateRequestV6sourceSSSgvp":{"name":"source","abstract":"

Language code of the source text language. Use with target as an alternative way to select a translation model.","parent_name":"TranslateRequest"},"Structs/TranslateRequest.html#/s:20LanguageTranslatorV216TranslateRequestV6targetSSSgvp":{"name":"target","abstract":"

Language code of the translation target language. Use with source as an alternative way to select a translation","parent_name":"TranslateRequest"},"Structs/TranslateRequest.html#/s:20LanguageTranslatorV216TranslateRequestVACSaySSG4text_SSSg7modelIDAF6sourceAF6targettcfc":{"name":"init(text:modelID:source:target:)","abstract":"

Initialize a TranslateRequest with member variables.

","parent_name":"TranslateRequest"},"Structs/IdentifiedLanguages.html#/s:20LanguageTranslatorV219IdentifiedLanguagesV9languagesSayAA0dA0VGvp":{"name":"languages","abstract":"

A ranking of identified languages with confidence scores.

","parent_name":"IdentifiedLanguages"},"Structs/IdentifiedLanguage.html#/s:20LanguageTranslatorV2010IdentifiedA0V8languageSSvp":{"name":"language","abstract":"

The language code for an identified language.

","parent_name":"IdentifiedLanguage"},"Structs/IdentifiedLanguage.html#/s:20LanguageTranslatorV2010IdentifiedA0V10confidenceSdvp":{"name":"confidence","abstract":"

The confidence score for the identified language.

","parent_name":"IdentifiedLanguage"},"Structs/IdentifiableLanguages.html#/s:20LanguageTranslatorV221IdentifiableLanguagesV9languagesSayAA0dA0VGvp":{"name":"languages","abstract":"

A list of all languages that the service can identify.

","parent_name":"IdentifiableLanguages"},"Structs/IdentifiableLanguage.html#/s:20LanguageTranslatorV2012IdentifiableA0V8languageSSvp":{"name":"language","abstract":"

The language code for an identifiable language.

","parent_name":"IdentifiableLanguage"},"Structs/IdentifiableLanguage.html#/s:20LanguageTranslatorV2012IdentifiableA0V4nameSSvp":{"name":"name","abstract":"

The name of the identifiable language.

","parent_name":"IdentifiableLanguage"},"Structs/DeleteModelResult.html#/s:20LanguageTranslatorV217DeleteModelResultV6statusSSvp":{"name":"status","abstract":"

OK indicates that the model was successfully deleted.

","parent_name":"DeleteModelResult"},"Structs/DeleteModelResult.html":{"name":"DeleteModelResult","abstract":"

DeleteModelResult.

"},"Structs/IdentifiableLanguage.html":{"name":"IdentifiableLanguage","abstract":"

IdentifiableLanguage.

"},"Structs/IdentifiableLanguages.html":{"name":"IdentifiableLanguages","abstract":"

IdentifiableLanguages.

"},"Structs/IdentifiedLanguage.html":{"name":"IdentifiedLanguage","abstract":"

IdentifiedLanguage.

"},"Structs/IdentifiedLanguages.html":{"name":"IdentifiedLanguages","abstract":"

IdentifiedLanguages.

"},"Structs/TranslateRequest.html":{"name":"TranslateRequest","abstract":"

TranslateRequest.

"},"Structs/Translation.html":{"name":"Translation","abstract":"

Translation.

"},"Structs/TranslationModel.html":{"name":"TranslationModel","abstract":"

Response payload for models.

"},"Structs/TranslationModels.html":{"name":"TranslationModels","abstract":"

The response type for listing existing translation models.

"},"Structs/TranslationResult.html":{"name":"TranslationResult","abstract":"

TranslationResult.

"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO013serializationE0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO08encodingE0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO011fileManagerE0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0CACSS8username_SS8passwordtcfc":{"name":"init(username:password:)","abstract":"

Create a LanguageTranslator object.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a LanguageTranslator object.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a LanguageTranslator object.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C9translateyAA16TranslateRequestV7request_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA17TranslationResultVc7successtF":{"name":"translate(request:headers:failure:success:)","abstract":"

Translate.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C25listIdentifiableLanguagesys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA0eF0Vc7successtF":{"name":"listIdentifiableLanguages(headers:failure:success:)","abstract":"

List identifiable languages.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C8identifyySS4text_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA19IdentifiedLanguagesVc7successtF":{"name":"identify(text:headers:failure:success:)","abstract":"

Identify language.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C10listModelsySSSg6source_AE6targetSbSg07defaultE0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA011TranslationE0Vc7successtF":{"name":"listModels(source:target:defaultModels:headers:failure:success:)","abstract":"

List models.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C11createModelySS04baseE2ID_SSSg4name10Foundation3URLVSg14forcedGlossaryAK14parallelCorpusAK011monolingualN0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA011TranslationE0Vc7successtF":{"name":"createModel(baseModelID:name:forcedGlossary:parallelCorpus:monolingualCorpus:headers:failure:success:)","abstract":"

Create model.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C11deleteModelySS7modelID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteE6ResultVc7successtF":{"name":"deleteModel(modelID:headers:failure:success:)","abstract":"

Delete model.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C8getModelySS7modelID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA011TranslationE0Vc7successtF":{"name":"getModel(modelID:headers:failure:success:)","abstract":"

Get model details.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html":{"name":"LanguageTranslator","abstract":"

IBM Watson™ Language Translator translates text from one language to another. The service offers multiple"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/docSet.dsidx b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/docSet.dsidx index 7917457ab..f7b8467ed 100644 Binary files a/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/docSet.dsidx and b/docs/swift-api/services/LanguageTranslatorV2/docsets/.docset/Contents/Resources/docSet.dsidx differ diff --git a/docs/swift-api/services/LanguageTranslatorV2/docsets/.tgz b/docs/swift-api/services/LanguageTranslatorV2/docsets/.tgz index d7df1964f..feabb3feb 100644 Binary files a/docs/swift-api/services/LanguageTranslatorV2/docsets/.tgz and b/docs/swift-api/services/LanguageTranslatorV2/docsets/.tgz differ diff --git a/docs/swift-api/services/LanguageTranslatorV2/index.html b/docs/swift-api/services/LanguageTranslatorV2/index.html index b7ccd7063..c7ac8048c 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/index.html +++ b/docs/swift-api/services/LanguageTranslatorV2/index.html @@ -64,9 +64,6 @@ - @@ -133,7 +130,8 @@

Services

  • Assistant
  • Discovery
  • -
  • Language Translator
  • +
  • Language Translator V2
  • +
  • Language Translator V3
  • Natural Language Classifier
  • Natural Language Understanding
  • Personality Insights
  • @@ -178,7 +176,7 @@

    Swift Package Manager

    Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

    dependencies: [
    -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
    +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
     ]
     

    Service Instances

    @@ -221,7 +219,7 @@

    Username and Password

    API Key

    -

    Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

    +

    Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

    let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
     

    Using IAM

    @@ -456,7 +454,12 @@

    Private Data Collections

  • IBM Discovery - Documentation
  • IBM Discovery - Demo
-

Language Translator

+

Language Translator V2

+ +

Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

@@ -467,6 +470,25 @@

Language Translator

let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} + +

Language Translator V3

+ +

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

+ +

The following example demonstrates how to use the Language Translator service:

+
import LanguageTranslatorV3
+
+let username = "your-username-here"
+let password = "your-password-here"
+let version = "yyyy-mm-dd" // use today's date for the most recent version
+let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
+
 let failure = { (error: Error) in print(error) }
 let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
 languageTranslator.translate(request: request, failure: failure) {
@@ -857,7 +879,7 @@ 

Visual Recognition

let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -865,6 +887,10 @@

Visual Recognition

print(classifiedImages) }
+ +

Note: a different initializer is used for authentication with instances created before May 23, 2018:

+
let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
+

Using Core ML

The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

@@ -916,7 +942,7 @@

Bundlin diff --git a/docs/swift-api/services/LanguageTranslatorV2/search.json b/docs/swift-api/services/LanguageTranslatorV2/search.json index 04b486720..ac9dc3f1f 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/search.json +++ b/docs/swift-api/services/LanguageTranslatorV2/search.json @@ -1 +1 @@ -{"Structs/TranslationResult.html#/s:20LanguageTranslatorV217TranslationResultV9wordCountSivp":{"name":"wordCount","abstract":"

Number of words in the input text.

","parent_name":"TranslationResult"},"Structs/TranslationResult.html#/s:20LanguageTranslatorV217TranslationResultV14characterCountSivp":{"name":"characterCount","abstract":"

Number of characters in the input text.

","parent_name":"TranslationResult"},"Structs/TranslationResult.html#/s:20LanguageTranslatorV217TranslationResultV12translationsSayAA0D0VGvp":{"name":"translations","abstract":"

List of translation output in UTF-8, corresponding to the input text entries.

","parent_name":"TranslationResult"},"Structs/TranslationModels.html#/s:20LanguageTranslatorV217TranslationModelsV6modelsSayAA0D5ModelVGvp":{"name":"models","abstract":"

An array of available models.

","parent_name":"TranslationModels"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO9uploadingA2EmF":{"name":"uploading","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO8uploadedA2EmF":{"name":"uploaded","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO11dispatchingA2EmF":{"name":"dispatching","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO6queuedA2EmF":{"name":"queued","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO8trainingA2EmF":{"name":"training","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO7trainedA2EmF":{"name":"trained","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO10publishingA2EmF":{"name":"publishing","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO9availableA2EmF":{"name":"available","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO7deletedA2EmF":{"name":"deleted","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO5errorA2EmF":{"name":"error","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html":{"name":"Status","abstract":"

Availability of a model.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV7modelIDSSvp":{"name":"modelID","abstract":"

A globally unique string that identifies the underlying model that is used for translation.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV4nameSSSgvp":{"name":"name","abstract":"

Optional name that can be specified when the model is created.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV6sourceSSSgvp":{"name":"source","abstract":"

Translation source language code.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV6targetSSSgvp":{"name":"target","abstract":"

Translation target language code.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV04baseE2IDSSSgvp":{"name":"baseModelID","abstract":"

Model ID of the base model that was used to customize the model. If the model is not a custom model, this will be an empty string.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV6domainSSSgvp":{"name":"domain","abstract":"

The domain of the translation model.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV12customizableSbSgvp":{"name":"customizable","abstract":"

Whether this model can be used as a base for customization. Customized models are not further customizable, and some base models are not customizable.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV07defaultE0SbSgvp":{"name":"defaultModel","abstract":"

Whether or not the model is a default model. A default model is the model for a given language pair that will be used when that language pair is specified in the source and target parameters.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV5ownerSSSgvp":{"name":"owner","abstract":"

Either an empty string, indicating the model is not a custom model, or the ID of the service instance that created the model.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV6statusSSSgvp":{"name":"status","abstract":"

Availability of a model.

","parent_name":"TranslationModel"},"Structs/Translation.html#/s:20LanguageTranslatorV211TranslationV17translationOutputSSvp":{"name":"translationOutput","abstract":"

Translation output in UTF-8.

","parent_name":"Translation"},"Structs/TranslateRequest.html#/s:20LanguageTranslatorV216TranslateRequestV4textSaySSGvp":{"name":"text","abstract":"

Input text in UTF-8 encoding. Multiple entries will result in multiple translations in the response.

","parent_name":"TranslateRequest"},"Structs/TranslateRequest.html#/s:20LanguageTranslatorV216TranslateRequestV7modelIDSSSgvp":{"name":"modelID","abstract":"

Model ID of the translation model to use. If this is specified, the source and target parameters will be ignored. The method requires either a model ID or both the source and target parameters.

","parent_name":"TranslateRequest"},"Structs/TranslateRequest.html#/s:20LanguageTranslatorV216TranslateRequestV6sourceSSSgvp":{"name":"source","abstract":"

Language code of the source text language. Use with target as an alternative way to select a translation model. When source and target are set, and a model ID is not set, the system chooses a default model for the language pair (usually the model based on the news domain).

","parent_name":"TranslateRequest"},"Structs/TranslateRequest.html#/s:20LanguageTranslatorV216TranslateRequestV6targetSSSgvp":{"name":"target","abstract":"

Language code of the translation target language. Use with source as an alternative way to select a translation model.

","parent_name":"TranslateRequest"},"Structs/TranslateRequest.html#/s:20LanguageTranslatorV216TranslateRequestVACSaySSG4text_SSSg7modelIDAF6sourceAF6targettcfc":{"name":"init(text:modelID:source:target:)","abstract":"

Initialize a TranslateRequest with member variables.

","parent_name":"TranslateRequest"},"Structs/IdentifiedLanguages.html#/s:20LanguageTranslatorV219IdentifiedLanguagesV9languagesSayAA0dA0VGvp":{"name":"languages","abstract":"

A ranking of identified languages with confidence scores.

","parent_name":"IdentifiedLanguages"},"Structs/IdentifiedLanguage.html#/s:20LanguageTranslatorV2010IdentifiedA0V8languageSSvp":{"name":"language","abstract":"

The language code for an identified language.

","parent_name":"IdentifiedLanguage"},"Structs/IdentifiedLanguage.html#/s:20LanguageTranslatorV2010IdentifiedA0V10confidenceSdvp":{"name":"confidence","abstract":"

The confidence score for the identified language.

","parent_name":"IdentifiedLanguage"},"Structs/IdentifiableLanguages.html#/s:20LanguageTranslatorV221IdentifiableLanguagesV9languagesSayAA0dA0VGvp":{"name":"languages","abstract":"

A list of all languages that the service can identify.

","parent_name":"IdentifiableLanguages"},"Structs/IdentifiableLanguage.html#/s:20LanguageTranslatorV2012IdentifiableA0V8languageSSvp":{"name":"language","abstract":"

The language code for an identifiable language.

","parent_name":"IdentifiableLanguage"},"Structs/IdentifiableLanguage.html#/s:20LanguageTranslatorV2012IdentifiableA0V4nameSSvp":{"name":"name","abstract":"

The name of the identifiable language.

","parent_name":"IdentifiableLanguage"},"Structs/DeleteModelResult.html#/s:20LanguageTranslatorV217DeleteModelResultV6statusSSvp":{"name":"status","abstract":"

OK indicates that the model was successfully deleted.

","parent_name":"DeleteModelResult"},"Structs/DeleteModelResult.html":{"name":"DeleteModelResult","abstract":"

DeleteModelResult.

"},"Structs/IdentifiableLanguage.html":{"name":"IdentifiableLanguage","abstract":"

IdentifiableLanguage.

"},"Structs/IdentifiableLanguages.html":{"name":"IdentifiableLanguages","abstract":"

IdentifiableLanguages.

"},"Structs/IdentifiedLanguage.html":{"name":"IdentifiedLanguage","abstract":"

IdentifiedLanguage.

"},"Structs/IdentifiedLanguages.html":{"name":"IdentifiedLanguages","abstract":"

IdentifiedLanguages.

"},"Structs/TranslateRequest.html":{"name":"TranslateRequest","abstract":"

TranslateRequest.

"},"Structs/Translation.html":{"name":"Translation","abstract":"

Translation.

"},"Structs/TranslationModel.html":{"name":"TranslationModel","abstract":"

Response payload for models.

"},"Structs/TranslationModels.html":{"name":"TranslationModels","abstract":"

The response type for listing existing translation models.

"},"Structs/TranslationResult.html":{"name":"TranslationResult","abstract":"

TranslationResult.

"},"Structs.html#/s:20LanguageTranslatorV211JSONWrapperV":{"name":"JSONWrapper","abstract":"

Used internally to serialize and deserialize JSON."},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO013serializationE0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO08encodingE0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO011fileManagerE0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0CACSS8username_SS8passwordtcfc":{"name":"init(username:password:)","abstract":"

Create a LanguageTranslator object.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a LanguageTranslator object.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a LanguageTranslator object.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C9translateyAA16TranslateRequestV7request_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA17TranslationResultVc7successtF":{"name":"translate(request:headers:failure:success:)","abstract":"

Translate.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C25listIdentifiableLanguagesys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA0eF0Vc7successtF":{"name":"listIdentifiableLanguages(headers:failure:success:)","abstract":"

List identifiable languages.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C8identifyySS4text_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA19IdentifiedLanguagesVc7successtF":{"name":"identify(text:headers:failure:success:)","abstract":"

Identify language.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C10listModelsySSSg6source_AE6targetSbSg07defaultE0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA011TranslationE0Vc7successtF":{"name":"listModels(source:target:defaultModels:headers:failure:success:)","abstract":"

List models.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C11createModelySS04baseE2ID_SSSg4name10Foundation3URLVSg14forcedGlossaryAK14parallelCorpusAK011monolingualN0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA011TranslationE0Vc7successtF":{"name":"createModel(baseModelID:name:forcedGlossary:parallelCorpus:monolingualCorpus:headers:failure:success:)","abstract":"

Create model.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C11deleteModelySS7modelID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteE6ResultVc7successtF":{"name":"deleteModel(modelID:headers:failure:success:)","abstract":"

Delete model.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C8getModelySS7modelID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA011TranslationE0Vc7successtF":{"name":"getModel(modelID:headers:failure:success:)","abstract":"

Get model details.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html":{"name":"LanguageTranslator","abstract":"

IBM Watson Language Translator translates text from one language to another. The service offers multiple"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file +{"Structs/TranslationResult.html#/s:20LanguageTranslatorV217TranslationResultV9wordCountSivp":{"name":"wordCount","abstract":"

Number of words in the input text.

","parent_name":"TranslationResult"},"Structs/TranslationResult.html#/s:20LanguageTranslatorV217TranslationResultV14characterCountSivp":{"name":"characterCount","abstract":"

Number of characters in the input text.

","parent_name":"TranslationResult"},"Structs/TranslationResult.html#/s:20LanguageTranslatorV217TranslationResultV12translationsSayAA0D0VGvp":{"name":"translations","abstract":"

List of translation output in UTF-8, corresponding to the input text entries.

","parent_name":"TranslationResult"},"Structs/TranslationModels.html#/s:20LanguageTranslatorV217TranslationModelsV6modelsSayAA0D5ModelVGvp":{"name":"models","abstract":"

An array of available models.

","parent_name":"TranslationModels"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO9uploadingA2EmF":{"name":"uploading","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO8uploadedA2EmF":{"name":"uploaded","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO11dispatchingA2EmF":{"name":"dispatching","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO6queuedA2EmF":{"name":"queued","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO8trainingA2EmF":{"name":"training","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO7trainedA2EmF":{"name":"trained","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO10publishingA2EmF":{"name":"publishing","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO9availableA2EmF":{"name":"available","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO7deletedA2EmF":{"name":"deleted","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html#/s:20LanguageTranslatorV216TranslationModelV6StatusO5errorA2EmF":{"name":"error","abstract":"

Undocumented

","parent_name":"Status"},"Structs/TranslationModel/Status.html":{"name":"Status","abstract":"

Availability of a model.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV7modelIDSSvp":{"name":"modelID","abstract":"

A globally unique string that identifies the underlying model that is used for translation.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV4nameSSSgvp":{"name":"name","abstract":"

Optional name that can be specified when the model is created.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV6sourceSSSgvp":{"name":"source","abstract":"

Translation source language code.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV6targetSSSgvp":{"name":"target","abstract":"

Translation target language code.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV04baseE2IDSSSgvp":{"name":"baseModelID","abstract":"

Model ID of the base model that was used to customize the model. If the model is not a custom model, this will be","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV6domainSSSgvp":{"name":"domain","abstract":"

The domain of the translation model.

","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV12customizableSbSgvp":{"name":"customizable","abstract":"

Whether this model can be used as a base for customization. Customized models are not further customizable, and","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV07defaultE0SbSgvp":{"name":"defaultModel","abstract":"

Whether or not the model is a default model. A default model is the model for a given language pair that will be","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV5ownerSSSgvp":{"name":"owner","abstract":"

Either an empty string, indicating the model is not a custom model, or the ID of the service instance that created","parent_name":"TranslationModel"},"Structs/TranslationModel.html#/s:20LanguageTranslatorV216TranslationModelV6statusSSSgvp":{"name":"status","abstract":"

Availability of a model.

","parent_name":"TranslationModel"},"Structs/Translation.html#/s:20LanguageTranslatorV211TranslationV17translationOutputSSvp":{"name":"translationOutput","abstract":"

Translation output in UTF-8.

","parent_name":"Translation"},"Structs/TranslateRequest.html#/s:20LanguageTranslatorV216TranslateRequestV4textSaySSGvp":{"name":"text","abstract":"

Input text in UTF-8 encoding. Multiple entries will result in multiple translations in the response.

","parent_name":"TranslateRequest"},"Structs/TranslateRequest.html#/s:20LanguageTranslatorV216TranslateRequestV7modelIDSSSgvp":{"name":"modelID","abstract":"

Model ID of the translation model to use. If this is specified, the source and target parameters will be","parent_name":"TranslateRequest"},"Structs/TranslateRequest.html#/s:20LanguageTranslatorV216TranslateRequestV6sourceSSSgvp":{"name":"source","abstract":"

Language code of the source text language. Use with target as an alternative way to select a translation model.","parent_name":"TranslateRequest"},"Structs/TranslateRequest.html#/s:20LanguageTranslatorV216TranslateRequestV6targetSSSgvp":{"name":"target","abstract":"

Language code of the translation target language. Use with source as an alternative way to select a translation","parent_name":"TranslateRequest"},"Structs/TranslateRequest.html#/s:20LanguageTranslatorV216TranslateRequestVACSaySSG4text_SSSg7modelIDAF6sourceAF6targettcfc":{"name":"init(text:modelID:source:target:)","abstract":"

Initialize a TranslateRequest with member variables.

","parent_name":"TranslateRequest"},"Structs/IdentifiedLanguages.html#/s:20LanguageTranslatorV219IdentifiedLanguagesV9languagesSayAA0dA0VGvp":{"name":"languages","abstract":"

A ranking of identified languages with confidence scores.

","parent_name":"IdentifiedLanguages"},"Structs/IdentifiedLanguage.html#/s:20LanguageTranslatorV2010IdentifiedA0V8languageSSvp":{"name":"language","abstract":"

The language code for an identified language.

","parent_name":"IdentifiedLanguage"},"Structs/IdentifiedLanguage.html#/s:20LanguageTranslatorV2010IdentifiedA0V10confidenceSdvp":{"name":"confidence","abstract":"

The confidence score for the identified language.

","parent_name":"IdentifiedLanguage"},"Structs/IdentifiableLanguages.html#/s:20LanguageTranslatorV221IdentifiableLanguagesV9languagesSayAA0dA0VGvp":{"name":"languages","abstract":"

A list of all languages that the service can identify.

","parent_name":"IdentifiableLanguages"},"Structs/IdentifiableLanguage.html#/s:20LanguageTranslatorV2012IdentifiableA0V8languageSSvp":{"name":"language","abstract":"

The language code for an identifiable language.

","parent_name":"IdentifiableLanguage"},"Structs/IdentifiableLanguage.html#/s:20LanguageTranslatorV2012IdentifiableA0V4nameSSvp":{"name":"name","abstract":"

The name of the identifiable language.

","parent_name":"IdentifiableLanguage"},"Structs/DeleteModelResult.html#/s:20LanguageTranslatorV217DeleteModelResultV6statusSSvp":{"name":"status","abstract":"

OK indicates that the model was successfully deleted.

","parent_name":"DeleteModelResult"},"Structs/DeleteModelResult.html":{"name":"DeleteModelResult","abstract":"

DeleteModelResult.

"},"Structs/IdentifiableLanguage.html":{"name":"IdentifiableLanguage","abstract":"

IdentifiableLanguage.

"},"Structs/IdentifiableLanguages.html":{"name":"IdentifiableLanguages","abstract":"

IdentifiableLanguages.

"},"Structs/IdentifiedLanguage.html":{"name":"IdentifiedLanguage","abstract":"

IdentifiedLanguage.

"},"Structs/IdentifiedLanguages.html":{"name":"IdentifiedLanguages","abstract":"

IdentifiedLanguages.

"},"Structs/TranslateRequest.html":{"name":"TranslateRequest","abstract":"

TranslateRequest.

"},"Structs/Translation.html":{"name":"Translation","abstract":"

Translation.

"},"Structs/TranslationModel.html":{"name":"TranslationModel","abstract":"

Response payload for models.

"},"Structs/TranslationModels.html":{"name":"TranslationModels","abstract":"

The response type for listing existing translation models.

"},"Structs/TranslationResult.html":{"name":"TranslationResult","abstract":"

TranslationResult.

"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO013serializationE0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO08encodingE0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO011fileManagerE0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:20LanguageTranslatorV29RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:20LanguageTranslatorV24JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0CACSS8username_SS8passwordtcfc":{"name":"init(username:password:)","abstract":"

Create a LanguageTranslator object.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a LanguageTranslator object.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a LanguageTranslator object.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C9translateyAA16TranslateRequestV7request_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA17TranslationResultVc7successtF":{"name":"translate(request:headers:failure:success:)","abstract":"

Translate.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C25listIdentifiableLanguagesys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA0eF0Vc7successtF":{"name":"listIdentifiableLanguages(headers:failure:success:)","abstract":"

List identifiable languages.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C8identifyySS4text_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA19IdentifiedLanguagesVc7successtF":{"name":"identify(text:headers:failure:success:)","abstract":"

Identify language.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C10listModelsySSSg6source_AE6targetSbSg07defaultE0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA011TranslationE0Vc7successtF":{"name":"listModels(source:target:defaultModels:headers:failure:success:)","abstract":"

List models.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C11createModelySS04baseE2ID_SSSg4name10Foundation3URLVSg14forcedGlossaryAK14parallelCorpusAK011monolingualN0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA011TranslationE0Vc7successtF":{"name":"createModel(baseModelID:name:forcedGlossary:parallelCorpus:monolingualCorpus:headers:failure:success:)","abstract":"

Create model.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C11deleteModelySS7modelID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteE6ResultVc7successtF":{"name":"deleteModel(modelID:headers:failure:success:)","abstract":"

Delete model.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html#/s:20LanguageTranslatorV20aB0C8getModelySS7modelID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA011TranslationE0Vc7successtF":{"name":"getModel(modelID:headers:failure:success:)","abstract":"

Get model details.

","parent_name":"LanguageTranslator"},"Classes/LanguageTranslator.html":{"name":"LanguageTranslator","abstract":"

IBM Watson™ Language Translator translates text from one language to another. The service offers multiple"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file diff --git a/docs/swift-api/services/LanguageTranslatorV2/undocumented.json b/docs/swift-api/services/LanguageTranslatorV2/undocumented.json index 20fb70f83..a2031e2b9 100644 --- a/docs/swift-api/services/LanguageTranslatorV2/undocumented.json +++ b/docs/swift-api/services/LanguageTranslatorV2/undocumented.json @@ -9,70 +9,70 @@ }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/LanguageTranslatorV2/Models/TranslationModel.swift", - "line": 24, + "line": 26, "symbol": "TranslationModel.Status.uploading", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/LanguageTranslatorV2/Models/TranslationModel.swift", - "line": 25, + "line": 27, "symbol": "TranslationModel.Status.uploaded", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/LanguageTranslatorV2/Models/TranslationModel.swift", - "line": 26, + "line": 28, "symbol": "TranslationModel.Status.dispatching", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/LanguageTranslatorV2/Models/TranslationModel.swift", - "line": 27, + "line": 29, "symbol": "TranslationModel.Status.queued", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/LanguageTranslatorV2/Models/TranslationModel.swift", - "line": 28, + "line": 30, "symbol": "TranslationModel.Status.training", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/LanguageTranslatorV2/Models/TranslationModel.swift", - "line": 29, + "line": 31, "symbol": "TranslationModel.Status.trained", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/LanguageTranslatorV2/Models/TranslationModel.swift", - "line": 30, + "line": 32, "symbol": "TranslationModel.Status.publishing", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/LanguageTranslatorV2/Models/TranslationModel.swift", - "line": 31, + "line": 33, "symbol": "TranslationModel.Status.available", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/LanguageTranslatorV2/Models/TranslationModel.swift", - "line": 32, + "line": 34, "symbol": "TranslationModel.Status.deleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/LanguageTranslatorV2/Models/TranslationModel.swift", - "line": 33, + "line": 35, "symbol": "TranslationModel.Status.error", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/Classes.html b/docs/swift-api/services/NaturalLanguageClassifierV1/Classes.html index c43b6a527..b45ee362b 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/Classes.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/Classes.html @@ -77,9 +77,6 @@ - @@ -107,9 +104,9 @@

Classes

-

IBM Watson Natural Language Classifier uses machine learning algorithms to return the top matching predefined classes -for short text input. You create and train a classifier to connect predefined classes to example texts so that the -service can apply those classes to new inputs.

+

IBM Watson™ Natural Language Classifier uses machine learning algorithms to return the top matching predefined +classes for short text input. You create and train a classifier to connect predefined classes to example texts so that +the service can apply those classes to new inputs.

See more
@@ -129,7 +126,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/Classes/NaturalLanguageClassifier.html b/docs/swift-api/services/NaturalLanguageClassifierV1/Classes/NaturalLanguageClassifier.html index a7f6044ff..7b10ecba0 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/Classes/NaturalLanguageClassifier.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/Classes/NaturalLanguageClassifier.html @@ -77,9 +77,6 @@ - @@ -94,9 +91,9 @@

NaturalLanguageClassifier

-

IBM Watson Natural Language Classifier uses machine learning algorithms to return the top matching predefined classes -for short text input. You create and train a classifier to connect predefined classes to example texts so that the -service can apply those classes to new inputs.

+

IBM Watson™ Natural Language Classifier uses machine learning algorithms to return the top matching predefined +classes for short text input. You create and train a classifier to connect predefined classes to example texts so that +the service can apply those classes to new inputs.

@@ -332,7 +329,8 @@

Parameters

Classify multiple phrases.

Returns label information for multiple phrases. The status must be Available before you can use the classifier to -classify text. Note that classifying Japanese texts is a beta feature.

+classify text. +Note that classifying Japanese texts is a beta feature.

@@ -778,7 +776,7 @@

Parameters

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/Enums.html b/docs/swift-api/services/NaturalLanguageClassifierV1/Enums.html index f4a3a28de..2af8b7029 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/Enums.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/Enums.html @@ -77,9 +77,6 @@ - @@ -159,7 +156,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/Enums/JSON.html b/docs/swift-api/services/NaturalLanguageClassifierV1/Enums/JSON.html index fd57142e6..f239ff1c6 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/Enums/JSON.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/Enums/JSON.html @@ -77,9 +77,6 @@ - @@ -429,7 +426,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/Enums/RestError.html b/docs/swift-api/services/NaturalLanguageClassifierV1/Enums/RestError.html index 10528b26e..8038487f0 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/Enums/RestError.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/Enums/RestError.html @@ -77,9 +77,6 @@ - @@ -296,7 +293,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/Structs.html b/docs/swift-api/services/NaturalLanguageClassifierV1/Structs.html index 20c12acf7..9a14f5d23 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/Structs.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/Structs.html @@ -77,9 +77,6 @@ - @@ -348,49 +345,10 @@

Declaration

-
-
- - - -

JSON

-
-
-
    -
  • -
    - - - - JSONWrapper - -
    -
    -
    -
    -
    -
    -

    Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct JSONWrapper
    - -
    -
    -
    -
    -
  • -
-
diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/Classification.html b/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/Classification.html index 3caae83b7..4556459d5 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/Classification.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/Classification.html @@ -77,9 +77,6 @@ - @@ -240,7 +237,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/ClassificationCollection.html b/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/ClassificationCollection.html index 1b56b52ef..7515b54e3 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/ClassificationCollection.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/ClassificationCollection.html @@ -77,9 +77,6 @@ - @@ -186,7 +183,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/ClassifiedClass.html b/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/ClassifiedClass.html index 3cb7ba0ab..073f1797e 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/ClassifiedClass.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/ClassifiedClass.html @@ -77,9 +77,6 @@ - @@ -113,7 +110,8 @@

ClassifiedClass

-

A decimal percentage that represents the confidence that Watson has in this class. Higher values represent higher confidences.

+

A decimal percentage that represents the confidence that Watson has in this class. Higher values represent higher +confidences.

@@ -159,7 +157,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/Classifier.html b/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/Classifier.html index 98a74ec55..2a2b8a863 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/Classifier.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/Classifier.html @@ -77,9 +77,6 @@ - @@ -322,7 +319,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/Classifier/Status.html b/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/Classifier/Status.html index 262c6c7b1..b2375e3fe 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/Classifier/Status.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/Classifier/Status.html @@ -77,9 +77,6 @@ - @@ -240,7 +237,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/ClassifierList.html b/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/ClassifierList.html index ad948e4fa..1ab568fdd 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/ClassifierList.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/ClassifierList.html @@ -77,9 +77,6 @@ - @@ -132,7 +129,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/ClassifyCollectionInput.html b/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/ClassifyCollectionInput.html index 4372748ba..38a213f63 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/ClassifyCollectionInput.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/ClassifyCollectionInput.html @@ -77,9 +77,6 @@ - @@ -147,7 +144,9 @@

Declaration

Declaration

Swift

-
public init(collection: [ClassifyInput])
+
public init(
+    collection: [ClassifyInput]
+)
@@ -182,7 +181,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/ClassifyInput.html b/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/ClassifyInput.html index ded3ef85d..9ce06e2c7 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/ClassifyInput.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/ClassifyInput.html @@ -77,9 +77,6 @@ - @@ -147,7 +144,9 @@

Declaration

Declaration

Swift

-
public init(text: String)
+
public init(
+    text: String
+)
@@ -182,7 +181,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/CollectionItem.html b/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/CollectionItem.html index 37929d928..1cb8e2f37 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/CollectionItem.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/Structs/CollectionItem.html @@ -77,9 +77,6 @@ - @@ -186,7 +183,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Classes.html b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Classes.html index c43b6a527..b45ee362b 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Classes.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Classes.html @@ -77,9 +77,6 @@ - @@ -107,9 +104,9 @@

Classes

-

IBM Watson Natural Language Classifier uses machine learning algorithms to return the top matching predefined classes -for short text input. You create and train a classifier to connect predefined classes to example texts so that the -service can apply those classes to new inputs.

+

IBM Watson™ Natural Language Classifier uses machine learning algorithms to return the top matching predefined +classes for short text input. You create and train a classifier to connect predefined classes to example texts so that +the service can apply those classes to new inputs.

See more
@@ -129,7 +126,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Classes/NaturalLanguageClassifier.html b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Classes/NaturalLanguageClassifier.html index a7f6044ff..7b10ecba0 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Classes/NaturalLanguageClassifier.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Classes/NaturalLanguageClassifier.html @@ -77,9 +77,6 @@ - @@ -94,9 +91,9 @@

NaturalLanguageClassifier

-

IBM Watson Natural Language Classifier uses machine learning algorithms to return the top matching predefined classes -for short text input. You create and train a classifier to connect predefined classes to example texts so that the -service can apply those classes to new inputs.

+

IBM Watson™ Natural Language Classifier uses machine learning algorithms to return the top matching predefined +classes for short text input. You create and train a classifier to connect predefined classes to example texts so that +the service can apply those classes to new inputs.

@@ -332,7 +329,8 @@

Parameters

Classify multiple phrases.

Returns label information for multiple phrases. The status must be Available before you can use the classifier to -classify text. Note that classifying Japanese texts is a beta feature.

+classify text. +Note that classifying Japanese texts is a beta feature.

@@ -778,7 +776,7 @@

Parameters

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Enums.html b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Enums.html index f4a3a28de..2af8b7029 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Enums.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Enums.html @@ -77,9 +77,6 @@ - @@ -159,7 +156,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html index fd57142e6..f239ff1c6 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html @@ -77,9 +77,6 @@ - @@ -429,7 +426,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html index 10528b26e..8038487f0 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html @@ -77,9 +77,6 @@ - @@ -296,7 +293,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs.html b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs.html index 20c12acf7..9a14f5d23 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs.html @@ -77,9 +77,6 @@ - @@ -348,49 +345,10 @@

Declaration

-
-
- - - -

JSON

-
-
-
    -
  • -
    - - - - JSONWrapper - -
    -
    -
    -
    -
    -
    -

    Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct JSONWrapper
    - -
    -
    -
    -
    -
  • -
-
diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/Classification.html b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/Classification.html index 3caae83b7..4556459d5 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/Classification.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/Classification.html @@ -77,9 +77,6 @@ - @@ -240,7 +237,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/ClassificationCollection.html b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/ClassificationCollection.html index 1b56b52ef..7515b54e3 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/ClassificationCollection.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/ClassificationCollection.html @@ -77,9 +77,6 @@ - @@ -186,7 +183,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/ClassifiedClass.html b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/ClassifiedClass.html index 3cb7ba0ab..073f1797e 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/ClassifiedClass.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/ClassifiedClass.html @@ -77,9 +77,6 @@ - @@ -113,7 +110,8 @@

ClassifiedClass

-

A decimal percentage that represents the confidence that Watson has in this class. Higher values represent higher confidences.

+

A decimal percentage that represents the confidence that Watson has in this class. Higher values represent higher +confidences.

@@ -159,7 +157,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/Classifier.html b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/Classifier.html index 98a74ec55..2a2b8a863 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/Classifier.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/Classifier.html @@ -77,9 +77,6 @@ - @@ -322,7 +319,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/Classifier/Status.html b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/Classifier/Status.html index 262c6c7b1..b2375e3fe 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/Classifier/Status.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/Classifier/Status.html @@ -77,9 +77,6 @@ - @@ -240,7 +237,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/ClassifierList.html b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/ClassifierList.html index ad948e4fa..1ab568fdd 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/ClassifierList.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/ClassifierList.html @@ -77,9 +77,6 @@ - @@ -132,7 +129,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/ClassifyCollectionInput.html b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/ClassifyCollectionInput.html index 4372748ba..38a213f63 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/ClassifyCollectionInput.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/ClassifyCollectionInput.html @@ -77,9 +77,6 @@ - @@ -147,7 +144,9 @@

Declaration

Declaration

Swift

-
public init(collection: [ClassifyInput])
+
public init(
+    collection: [ClassifyInput]
+)
@@ -182,7 +181,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/ClassifyInput.html b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/ClassifyInput.html index ded3ef85d..9ce06e2c7 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/ClassifyInput.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/ClassifyInput.html @@ -77,9 +77,6 @@ - @@ -147,7 +144,9 @@

Declaration

Declaration

Swift

-
public init(text: String)
+
public init(
+    text: String
+)
@@ -182,7 +181,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/CollectionItem.html b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/CollectionItem.html index 37929d928..1cb8e2f37 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/CollectionItem.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/Structs/CollectionItem.html @@ -77,9 +77,6 @@ - @@ -186,7 +183,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/index.html b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/index.html index f5396d4a7..ea3270ac2 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/index.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/index.html @@ -76,9 +76,6 @@ - @@ -127,7 +124,8 @@

Services

  • Assistant
  • Discovery
  • -
  • Language Translator
  • +
  • Language Translator V2
  • +
  • Language Translator V3
  • Natural Language Classifier
  • Natural Language Understanding
  • Personality Insights
  • @@ -172,7 +170,7 @@

    Swift Package Manager

    Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

    dependencies: [
    -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
    +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
     ]
     

    Service Instances

    @@ -215,7 +213,7 @@

    Username and Password

    API Key

    -

    Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

    +

    Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

    let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
     

    Using IAM

    @@ -450,7 +448,12 @@

    Private Data Collections

  • IBM Discovery - Documentation
  • IBM Discovery - Demo
-

Language Translator

+

Language Translator V2

+ +

Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

@@ -461,6 +464,25 @@

Language Translator

let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} + +

Language Translator V3

+ +

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

+ +

The following example demonstrates how to use the Language Translator service:

+
import LanguageTranslatorV3
+
+let username = "your-username-here"
+let password = "your-password-here"
+let version = "yyyy-mm-dd" // use today's date for the most recent version
+let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
+
 let failure = { (error: Error) in print(error) }
 let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
 languageTranslator.translate(request: request, failure: failure) {
@@ -851,7 +873,7 @@ 

Visual Recognition

let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -859,6 +881,10 @@

Visual Recognition

print(classifiedImages) }
+ +

Note: a different initializer is used for authentication with instances created before May 23, 2018:

+
let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
+

Using Core ML

The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

@@ -910,7 +936,7 @@

Bundlin diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/search.json b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/search.json index 1065c4731..1dd1d5391 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/search.json +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/Documents/search.json @@ -1 +1 @@ -{"Structs/CollectionItem.html#/s:27NaturalLanguageClassifierV114CollectionItemV4textSSSgvp":{"name":"text","abstract":"

The submitted phrase.

","parent_name":"CollectionItem"},"Structs/CollectionItem.html#/s:27NaturalLanguageClassifierV114CollectionItemV8topClassSSSgvp":{"name":"topClass","abstract":"

The class with the highest confidence.

","parent_name":"CollectionItem"},"Structs/CollectionItem.html#/s:27NaturalLanguageClassifierV114CollectionItemV7classesSayAA15ClassifiedClassVGSgvp":{"name":"classes","abstract":"

An array of up to ten class-confidence pairs sorted in descending order of confidence.

","parent_name":"CollectionItem"},"Structs/ClassifyInput.html#/s:27NaturalLanguageClassifierV113ClassifyInputV4textSSvp":{"name":"text","abstract":"

The submitted phrase.

","parent_name":"ClassifyInput"},"Structs/ClassifyInput.html#/s:27NaturalLanguageClassifierV113ClassifyInputVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a ClassifyInput with member variables.

","parent_name":"ClassifyInput"},"Structs/ClassifyCollectionInput.html#/s:27NaturalLanguageClassifierV123ClassifyCollectionInputV10collectionSayAA0eG0VGvp":{"name":"collection","abstract":"

The submitted phrases.

","parent_name":"ClassifyCollectionInput"},"Structs/ClassifyCollectionInput.html#/s:27NaturalLanguageClassifierV123ClassifyCollectionInputVACSayAA0eG0VG10collection_tcfc":{"name":"init(collection:)","abstract":"

Initialize a ClassifyCollectionInput with member variables.

","parent_name":"ClassifyCollectionInput"},"Structs/ClassifierList.html#/s:27NaturalLanguageClassifierV10C4ListV11classifiersSayAA0C0VGvp":{"name":"classifiers","abstract":"

The classifiers available to the user. Returns an empty array if no classifiers are available.

","parent_name":"ClassifierList"},"Structs/Classifier/Status.html#/s:27NaturalLanguageClassifierV10C0V6StatusO11nonExistentA2EmF":{"name":"nonExistent","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Classifier/Status.html#/s:27NaturalLanguageClassifierV10C0V6StatusO8trainingA2EmF":{"name":"training","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Classifier/Status.html#/s:27NaturalLanguageClassifierV10C0V6StatusO6failedA2EmF":{"name":"failed","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Classifier/Status.html#/s:27NaturalLanguageClassifierV10C0V6StatusO9availableA2EmF":{"name":"available","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Classifier/Status.html#/s:27NaturalLanguageClassifierV10C0V6StatusO11unavailableA2EmF":{"name":"unavailable","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Classifier/Status.html":{"name":"Status","abstract":"

The state of the classifier.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V4nameSSSgvp":{"name":"name","abstract":"

User-supplied name for the classifier.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V3urlSSvp":{"name":"url","abstract":"

Link to the classifier.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V6statusSSSgvp":{"name":"status","abstract":"

The state of the classifier.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V12classifierIDSSvp":{"name":"classifierID","abstract":"

Unique identifier for this classifier.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V7createdSSSgvp":{"name":"created","abstract":"

Date and time (UTC) the classifier was created.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V17statusDescriptionSSSgvp":{"name":"statusDescription","abstract":"

Additional detail about the status.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V8languageSSSgvp":{"name":"language","abstract":"

The language used for the classifier.

","parent_name":"Classifier"},"Structs/ClassifiedClass.html#/s:27NaturalLanguageClassifierV115ClassifiedClassV10confidenceSdSgvp":{"name":"confidence","abstract":"

A decimal percentage that represents the confidence that Watson has in this class. Higher values represent higher confidences.

","parent_name":"ClassifiedClass"},"Structs/ClassifiedClass.html#/s:27NaturalLanguageClassifierV115ClassifiedClassV9classNameSSSgvp":{"name":"className","abstract":"

Class label.

","parent_name":"ClassifiedClass"},"Structs/ClassificationCollection.html#/s:27NaturalLanguageClassifierV124ClassificationCollectionV12classifierIDSSSgvp":{"name":"classifierID","abstract":"

Unique identifier for this classifier.

","parent_name":"ClassificationCollection"},"Structs/ClassificationCollection.html#/s:27NaturalLanguageClassifierV124ClassificationCollectionV3urlSSSgvp":{"name":"url","abstract":"

Link to the classifier.

","parent_name":"ClassificationCollection"},"Structs/ClassificationCollection.html#/s:27NaturalLanguageClassifierV124ClassificationCollectionV10collectionSayAA0F4ItemVGSgvp":{"name":"collection","abstract":"

An array of classifier responses for each submitted phrase.

","parent_name":"ClassificationCollection"},"Structs/Classification.html#/s:27NaturalLanguageClassifierV114ClassificationV12classifierIDSSSgvp":{"name":"classifierID","abstract":"

Unique identifier for this classifier.

","parent_name":"Classification"},"Structs/Classification.html#/s:27NaturalLanguageClassifierV114ClassificationV3urlSSSgvp":{"name":"url","abstract":"

Link to the classifier.

","parent_name":"Classification"},"Structs/Classification.html#/s:27NaturalLanguageClassifierV114ClassificationV4textSSSgvp":{"name":"text","abstract":"

The submitted phrase.

","parent_name":"Classification"},"Structs/Classification.html#/s:27NaturalLanguageClassifierV114ClassificationV8topClassSSSgvp":{"name":"topClass","abstract":"

The class with the highest confidence.

","parent_name":"Classification"},"Structs/Classification.html#/s:27NaturalLanguageClassifierV114ClassificationV7classesSayAA15ClassifiedClassVGSgvp":{"name":"classes","abstract":"

An array of up to ten class-confidence pairs sorted in descending order of confidence.

","parent_name":"Classification"},"Structs/Classification.html":{"name":"Classification","abstract":"

Response from the classifier for a phrase.

"},"Structs/ClassificationCollection.html":{"name":"ClassificationCollection","abstract":"

Response from the classifier for multiple phrases.

"},"Structs/ClassifiedClass.html":{"name":"ClassifiedClass","abstract":"

Class and confidence.

"},"Structs/Classifier.html":{"name":"Classifier","abstract":"

A classifier for natural language phrases.

"},"Structs/ClassifierList.html":{"name":"ClassifierList","abstract":"

List of available classifiers.

"},"Structs/ClassifyCollectionInput.html":{"name":"ClassifyCollectionInput","abstract":"

Request payload to classify.

"},"Structs/ClassifyInput.html":{"name":"ClassifyInput","abstract":"

Request payload to classify.

"},"Structs/CollectionItem.html":{"name":"CollectionItem","abstract":"

Response from the classifier for a phrase in a collection.

"},"Structs.html#/s:27NaturalLanguageClassifierV111JSONWrapperV":{"name":"JSONWrapper","abstract":"

Used internally to serialize and deserialize JSON."},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO013serializationF0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO08encodingF0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO011fileManagerF0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0CACSS8username_SS8passwordtcfc":{"name":"init(username:password:)","abstract":"

Create a NaturalLanguageClassifier object.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C8classifyySS12classifierID_SS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA14ClassificationVc7successtF":{"name":"classify(classifierID:text:headers:failure:success:)","abstract":"

Classify a phrase.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C18classifyCollectionySS12classifierID_SayAA13ClassifyInputVG10collections10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA014ClassificationF0Vc7successtF":{"name":"classifyCollection(classifierID:collection:headers:failure:success:)","abstract":"

Classify multiple phrases.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C06createC0y10Foundation3URLV8metadata_AG12trainingDatas10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0C0Vc7successtF":{"name":"createClassifier(metadata:trainingData:headers:failure:success:)","abstract":"

Create classifier.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C15listClassifiersys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA0C4ListVc7successtF":{"name":"listClassifiers(headers:failure:success:)","abstract":"

List classifiers.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C03getC0ySS12classifierID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0C0Vc7successtF":{"name":"getClassifier(classifierID:headers:failure:success:)","abstract":"

Get information about a classifier.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C06deleteC0ySS12classifierID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteClassifier(classifierID:headers:failure:success:)","abstract":"

Delete classifier.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html":{"name":"NaturalLanguageClassifier","abstract":"

IBM Watson Natural Language Classifier uses machine learning algorithms to return the top matching predefined classes"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file +{"Structs/CollectionItem.html#/s:27NaturalLanguageClassifierV114CollectionItemV4textSSSgvp":{"name":"text","abstract":"

The submitted phrase.

","parent_name":"CollectionItem"},"Structs/CollectionItem.html#/s:27NaturalLanguageClassifierV114CollectionItemV8topClassSSSgvp":{"name":"topClass","abstract":"

The class with the highest confidence.

","parent_name":"CollectionItem"},"Structs/CollectionItem.html#/s:27NaturalLanguageClassifierV114CollectionItemV7classesSayAA15ClassifiedClassVGSgvp":{"name":"classes","abstract":"

An array of up to ten class-confidence pairs sorted in descending order of confidence.

","parent_name":"CollectionItem"},"Structs/ClassifyInput.html#/s:27NaturalLanguageClassifierV113ClassifyInputV4textSSvp":{"name":"text","abstract":"

The submitted phrase.

","parent_name":"ClassifyInput"},"Structs/ClassifyInput.html#/s:27NaturalLanguageClassifierV113ClassifyInputVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a ClassifyInput with member variables.

","parent_name":"ClassifyInput"},"Structs/ClassifyCollectionInput.html#/s:27NaturalLanguageClassifierV123ClassifyCollectionInputV10collectionSayAA0eG0VGvp":{"name":"collection","abstract":"

The submitted phrases.

","parent_name":"ClassifyCollectionInput"},"Structs/ClassifyCollectionInput.html#/s:27NaturalLanguageClassifierV123ClassifyCollectionInputVACSayAA0eG0VG10collection_tcfc":{"name":"init(collection:)","abstract":"

Initialize a ClassifyCollectionInput with member variables.

","parent_name":"ClassifyCollectionInput"},"Structs/ClassifierList.html#/s:27NaturalLanguageClassifierV10C4ListV11classifiersSayAA0C0VGvp":{"name":"classifiers","abstract":"

The classifiers available to the user. Returns an empty array if no classifiers are available.

","parent_name":"ClassifierList"},"Structs/Classifier/Status.html#/s:27NaturalLanguageClassifierV10C0V6StatusO11nonExistentA2EmF":{"name":"nonExistent","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Classifier/Status.html#/s:27NaturalLanguageClassifierV10C0V6StatusO8trainingA2EmF":{"name":"training","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Classifier/Status.html#/s:27NaturalLanguageClassifierV10C0V6StatusO6failedA2EmF":{"name":"failed","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Classifier/Status.html#/s:27NaturalLanguageClassifierV10C0V6StatusO9availableA2EmF":{"name":"available","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Classifier/Status.html#/s:27NaturalLanguageClassifierV10C0V6StatusO11unavailableA2EmF":{"name":"unavailable","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Classifier/Status.html":{"name":"Status","abstract":"

The state of the classifier.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V4nameSSSgvp":{"name":"name","abstract":"

User-supplied name for the classifier.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V3urlSSvp":{"name":"url","abstract":"

Link to the classifier.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V6statusSSSgvp":{"name":"status","abstract":"

The state of the classifier.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V12classifierIDSSvp":{"name":"classifierID","abstract":"

Unique identifier for this classifier.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V7createdSSSgvp":{"name":"created","abstract":"

Date and time (UTC) the classifier was created.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V17statusDescriptionSSSgvp":{"name":"statusDescription","abstract":"

Additional detail about the status.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V8languageSSSgvp":{"name":"language","abstract":"

The language used for the classifier.

","parent_name":"Classifier"},"Structs/ClassifiedClass.html#/s:27NaturalLanguageClassifierV115ClassifiedClassV10confidenceSdSgvp":{"name":"confidence","abstract":"

A decimal percentage that represents the confidence that Watson has in this class. Higher values represent higher","parent_name":"ClassifiedClass"},"Structs/ClassifiedClass.html#/s:27NaturalLanguageClassifierV115ClassifiedClassV9classNameSSSgvp":{"name":"className","abstract":"

Class label.

","parent_name":"ClassifiedClass"},"Structs/ClassificationCollection.html#/s:27NaturalLanguageClassifierV124ClassificationCollectionV12classifierIDSSSgvp":{"name":"classifierID","abstract":"

Unique identifier for this classifier.

","parent_name":"ClassificationCollection"},"Structs/ClassificationCollection.html#/s:27NaturalLanguageClassifierV124ClassificationCollectionV3urlSSSgvp":{"name":"url","abstract":"

Link to the classifier.

","parent_name":"ClassificationCollection"},"Structs/ClassificationCollection.html#/s:27NaturalLanguageClassifierV124ClassificationCollectionV10collectionSayAA0F4ItemVGSgvp":{"name":"collection","abstract":"

An array of classifier responses for each submitted phrase.

","parent_name":"ClassificationCollection"},"Structs/Classification.html#/s:27NaturalLanguageClassifierV114ClassificationV12classifierIDSSSgvp":{"name":"classifierID","abstract":"

Unique identifier for this classifier.

","parent_name":"Classification"},"Structs/Classification.html#/s:27NaturalLanguageClassifierV114ClassificationV3urlSSSgvp":{"name":"url","abstract":"

Link to the classifier.

","parent_name":"Classification"},"Structs/Classification.html#/s:27NaturalLanguageClassifierV114ClassificationV4textSSSgvp":{"name":"text","abstract":"

The submitted phrase.

","parent_name":"Classification"},"Structs/Classification.html#/s:27NaturalLanguageClassifierV114ClassificationV8topClassSSSgvp":{"name":"topClass","abstract":"

The class with the highest confidence.

","parent_name":"Classification"},"Structs/Classification.html#/s:27NaturalLanguageClassifierV114ClassificationV7classesSayAA15ClassifiedClassVGSgvp":{"name":"classes","abstract":"

An array of up to ten class-confidence pairs sorted in descending order of confidence.

","parent_name":"Classification"},"Structs/Classification.html":{"name":"Classification","abstract":"

Response from the classifier for a phrase.

"},"Structs/ClassificationCollection.html":{"name":"ClassificationCollection","abstract":"

Response from the classifier for multiple phrases.

"},"Structs/ClassifiedClass.html":{"name":"ClassifiedClass","abstract":"

Class and confidence.

"},"Structs/Classifier.html":{"name":"Classifier","abstract":"

A classifier for natural language phrases.

"},"Structs/ClassifierList.html":{"name":"ClassifierList","abstract":"

List of available classifiers.

"},"Structs/ClassifyCollectionInput.html":{"name":"ClassifyCollectionInput","abstract":"

Request payload to classify.

"},"Structs/ClassifyInput.html":{"name":"ClassifyInput","abstract":"

Request payload to classify.

"},"Structs/CollectionItem.html":{"name":"CollectionItem","abstract":"

Response from the classifier for a phrase in a collection.

"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO013serializationF0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO08encodingF0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO011fileManagerF0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0CACSS8username_SS8passwordtcfc":{"name":"init(username:password:)","abstract":"

Create a NaturalLanguageClassifier object.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C8classifyySS12classifierID_SS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA14ClassificationVc7successtF":{"name":"classify(classifierID:text:headers:failure:success:)","abstract":"

Classify a phrase.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C18classifyCollectionySS12classifierID_SayAA13ClassifyInputVG10collections10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA014ClassificationF0Vc7successtF":{"name":"classifyCollection(classifierID:collection:headers:failure:success:)","abstract":"

Classify multiple phrases.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C06createC0y10Foundation3URLV8metadata_AG12trainingDatas10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0C0Vc7successtF":{"name":"createClassifier(metadata:trainingData:headers:failure:success:)","abstract":"

Create classifier.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C15listClassifiersys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA0C4ListVc7successtF":{"name":"listClassifiers(headers:failure:success:)","abstract":"

List classifiers.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C03getC0ySS12classifierID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0C0Vc7successtF":{"name":"getClassifier(classifierID:headers:failure:success:)","abstract":"

Get information about a classifier.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C06deleteC0ySS12classifierID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteClassifier(classifierID:headers:failure:success:)","abstract":"

Delete classifier.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html":{"name":"NaturalLanguageClassifier","abstract":"

IBM Watson™ Natural Language Classifier uses machine learning algorithms to return the top matching predefined"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/docSet.dsidx b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/docSet.dsidx index 9c4d31e83..9fa42d357 100644 Binary files a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/docSet.dsidx and b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.docset/Contents/Resources/docSet.dsidx differ diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.tgz b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.tgz index e69d87e6a..feb781864 100644 Binary files a/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.tgz and b/docs/swift-api/services/NaturalLanguageClassifierV1/docsets/.tgz differ diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/index.html b/docs/swift-api/services/NaturalLanguageClassifierV1/index.html index f5396d4a7..ea3270ac2 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/index.html +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/index.html @@ -76,9 +76,6 @@ - @@ -127,7 +124,8 @@

Services

  • Assistant
  • Discovery
  • -
  • Language Translator
  • +
  • Language Translator V2
  • +
  • Language Translator V3
  • Natural Language Classifier
  • Natural Language Understanding
  • Personality Insights
  • @@ -172,7 +170,7 @@

    Swift Package Manager

    Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

    dependencies: [
    -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
    +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
     ]
     

    Service Instances

    @@ -215,7 +213,7 @@

    Username and Password

    API Key

    -

    Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

    +

    Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

    let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
     

    Using IAM

    @@ -450,7 +448,12 @@

    Private Data Collections

  • IBM Discovery - Documentation
  • IBM Discovery - Demo
-

Language Translator

+

Language Translator V2

+ +

Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

@@ -461,6 +464,25 @@

Language Translator

let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} + +

Language Translator V3

+ +

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

+ +

The following example demonstrates how to use the Language Translator service:

+
import LanguageTranslatorV3
+
+let username = "your-username-here"
+let password = "your-password-here"
+let version = "yyyy-mm-dd" // use today's date for the most recent version
+let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
+
 let failure = { (error: Error) in print(error) }
 let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
 languageTranslator.translate(request: request, failure: failure) {
@@ -851,7 +873,7 @@ 

Visual Recognition

let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -859,6 +881,10 @@

Visual Recognition

print(classifiedImages) }
+ +

Note: a different initializer is used for authentication with instances created before May 23, 2018:

+
let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
+

Using Core ML

The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

@@ -910,7 +936,7 @@

Bundlin diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/search.json b/docs/swift-api/services/NaturalLanguageClassifierV1/search.json index 1065c4731..1dd1d5391 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/search.json +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/search.json @@ -1 +1 @@ -{"Structs/CollectionItem.html#/s:27NaturalLanguageClassifierV114CollectionItemV4textSSSgvp":{"name":"text","abstract":"

The submitted phrase.

","parent_name":"CollectionItem"},"Structs/CollectionItem.html#/s:27NaturalLanguageClassifierV114CollectionItemV8topClassSSSgvp":{"name":"topClass","abstract":"

The class with the highest confidence.

","parent_name":"CollectionItem"},"Structs/CollectionItem.html#/s:27NaturalLanguageClassifierV114CollectionItemV7classesSayAA15ClassifiedClassVGSgvp":{"name":"classes","abstract":"

An array of up to ten class-confidence pairs sorted in descending order of confidence.

","parent_name":"CollectionItem"},"Structs/ClassifyInput.html#/s:27NaturalLanguageClassifierV113ClassifyInputV4textSSvp":{"name":"text","abstract":"

The submitted phrase.

","parent_name":"ClassifyInput"},"Structs/ClassifyInput.html#/s:27NaturalLanguageClassifierV113ClassifyInputVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a ClassifyInput with member variables.

","parent_name":"ClassifyInput"},"Structs/ClassifyCollectionInput.html#/s:27NaturalLanguageClassifierV123ClassifyCollectionInputV10collectionSayAA0eG0VGvp":{"name":"collection","abstract":"

The submitted phrases.

","parent_name":"ClassifyCollectionInput"},"Structs/ClassifyCollectionInput.html#/s:27NaturalLanguageClassifierV123ClassifyCollectionInputVACSayAA0eG0VG10collection_tcfc":{"name":"init(collection:)","abstract":"

Initialize a ClassifyCollectionInput with member variables.

","parent_name":"ClassifyCollectionInput"},"Structs/ClassifierList.html#/s:27NaturalLanguageClassifierV10C4ListV11classifiersSayAA0C0VGvp":{"name":"classifiers","abstract":"

The classifiers available to the user. Returns an empty array if no classifiers are available.

","parent_name":"ClassifierList"},"Structs/Classifier/Status.html#/s:27NaturalLanguageClassifierV10C0V6StatusO11nonExistentA2EmF":{"name":"nonExistent","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Classifier/Status.html#/s:27NaturalLanguageClassifierV10C0V6StatusO8trainingA2EmF":{"name":"training","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Classifier/Status.html#/s:27NaturalLanguageClassifierV10C0V6StatusO6failedA2EmF":{"name":"failed","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Classifier/Status.html#/s:27NaturalLanguageClassifierV10C0V6StatusO9availableA2EmF":{"name":"available","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Classifier/Status.html#/s:27NaturalLanguageClassifierV10C0V6StatusO11unavailableA2EmF":{"name":"unavailable","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Classifier/Status.html":{"name":"Status","abstract":"

The state of the classifier.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V4nameSSSgvp":{"name":"name","abstract":"

User-supplied name for the classifier.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V3urlSSvp":{"name":"url","abstract":"

Link to the classifier.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V6statusSSSgvp":{"name":"status","abstract":"

The state of the classifier.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V12classifierIDSSvp":{"name":"classifierID","abstract":"

Unique identifier for this classifier.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V7createdSSSgvp":{"name":"created","abstract":"

Date and time (UTC) the classifier was created.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V17statusDescriptionSSSgvp":{"name":"statusDescription","abstract":"

Additional detail about the status.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V8languageSSSgvp":{"name":"language","abstract":"

The language used for the classifier.

","parent_name":"Classifier"},"Structs/ClassifiedClass.html#/s:27NaturalLanguageClassifierV115ClassifiedClassV10confidenceSdSgvp":{"name":"confidence","abstract":"

A decimal percentage that represents the confidence that Watson has in this class. Higher values represent higher confidences.

","parent_name":"ClassifiedClass"},"Structs/ClassifiedClass.html#/s:27NaturalLanguageClassifierV115ClassifiedClassV9classNameSSSgvp":{"name":"className","abstract":"

Class label.

","parent_name":"ClassifiedClass"},"Structs/ClassificationCollection.html#/s:27NaturalLanguageClassifierV124ClassificationCollectionV12classifierIDSSSgvp":{"name":"classifierID","abstract":"

Unique identifier for this classifier.

","parent_name":"ClassificationCollection"},"Structs/ClassificationCollection.html#/s:27NaturalLanguageClassifierV124ClassificationCollectionV3urlSSSgvp":{"name":"url","abstract":"

Link to the classifier.

","parent_name":"ClassificationCollection"},"Structs/ClassificationCollection.html#/s:27NaturalLanguageClassifierV124ClassificationCollectionV10collectionSayAA0F4ItemVGSgvp":{"name":"collection","abstract":"

An array of classifier responses for each submitted phrase.

","parent_name":"ClassificationCollection"},"Structs/Classification.html#/s:27NaturalLanguageClassifierV114ClassificationV12classifierIDSSSgvp":{"name":"classifierID","abstract":"

Unique identifier for this classifier.

","parent_name":"Classification"},"Structs/Classification.html#/s:27NaturalLanguageClassifierV114ClassificationV3urlSSSgvp":{"name":"url","abstract":"

Link to the classifier.

","parent_name":"Classification"},"Structs/Classification.html#/s:27NaturalLanguageClassifierV114ClassificationV4textSSSgvp":{"name":"text","abstract":"

The submitted phrase.

","parent_name":"Classification"},"Structs/Classification.html#/s:27NaturalLanguageClassifierV114ClassificationV8topClassSSSgvp":{"name":"topClass","abstract":"

The class with the highest confidence.

","parent_name":"Classification"},"Structs/Classification.html#/s:27NaturalLanguageClassifierV114ClassificationV7classesSayAA15ClassifiedClassVGSgvp":{"name":"classes","abstract":"

An array of up to ten class-confidence pairs sorted in descending order of confidence.

","parent_name":"Classification"},"Structs/Classification.html":{"name":"Classification","abstract":"

Response from the classifier for a phrase.

"},"Structs/ClassificationCollection.html":{"name":"ClassificationCollection","abstract":"

Response from the classifier for multiple phrases.

"},"Structs/ClassifiedClass.html":{"name":"ClassifiedClass","abstract":"

Class and confidence.

"},"Structs/Classifier.html":{"name":"Classifier","abstract":"

A classifier for natural language phrases.

"},"Structs/ClassifierList.html":{"name":"ClassifierList","abstract":"

List of available classifiers.

"},"Structs/ClassifyCollectionInput.html":{"name":"ClassifyCollectionInput","abstract":"

Request payload to classify.

"},"Structs/ClassifyInput.html":{"name":"ClassifyInput","abstract":"

Request payload to classify.

"},"Structs/CollectionItem.html":{"name":"CollectionItem","abstract":"

Response from the classifier for a phrase in a collection.

"},"Structs.html#/s:27NaturalLanguageClassifierV111JSONWrapperV":{"name":"JSONWrapper","abstract":"

Used internally to serialize and deserialize JSON."},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO013serializationF0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO08encodingF0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO011fileManagerF0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0CACSS8username_SS8passwordtcfc":{"name":"init(username:password:)","abstract":"

Create a NaturalLanguageClassifier object.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C8classifyySS12classifierID_SS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA14ClassificationVc7successtF":{"name":"classify(classifierID:text:headers:failure:success:)","abstract":"

Classify a phrase.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C18classifyCollectionySS12classifierID_SayAA13ClassifyInputVG10collections10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA014ClassificationF0Vc7successtF":{"name":"classifyCollection(classifierID:collection:headers:failure:success:)","abstract":"

Classify multiple phrases.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C06createC0y10Foundation3URLV8metadata_AG12trainingDatas10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0C0Vc7successtF":{"name":"createClassifier(metadata:trainingData:headers:failure:success:)","abstract":"

Create classifier.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C15listClassifiersys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA0C4ListVc7successtF":{"name":"listClassifiers(headers:failure:success:)","abstract":"

List classifiers.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C03getC0ySS12classifierID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0C0Vc7successtF":{"name":"getClassifier(classifierID:headers:failure:success:)","abstract":"

Get information about a classifier.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C06deleteC0ySS12classifierID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteClassifier(classifierID:headers:failure:success:)","abstract":"

Delete classifier.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html":{"name":"NaturalLanguageClassifier","abstract":"

IBM Watson Natural Language Classifier uses machine learning algorithms to return the top matching predefined classes"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file +{"Structs/CollectionItem.html#/s:27NaturalLanguageClassifierV114CollectionItemV4textSSSgvp":{"name":"text","abstract":"

The submitted phrase.

","parent_name":"CollectionItem"},"Structs/CollectionItem.html#/s:27NaturalLanguageClassifierV114CollectionItemV8topClassSSSgvp":{"name":"topClass","abstract":"

The class with the highest confidence.

","parent_name":"CollectionItem"},"Structs/CollectionItem.html#/s:27NaturalLanguageClassifierV114CollectionItemV7classesSayAA15ClassifiedClassVGSgvp":{"name":"classes","abstract":"

An array of up to ten class-confidence pairs sorted in descending order of confidence.

","parent_name":"CollectionItem"},"Structs/ClassifyInput.html#/s:27NaturalLanguageClassifierV113ClassifyInputV4textSSvp":{"name":"text","abstract":"

The submitted phrase.

","parent_name":"ClassifyInput"},"Structs/ClassifyInput.html#/s:27NaturalLanguageClassifierV113ClassifyInputVACSS4text_tcfc":{"name":"init(text:)","abstract":"

Initialize a ClassifyInput with member variables.

","parent_name":"ClassifyInput"},"Structs/ClassifyCollectionInput.html#/s:27NaturalLanguageClassifierV123ClassifyCollectionInputV10collectionSayAA0eG0VGvp":{"name":"collection","abstract":"

The submitted phrases.

","parent_name":"ClassifyCollectionInput"},"Structs/ClassifyCollectionInput.html#/s:27NaturalLanguageClassifierV123ClassifyCollectionInputVACSayAA0eG0VG10collection_tcfc":{"name":"init(collection:)","abstract":"

Initialize a ClassifyCollectionInput with member variables.

","parent_name":"ClassifyCollectionInput"},"Structs/ClassifierList.html#/s:27NaturalLanguageClassifierV10C4ListV11classifiersSayAA0C0VGvp":{"name":"classifiers","abstract":"

The classifiers available to the user. Returns an empty array if no classifiers are available.

","parent_name":"ClassifierList"},"Structs/Classifier/Status.html#/s:27NaturalLanguageClassifierV10C0V6StatusO11nonExistentA2EmF":{"name":"nonExistent","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Classifier/Status.html#/s:27NaturalLanguageClassifierV10C0V6StatusO8trainingA2EmF":{"name":"training","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Classifier/Status.html#/s:27NaturalLanguageClassifierV10C0V6StatusO6failedA2EmF":{"name":"failed","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Classifier/Status.html#/s:27NaturalLanguageClassifierV10C0V6StatusO9availableA2EmF":{"name":"available","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Classifier/Status.html#/s:27NaturalLanguageClassifierV10C0V6StatusO11unavailableA2EmF":{"name":"unavailable","abstract":"

Undocumented

","parent_name":"Status"},"Structs/Classifier/Status.html":{"name":"Status","abstract":"

The state of the classifier.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V4nameSSSgvp":{"name":"name","abstract":"

User-supplied name for the classifier.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V3urlSSvp":{"name":"url","abstract":"

Link to the classifier.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V6statusSSSgvp":{"name":"status","abstract":"

The state of the classifier.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V12classifierIDSSvp":{"name":"classifierID","abstract":"

Unique identifier for this classifier.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V7createdSSSgvp":{"name":"created","abstract":"

Date and time (UTC) the classifier was created.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V17statusDescriptionSSSgvp":{"name":"statusDescription","abstract":"

Additional detail about the status.

","parent_name":"Classifier"},"Structs/Classifier.html#/s:27NaturalLanguageClassifierV10C0V8languageSSSgvp":{"name":"language","abstract":"

The language used for the classifier.

","parent_name":"Classifier"},"Structs/ClassifiedClass.html#/s:27NaturalLanguageClassifierV115ClassifiedClassV10confidenceSdSgvp":{"name":"confidence","abstract":"

A decimal percentage that represents the confidence that Watson has in this class. Higher values represent higher","parent_name":"ClassifiedClass"},"Structs/ClassifiedClass.html#/s:27NaturalLanguageClassifierV115ClassifiedClassV9classNameSSSgvp":{"name":"className","abstract":"

Class label.

","parent_name":"ClassifiedClass"},"Structs/ClassificationCollection.html#/s:27NaturalLanguageClassifierV124ClassificationCollectionV12classifierIDSSSgvp":{"name":"classifierID","abstract":"

Unique identifier for this classifier.

","parent_name":"ClassificationCollection"},"Structs/ClassificationCollection.html#/s:27NaturalLanguageClassifierV124ClassificationCollectionV3urlSSSgvp":{"name":"url","abstract":"

Link to the classifier.

","parent_name":"ClassificationCollection"},"Structs/ClassificationCollection.html#/s:27NaturalLanguageClassifierV124ClassificationCollectionV10collectionSayAA0F4ItemVGSgvp":{"name":"collection","abstract":"

An array of classifier responses for each submitted phrase.

","parent_name":"ClassificationCollection"},"Structs/Classification.html#/s:27NaturalLanguageClassifierV114ClassificationV12classifierIDSSSgvp":{"name":"classifierID","abstract":"

Unique identifier for this classifier.

","parent_name":"Classification"},"Structs/Classification.html#/s:27NaturalLanguageClassifierV114ClassificationV3urlSSSgvp":{"name":"url","abstract":"

Link to the classifier.

","parent_name":"Classification"},"Structs/Classification.html#/s:27NaturalLanguageClassifierV114ClassificationV4textSSSgvp":{"name":"text","abstract":"

The submitted phrase.

","parent_name":"Classification"},"Structs/Classification.html#/s:27NaturalLanguageClassifierV114ClassificationV8topClassSSSgvp":{"name":"topClass","abstract":"

The class with the highest confidence.

","parent_name":"Classification"},"Structs/Classification.html#/s:27NaturalLanguageClassifierV114ClassificationV7classesSayAA15ClassifiedClassVGSgvp":{"name":"classes","abstract":"

An array of up to ten class-confidence pairs sorted in descending order of confidence.

","parent_name":"Classification"},"Structs/Classification.html":{"name":"Classification","abstract":"

Response from the classifier for a phrase.

"},"Structs/ClassificationCollection.html":{"name":"ClassificationCollection","abstract":"

Response from the classifier for multiple phrases.

"},"Structs/ClassifiedClass.html":{"name":"ClassifiedClass","abstract":"

Class and confidence.

"},"Structs/Classifier.html":{"name":"Classifier","abstract":"

A classifier for natural language phrases.

"},"Structs/ClassifierList.html":{"name":"ClassifierList","abstract":"

List of available classifiers.

"},"Structs/ClassifyCollectionInput.html":{"name":"ClassifyCollectionInput","abstract":"

Request payload to classify.

"},"Structs/ClassifyInput.html":{"name":"ClassifyInput","abstract":"

Request payload to classify.

"},"Structs/CollectionItem.html":{"name":"CollectionItem","abstract":"

Response from the classifier for a phrase in a collection.

"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO013serializationF0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO08encodingF0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO011fileManagerF0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:27NaturalLanguageClassifierV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:27NaturalLanguageClassifierV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0CACSS8username_SS8passwordtcfc":{"name":"init(username:password:)","abstract":"

Create a NaturalLanguageClassifier object.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C8classifyySS12classifierID_SS4texts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA14ClassificationVc7successtF":{"name":"classify(classifierID:text:headers:failure:success:)","abstract":"

Classify a phrase.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C18classifyCollectionySS12classifierID_SayAA13ClassifyInputVG10collections10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA014ClassificationF0Vc7successtF":{"name":"classifyCollection(classifierID:collection:headers:failure:success:)","abstract":"

Classify multiple phrases.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C06createC0y10Foundation3URLV8metadata_AG12trainingDatas10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0C0Vc7successtF":{"name":"createClassifier(metadata:trainingData:headers:failure:success:)","abstract":"

Create classifier.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C15listClassifiersys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA0C4ListVc7successtF":{"name":"listClassifiers(headers:failure:success:)","abstract":"

List classifiers.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C03getC0ySS12classifierID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0C0Vc7successtF":{"name":"getClassifier(classifierID:headers:failure:success:)","abstract":"

Get information about a classifier.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html#/s:27NaturalLanguageClassifierV10abC0C06deleteC0ySS12classifierID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteClassifier(classifierID:headers:failure:success:)","abstract":"

Delete classifier.

","parent_name":"NaturalLanguageClassifier"},"Classes/NaturalLanguageClassifier.html":{"name":"NaturalLanguageClassifier","abstract":"

IBM Watson™ Natural Language Classifier uses machine learning algorithms to return the top matching predefined"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file diff --git a/docs/swift-api/services/NaturalLanguageClassifierV1/undocumented.json b/docs/swift-api/services/NaturalLanguageClassifierV1/undocumented.json index d3d5de255..1837d55d2 100644 --- a/docs/swift-api/services/NaturalLanguageClassifierV1/undocumented.json +++ b/docs/swift-api/services/NaturalLanguageClassifierV1/undocumented.json @@ -2,35 +2,35 @@ "warnings": [ { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/NaturalLanguageClassifierV1/Models/Classifier.swift", - "line": 24, + "line": 26, "symbol": "Classifier.Status.nonExistent", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/NaturalLanguageClassifierV1/Models/Classifier.swift", - "line": 25, + "line": 27, "symbol": "Classifier.Status.training", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/NaturalLanguageClassifierV1/Models/Classifier.swift", - "line": 26, + "line": 28, "symbol": "Classifier.Status.failed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/NaturalLanguageClassifierV1/Models/Classifier.swift", - "line": 27, + "line": 29, "symbol": "Classifier.Status.available", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/NaturalLanguageClassifierV1/Models/Classifier.swift", - "line": 28, + "line": 30, "symbol": "Classifier.Status.unavailable", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Classes.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Classes.html index 7b31311d4..3e23ffa28 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Classes.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Classes.html @@ -107,9 +107,6 @@ - @@ -235,7 +232,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Classes/NaturalLanguageUnderstanding.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Classes/NaturalLanguageUnderstanding.html index aa39d2f84..9d7557991 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Classes/NaturalLanguageUnderstanding.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Classes/NaturalLanguageUnderstanding.html @@ -107,9 +107,6 @@ - @@ -505,23 +502,43 @@

Declaration

Analyze text, HTML, or a public webpage.

-

Analyzes text, HTML, or a public webpage with one or more text analysis features. ### Concepts Identify general -concepts that are referenced or alluded to in your content. Concepts that are detected typically have an associated -link to a DBpedia resource. ### Emotion Detect anger, disgust, fear, joy, or sadness that is conveyed by your -content. Emotion information can be returned for detected entities, keywords, or user-specified target phrases -found in the text. ### Entities Detect important people, places, geopolitical entities and other types of entities -in your content. Entity detection recognizes consecutive coreferences of each entity. For example, analysis of the -following text would count \Barack Obama\ and \He\ as the same entity: \Barack Obama was the 44th President -of the United States. He took office in January 2009.\ ### Keywords Determine the most important keywords in your -content. Keyword phrases are organized by relevance in the results. ### Metadata Get author information, -publication date, and the title of your text/HTML content. ### Relations Recognize when two entities are related, -and identify the type of relation. For example, you can identify an \awardedTo\ relation between an award and -its recipient. ### Semantic Roles Parse sentences into subject-action-object form, and identify entities and -keywords that are subjects or objects of an action. ### Sentiment Determine whether your content conveys postive -or negative sentiment. Sentiment information can be returned for detected entities, keywords, or user-specified -target phrases found in the text. ### Categories Categorize your content into a hierarchical 5-level taxonomy. -For example, \Leonardo DiCaprio won an Oscar\ returns \/art and entertainment/movies and tv/movies\ as the most -confident classification.

+

Analyzes text, HTML, or a public webpage with one or more text analysis features.

+

Concepts

+ +

Identify general concepts that are referenced or alluded to in your content. Concepts that are detected typically +have an associated link to a DBpedia resource.

+

Emotion

+ +

Detect anger, disgust, fear, joy, or sadness that is conveyed by your content. Emotion information can be returned +for detected entities, keywords, or user-specified target phrases found in the text.

+

Entities

+ +

Detect important people, places, geopolitical entities and other types of entities in your content. Entity +detection recognizes consecutive coreferences of each entity. For example, analysis of the following text would +count \Barack Obama\ and \He\ as the same entity: +\Barack Obama was the 44th President of the United States. He took office in January 2009.\

+

Keywords

+ +

Determine the most important keywords in your content. Keyword phrases are organized by relevance in the results.

+

Metadata

+ +

Get author information, publication date, and the title of your text/HTML content.

+

Relations

+ +

Recognize when two entities are related, and identify the type of relation. For example, you can identify an +\awardedTo\ relation between an award and its recipient.

+

Semantic Roles

+ +

Parse sentences into subject-action-object form, and identify entities and keywords that are subjects or objects of +an action.

+

Sentiment

+ +

Determine whether your content conveys postive or negative sentiment. Sentiment information can be returned for +detected entities, keywords, or user-specified target phrases found in the text.

+

Categories

+ +

Categorize your content into a hierarchical 5-level taxonomy. For example, \Leonardo DiCaprio won an Oscar\ +returns \/art and entertainment/movies and tv/movies\ as the most confident classification.

@@ -764,7 +781,7 @@

Parameters

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Enums.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Enums.html index 69c8dce0a..c3c5388e8 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Enums.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Enums.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Enums/JSON.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Enums/JSON.html index 6a10f1d03..beedf21cb 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Enums/JSON.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Enums/JSON.html @@ -107,9 +107,6 @@ - @@ -531,7 +528,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Enums/RestError.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Enums/RestError.html index 2fa5e58a8..4004abc39 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Enums/RestError.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Enums/RestError.html @@ -107,9 +107,6 @@ - @@ -398,7 +395,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs.html index 547e135eb..7a8c71521 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs.html @@ -107,9 +107,6 @@ - @@ -1570,49 +1567,10 @@

Declaration

-
-
- - - -

JSON

-
-
-
    -
  • -
    - - - - JSONWrapper - -
    -
    -
    -
    -
    -
    -

    Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct JSONWrapper
    - -
    -
    -
    -
    -
  • -
-
diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/AnalysisResults.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/AnalysisResults.html index b29d06497..a8d83c6f2 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/AnalysisResults.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/AnalysisResults.html @@ -107,9 +107,6 @@ - @@ -558,7 +555,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Author.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Author.html index 8888eeb1a..537e31da0 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Author.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Author.html @@ -107,9 +107,6 @@ - @@ -234,7 +231,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/CategoriesOptions.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/CategoriesOptions.html index b63432125..5d6d69993 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/CategoriesOptions.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/CategoriesOptions.html @@ -107,9 +107,6 @@ - @@ -249,7 +246,9 @@

Declaration

Declaration

Swift

-
public init(additionalProperties: [String: JSON] = [:])
+
public init(
+    additionalProperties: [String: JSON] = [:]
+)
@@ -291,7 +290,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/CategoriesResult.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/CategoriesResult.html index 5a2e9bd6b..b0005bf72 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/CategoriesResult.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/CategoriesResult.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/ConceptsOptions.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/ConceptsOptions.html index 08c8b86bb..365afb5e1 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/ConceptsOptions.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/ConceptsOptions.html @@ -107,9 +107,6 @@ - @@ -249,7 +246,9 @@

Declaration

Declaration

Swift

-
public init(limit: Int? = nil)
+
public init(
+    limit: Int? = nil
+)
@@ -284,7 +283,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/ConceptsResult.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/ConceptsResult.html index 280d48635..e984b2952 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/ConceptsResult.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/ConceptsResult.html @@ -107,9 +107,6 @@ - @@ -288,7 +285,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/DeleteModelResults.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/DeleteModelResults.html index d5dc5c847..2b597b0a9 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/DeleteModelResults.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/DeleteModelResults.html @@ -107,9 +107,6 @@ - @@ -234,7 +231,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/DisambiguationResult.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/DisambiguationResult.html index 25f6bcc9d..63de57b8a 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/DisambiguationResult.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/DisambiguationResult.html @@ -107,9 +107,6 @@ - @@ -288,7 +285,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/DocumentEmotionResults.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/DocumentEmotionResults.html index 91897aea3..faea91080 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/DocumentEmotionResults.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/DocumentEmotionResults.html @@ -107,9 +107,6 @@ - @@ -234,7 +231,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/DocumentSentimentResults.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/DocumentSentimentResults.html index 4464e38f7..dd4c14606 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/DocumentSentimentResults.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/DocumentSentimentResults.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EmotionOptions.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EmotionOptions.html index f004501d0..eb4ce57d7 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EmotionOptions.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EmotionOptions.html @@ -107,9 +107,6 @@ - @@ -276,7 +273,10 @@

Declaration

Declaration

Swift

-
public init(document: Bool? = nil, targets: [String]? = nil)
+
public init(
+    document: Bool? = nil,
+    targets: [String]? = nil
+)
@@ -323,7 +323,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EmotionResult.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EmotionResult.html index d9a19c0f6..59f1de155 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EmotionResult.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EmotionResult.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EmotionScores.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EmotionScores.html index 7e1410a88..8abeaf30b 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EmotionScores.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EmotionScores.html @@ -107,9 +107,6 @@ - @@ -342,7 +339,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EntitiesOptions.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EntitiesOptions.html index 97670f04f..145e3cb55 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EntitiesOptions.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EntitiesOptions.html @@ -107,9 +107,6 @@ - @@ -357,7 +354,13 @@

Declaration

Declaration

Swift

-
public init(limit: Int? = nil, mentions: Bool? = nil, model: String? = nil, sentiment: Bool? = nil, emotion: Bool? = nil)
+
public init(
+    limit: Int? = nil,
+    mentions: Bool? = nil,
+    model: String? = nil,
+    sentiment: Bool? = nil,
+    emotion: Bool? = nil
+)
@@ -440,7 +443,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EntitiesResult.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EntitiesResult.html index 42edd7324..27300cb28 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EntitiesResult.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EntitiesResult.html @@ -107,9 +107,6 @@ - @@ -423,7 +420,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EntityMention.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EntityMention.html index a54073764..ad6bd41dd 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EntityMention.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/EntityMention.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/FeatureSentimentResults.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/FeatureSentimentResults.html index 773594cab..d29ea8768 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/FeatureSentimentResults.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/FeatureSentimentResults.html @@ -107,9 +107,6 @@ - @@ -234,7 +231,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Features.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Features.html index 058eba0e7..6e73cae03 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Features.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Features.html @@ -107,9 +107,6 @@ - @@ -323,7 +320,8 @@

Declaration

-

Whether or not the author, publication date, and title of the analyzed text should be returned. This parameter is only available for URL and HTML input.

+

Whether or not the author, publication date, and title of the analyzed text should be returned. This parameter is +only available for URL and HTML input.

@@ -465,7 +463,17 @@

Declaration

Declaration

Swift

-
public init(concepts: ConceptsOptions? = nil, emotion: EmotionOptions? = nil, entities: EntitiesOptions? = nil, keywords: KeywordsOptions? = nil, metadata: MetadataOptions? = nil, relations: RelationsOptions? = nil, semanticRoles: SemanticRolesOptions? = nil, sentiment: SentimentOptions? = nil, categories: CategoriesOptions? = nil)
+
public init(
+    concepts: ConceptsOptions? = nil,
+    emotion: EmotionOptions? = nil,
+    entities: EntitiesOptions? = nil,
+    keywords: KeywordsOptions? = nil,
+    metadata: MetadataOptions? = nil,
+    relations: RelationsOptions? = nil,
+    semanticRoles: SemanticRolesOptions? = nil,
+    sentiment: SentimentOptions? = nil,
+    categories: CategoriesOptions? = nil
+)
@@ -529,7 +537,8 @@

Parameters

-

Whether or not the author, publication date, and title of the analyzed text should be returned. This parameter is only available for URL and HTML input.

+

Whether or not the author, publication date, and title of the analyzed text should be returned. This parameter is +only available for URL and HTML input.

@@ -596,7 +605,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Feed.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Feed.html index 94c54501c..9ee391a22 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Feed.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Feed.html @@ -107,9 +107,6 @@ - @@ -234,7 +231,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/KeywordsOptions.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/KeywordsOptions.html index cd6c393a7..a3b426ddc 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/KeywordsOptions.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/KeywordsOptions.html @@ -107,9 +107,6 @@ - @@ -303,7 +300,11 @@

Declaration

Declaration

Swift

-
public init(limit: Int? = nil, sentiment: Bool? = nil, emotion: Bool? = nil)
+
public init(
+    limit: Int? = nil,
+    sentiment: Bool? = nil,
+    emotion: Bool? = nil
+)
@@ -362,7 +363,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/KeywordsResult.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/KeywordsResult.html index 9b9336450..d41a37ab8 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/KeywordsResult.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/KeywordsResult.html @@ -107,9 +107,6 @@ - @@ -315,7 +312,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/ListModelsResults.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/ListModelsResults.html index c68bd299c..e7f521a89 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/ListModelsResults.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/ListModelsResults.html @@ -107,9 +107,6 @@ - @@ -234,7 +231,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/MetadataOptions.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/MetadataOptions.html index c5384f45f..d7c1f4cb8 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/MetadataOptions.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/MetadataOptions.html @@ -107,9 +107,6 @@ - @@ -249,7 +246,9 @@

Declaration

Declaration

Swift

-
public init(additionalProperties: [String: JSON] = [:])
+
public init(
+    additionalProperties: [String: JSON] = [:]
+)
@@ -291,7 +290,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/MetadataResult.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/MetadataResult.html index 100f3846d..0b9c8a2cc 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/MetadataResult.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/MetadataResult.html @@ -107,9 +107,6 @@ - @@ -342,7 +339,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Model.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Model.html index 1375429dc..14f20a558 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Model.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Model.html @@ -107,9 +107,6 @@ - @@ -315,7 +312,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Parameters.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Parameters.html index acec779d6..b38dbbd52 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Parameters.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Parameters.html @@ -107,9 +107,6 @@ - @@ -492,7 +489,18 @@

Declaration

Declaration

Swift

-
public init(features: Features, text: String? = nil, html: String? = nil, url: String? = nil, clean: Bool? = nil, xpath: String? = nil, fallbackToRaw: Bool? = nil, returnAnalyzedText: Bool? = nil, language: String? = nil, limitTextCharacters: Int? = nil)
+
public init(
+    features: Features,
+    text: String? = nil,
+    html: String? = nil,
+    url: String? = nil,
+    clean: Bool? = nil,
+    xpath: String? = nil,
+    fallbackToRaw: Bool? = nil,
+    returnAnalyzedText: Bool? = nil,
+    language: String? = nil,
+    limitTextCharacters: Int? = nil
+)
@@ -635,7 +643,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/RelationArgument.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/RelationArgument.html index fbfae924c..1edca4929 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/RelationArgument.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/RelationArgument.html @@ -107,9 +107,6 @@ - @@ -288,7 +285,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/RelationEntity.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/RelationEntity.html index 433de89ca..713729bd7 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/RelationEntity.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/RelationEntity.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/RelationsOptions.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/RelationsOptions.html index 444c945b8..2b5f27818 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/RelationsOptions.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/RelationsOptions.html @@ -107,9 +107,6 @@ - @@ -249,7 +246,9 @@

Declaration

Declaration

Swift

-
public init(model: String? = nil)
+
public init(
+    model: String? = nil
+)
@@ -284,7 +283,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/RelationsResult.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/RelationsResult.html index 73f6e416e..769e479f7 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/RelationsResult.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/RelationsResult.html @@ -107,9 +107,6 @@ - @@ -315,7 +312,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesAction.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesAction.html index 9f5d6c85d..b131d1a55 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesAction.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesAction.html @@ -107,9 +107,6 @@ - @@ -288,7 +285,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesEntity.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesEntity.html index d7d2bbc1c..c251d5519 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesEntity.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesEntity.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesKeyword.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesKeyword.html index 5dcdbaa88..415479e71 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesKeyword.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesKeyword.html @@ -107,9 +107,6 @@ - @@ -234,7 +231,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesObject.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesObject.html index 8f120880a..fb4b5d92e 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesObject.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesObject.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesOptions.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesOptions.html index 2ffe3e994..4d94f9489 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesOptions.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesOptions.html @@ -107,9 +107,6 @@ - @@ -303,7 +300,11 @@

Declaration

Declaration

Swift

-
public init(limit: Int? = nil, keywords: Bool? = nil, entities: Bool? = nil)
+
public init(
+    limit: Int? = nil,
+    keywords: Bool? = nil,
+    entities: Bool? = nil
+)
@@ -362,7 +363,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesResult.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesResult.html index ae0028cae..d92b9aea1 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesResult.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesResult.html @@ -107,9 +107,6 @@ - @@ -315,7 +312,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesSubject.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesSubject.html index 3bf3832e2..5332f1fda 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesSubject.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesSubject.html @@ -107,9 +107,6 @@ - @@ -288,7 +285,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesVerb.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesVerb.html index d8c39942b..0cec57088 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesVerb.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SemanticRolesVerb.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SentimentOptions.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SentimentOptions.html index ca7d24ae3..57b5e277d 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SentimentOptions.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SentimentOptions.html @@ -107,9 +107,6 @@ - @@ -276,7 +273,10 @@

Declaration

Declaration

Swift

-
public init(document: Bool? = nil, targets: [String]? = nil)
+
public init(
+    document: Bool? = nil,
+    targets: [String]? = nil
+)
@@ -323,7 +323,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SentimentResult.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SentimentResult.html index de0b9b530..16918a5dc 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SentimentResult.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/SentimentResult.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/TargetedEmotionResults.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/TargetedEmotionResults.html index b5f919f70..4156ff3bb 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/TargetedEmotionResults.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/TargetedEmotionResults.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/TargetedSentimentResults.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/TargetedSentimentResults.html index c97e12266..abb057e9f 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/TargetedSentimentResults.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/TargetedSentimentResults.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Usage.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Usage.html index 5f4ba6cae..f49260fb4 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Usage.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/Structs/Usage.html @@ -107,9 +107,6 @@ - @@ -288,7 +285,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Classes.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Classes.html index 7b31311d4..3e23ffa28 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Classes.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Classes.html @@ -107,9 +107,6 @@ - @@ -235,7 +232,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Classes/NaturalLanguageUnderstanding.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Classes/NaturalLanguageUnderstanding.html index aa39d2f84..9d7557991 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Classes/NaturalLanguageUnderstanding.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Classes/NaturalLanguageUnderstanding.html @@ -107,9 +107,6 @@ - @@ -505,23 +502,43 @@

Declaration

Analyze text, HTML, or a public webpage.

-

Analyzes text, HTML, or a public webpage with one or more text analysis features. ### Concepts Identify general -concepts that are referenced or alluded to in your content. Concepts that are detected typically have an associated -link to a DBpedia resource. ### Emotion Detect anger, disgust, fear, joy, or sadness that is conveyed by your -content. Emotion information can be returned for detected entities, keywords, or user-specified target phrases -found in the text. ### Entities Detect important people, places, geopolitical entities and other types of entities -in your content. Entity detection recognizes consecutive coreferences of each entity. For example, analysis of the -following text would count \Barack Obama\ and \He\ as the same entity: \Barack Obama was the 44th President -of the United States. He took office in January 2009.\ ### Keywords Determine the most important keywords in your -content. Keyword phrases are organized by relevance in the results. ### Metadata Get author information, -publication date, and the title of your text/HTML content. ### Relations Recognize when two entities are related, -and identify the type of relation. For example, you can identify an \awardedTo\ relation between an award and -its recipient. ### Semantic Roles Parse sentences into subject-action-object form, and identify entities and -keywords that are subjects or objects of an action. ### Sentiment Determine whether your content conveys postive -or negative sentiment. Sentiment information can be returned for detected entities, keywords, or user-specified -target phrases found in the text. ### Categories Categorize your content into a hierarchical 5-level taxonomy. -For example, \Leonardo DiCaprio won an Oscar\ returns \/art and entertainment/movies and tv/movies\ as the most -confident classification.

+

Analyzes text, HTML, or a public webpage with one or more text analysis features.

+

Concepts

+ +

Identify general concepts that are referenced or alluded to in your content. Concepts that are detected typically +have an associated link to a DBpedia resource.

+

Emotion

+ +

Detect anger, disgust, fear, joy, or sadness that is conveyed by your content. Emotion information can be returned +for detected entities, keywords, or user-specified target phrases found in the text.

+

Entities

+ +

Detect important people, places, geopolitical entities and other types of entities in your content. Entity +detection recognizes consecutive coreferences of each entity. For example, analysis of the following text would +count \Barack Obama\ and \He\ as the same entity: +\Barack Obama was the 44th President of the United States. He took office in January 2009.\

+

Keywords

+ +

Determine the most important keywords in your content. Keyword phrases are organized by relevance in the results.

+

Metadata

+ +

Get author information, publication date, and the title of your text/HTML content.

+

Relations

+ +

Recognize when two entities are related, and identify the type of relation. For example, you can identify an +\awardedTo\ relation between an award and its recipient.

+

Semantic Roles

+ +

Parse sentences into subject-action-object form, and identify entities and keywords that are subjects or objects of +an action.

+

Sentiment

+ +

Determine whether your content conveys postive or negative sentiment. Sentiment information can be returned for +detected entities, keywords, or user-specified target phrases found in the text.

+

Categories

+ +

Categorize your content into a hierarchical 5-level taxonomy. For example, \Leonardo DiCaprio won an Oscar\ +returns \/art and entertainment/movies and tv/movies\ as the most confident classification.

@@ -764,7 +781,7 @@

Parameters

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Enums.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Enums.html index 69c8dce0a..c3c5388e8 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Enums.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Enums.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html index 6a10f1d03..beedf21cb 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html @@ -107,9 +107,6 @@ - @@ -531,7 +528,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html index 2fa5e58a8..4004abc39 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html @@ -107,9 +107,6 @@ - @@ -398,7 +395,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs.html index 547e135eb..7a8c71521 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs.html @@ -107,9 +107,6 @@ - @@ -1570,49 +1567,10 @@

Declaration

-
-
- - - -

JSON

-
-
-
    -
  • -
    - - - - JSONWrapper - -
    -
    -
    -
    -
    -
    -

    Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct JSONWrapper
    - -
    -
    -
    -
    -
  • -
-
diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/AnalysisResults.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/AnalysisResults.html index b29d06497..a8d83c6f2 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/AnalysisResults.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/AnalysisResults.html @@ -107,9 +107,6 @@ - @@ -558,7 +555,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Author.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Author.html index 8888eeb1a..537e31da0 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Author.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Author.html @@ -107,9 +107,6 @@ - @@ -234,7 +231,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/CategoriesOptions.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/CategoriesOptions.html index b63432125..5d6d69993 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/CategoriesOptions.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/CategoriesOptions.html @@ -107,9 +107,6 @@ - @@ -249,7 +246,9 @@

Declaration

Declaration

Swift

-
public init(additionalProperties: [String: JSON] = [:])
+
public init(
+    additionalProperties: [String: JSON] = [:]
+)
@@ -291,7 +290,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/CategoriesResult.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/CategoriesResult.html index 5a2e9bd6b..b0005bf72 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/CategoriesResult.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/CategoriesResult.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/ConceptsOptions.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/ConceptsOptions.html index 08c8b86bb..365afb5e1 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/ConceptsOptions.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/ConceptsOptions.html @@ -107,9 +107,6 @@ - @@ -249,7 +246,9 @@

Declaration

Declaration

Swift

-
public init(limit: Int? = nil)
+
public init(
+    limit: Int? = nil
+)
@@ -284,7 +283,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/ConceptsResult.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/ConceptsResult.html index 280d48635..e984b2952 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/ConceptsResult.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/ConceptsResult.html @@ -107,9 +107,6 @@ - @@ -288,7 +285,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteModelResults.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteModelResults.html index d5dc5c847..2b597b0a9 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteModelResults.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/DeleteModelResults.html @@ -107,9 +107,6 @@ - @@ -234,7 +231,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/DisambiguationResult.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/DisambiguationResult.html index 25f6bcc9d..63de57b8a 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/DisambiguationResult.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/DisambiguationResult.html @@ -107,9 +107,6 @@ - @@ -288,7 +285,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentEmotionResults.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentEmotionResults.html index 91897aea3..faea91080 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentEmotionResults.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentEmotionResults.html @@ -107,9 +107,6 @@ - @@ -234,7 +231,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentSentimentResults.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentSentimentResults.html index 4464e38f7..dd4c14606 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentSentimentResults.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/DocumentSentimentResults.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EmotionOptions.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EmotionOptions.html index f004501d0..eb4ce57d7 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EmotionOptions.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EmotionOptions.html @@ -107,9 +107,6 @@ - @@ -276,7 +273,10 @@

Declaration

Declaration

Swift

-
public init(document: Bool? = nil, targets: [String]? = nil)
+
public init(
+    document: Bool? = nil,
+    targets: [String]? = nil
+)
@@ -323,7 +323,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EmotionResult.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EmotionResult.html index d9a19c0f6..59f1de155 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EmotionResult.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EmotionResult.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EmotionScores.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EmotionScores.html index 7e1410a88..8abeaf30b 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EmotionScores.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EmotionScores.html @@ -107,9 +107,6 @@ - @@ -342,7 +339,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EntitiesOptions.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EntitiesOptions.html index 97670f04f..145e3cb55 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EntitiesOptions.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EntitiesOptions.html @@ -107,9 +107,6 @@ - @@ -357,7 +354,13 @@

Declaration

Declaration

Swift

-
public init(limit: Int? = nil, mentions: Bool? = nil, model: String? = nil, sentiment: Bool? = nil, emotion: Bool? = nil)
+
public init(
+    limit: Int? = nil,
+    mentions: Bool? = nil,
+    model: String? = nil,
+    sentiment: Bool? = nil,
+    emotion: Bool? = nil
+)
@@ -440,7 +443,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EntitiesResult.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EntitiesResult.html index 42edd7324..27300cb28 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EntitiesResult.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EntitiesResult.html @@ -107,9 +107,6 @@ - @@ -423,7 +420,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EntityMention.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EntityMention.html index a54073764..ad6bd41dd 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EntityMention.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/EntityMention.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/FeatureSentimentResults.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/FeatureSentimentResults.html index 773594cab..d29ea8768 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/FeatureSentimentResults.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/FeatureSentimentResults.html @@ -107,9 +107,6 @@ - @@ -234,7 +231,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Features.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Features.html index 058eba0e7..6e73cae03 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Features.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Features.html @@ -107,9 +107,6 @@ - @@ -323,7 +320,8 @@

Declaration

-

Whether or not the author, publication date, and title of the analyzed text should be returned. This parameter is only available for URL and HTML input.

+

Whether or not the author, publication date, and title of the analyzed text should be returned. This parameter is +only available for URL and HTML input.

@@ -465,7 +463,17 @@

Declaration

Declaration

Swift

-
public init(concepts: ConceptsOptions? = nil, emotion: EmotionOptions? = nil, entities: EntitiesOptions? = nil, keywords: KeywordsOptions? = nil, metadata: MetadataOptions? = nil, relations: RelationsOptions? = nil, semanticRoles: SemanticRolesOptions? = nil, sentiment: SentimentOptions? = nil, categories: CategoriesOptions? = nil)
+
public init(
+    concepts: ConceptsOptions? = nil,
+    emotion: EmotionOptions? = nil,
+    entities: EntitiesOptions? = nil,
+    keywords: KeywordsOptions? = nil,
+    metadata: MetadataOptions? = nil,
+    relations: RelationsOptions? = nil,
+    semanticRoles: SemanticRolesOptions? = nil,
+    sentiment: SentimentOptions? = nil,
+    categories: CategoriesOptions? = nil
+)
@@ -529,7 +537,8 @@

Parameters

-

Whether or not the author, publication date, and title of the analyzed text should be returned. This parameter is only available for URL and HTML input.

+

Whether or not the author, publication date, and title of the analyzed text should be returned. This parameter is +only available for URL and HTML input.

@@ -596,7 +605,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Feed.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Feed.html index 94c54501c..9ee391a22 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Feed.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Feed.html @@ -107,9 +107,6 @@ - @@ -234,7 +231,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/KeywordsOptions.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/KeywordsOptions.html index cd6c393a7..a3b426ddc 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/KeywordsOptions.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/KeywordsOptions.html @@ -107,9 +107,6 @@ - @@ -303,7 +300,11 @@

Declaration

Declaration

Swift

-
public init(limit: Int? = nil, sentiment: Bool? = nil, emotion: Bool? = nil)
+
public init(
+    limit: Int? = nil,
+    sentiment: Bool? = nil,
+    emotion: Bool? = nil
+)
@@ -362,7 +363,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/KeywordsResult.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/KeywordsResult.html index 9b9336450..d41a37ab8 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/KeywordsResult.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/KeywordsResult.html @@ -107,9 +107,6 @@ - @@ -315,7 +312,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/ListModelsResults.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/ListModelsResults.html index c68bd299c..e7f521a89 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/ListModelsResults.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/ListModelsResults.html @@ -107,9 +107,6 @@ - @@ -234,7 +231,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/MetadataOptions.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/MetadataOptions.html index c5384f45f..d7c1f4cb8 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/MetadataOptions.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/MetadataOptions.html @@ -107,9 +107,6 @@ - @@ -249,7 +246,9 @@

Declaration

Declaration

Swift

-
public init(additionalProperties: [String: JSON] = [:])
+
public init(
+    additionalProperties: [String: JSON] = [:]
+)
@@ -291,7 +290,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/MetadataResult.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/MetadataResult.html index 100f3846d..0b9c8a2cc 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/MetadataResult.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/MetadataResult.html @@ -107,9 +107,6 @@ - @@ -342,7 +339,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Model.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Model.html index 1375429dc..14f20a558 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Model.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Model.html @@ -107,9 +107,6 @@ - @@ -315,7 +312,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Parameters.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Parameters.html index acec779d6..b38dbbd52 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Parameters.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Parameters.html @@ -107,9 +107,6 @@ - @@ -492,7 +489,18 @@

Declaration

Declaration

Swift

-
public init(features: Features, text: String? = nil, html: String? = nil, url: String? = nil, clean: Bool? = nil, xpath: String? = nil, fallbackToRaw: Bool? = nil, returnAnalyzedText: Bool? = nil, language: String? = nil, limitTextCharacters: Int? = nil)
+
public init(
+    features: Features,
+    text: String? = nil,
+    html: String? = nil,
+    url: String? = nil,
+    clean: Bool? = nil,
+    xpath: String? = nil,
+    fallbackToRaw: Bool? = nil,
+    returnAnalyzedText: Bool? = nil,
+    language: String? = nil,
+    limitTextCharacters: Int? = nil
+)
@@ -635,7 +643,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/RelationArgument.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/RelationArgument.html index fbfae924c..1edca4929 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/RelationArgument.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/RelationArgument.html @@ -107,9 +107,6 @@ - @@ -288,7 +285,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/RelationEntity.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/RelationEntity.html index 433de89ca..713729bd7 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/RelationEntity.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/RelationEntity.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/RelationsOptions.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/RelationsOptions.html index 444c945b8..2b5f27818 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/RelationsOptions.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/RelationsOptions.html @@ -107,9 +107,6 @@ - @@ -249,7 +246,9 @@

Declaration

Declaration

Swift

-
public init(model: String? = nil)
+
public init(
+    model: String? = nil
+)
@@ -284,7 +283,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/RelationsResult.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/RelationsResult.html index 73f6e416e..769e479f7 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/RelationsResult.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/RelationsResult.html @@ -107,9 +107,6 @@ - @@ -315,7 +312,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesAction.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesAction.html index 9f5d6c85d..b131d1a55 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesAction.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesAction.html @@ -107,9 +107,6 @@ - @@ -288,7 +285,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesEntity.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesEntity.html index d7d2bbc1c..c251d5519 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesEntity.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesEntity.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesKeyword.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesKeyword.html index 5dcdbaa88..415479e71 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesKeyword.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesKeyword.html @@ -107,9 +107,6 @@ - @@ -234,7 +231,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesObject.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesObject.html index 8f120880a..fb4b5d92e 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesObject.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesObject.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesOptions.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesOptions.html index 2ffe3e994..4d94f9489 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesOptions.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesOptions.html @@ -107,9 +107,6 @@ - @@ -303,7 +300,11 @@

Declaration

Declaration

Swift

-
public init(limit: Int? = nil, keywords: Bool? = nil, entities: Bool? = nil)
+
public init(
+    limit: Int? = nil,
+    keywords: Bool? = nil,
+    entities: Bool? = nil
+)
@@ -362,7 +363,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesResult.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesResult.html index ae0028cae..d92b9aea1 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesResult.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesResult.html @@ -107,9 +107,6 @@ - @@ -315,7 +312,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesSubject.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesSubject.html index 3bf3832e2..5332f1fda 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesSubject.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesSubject.html @@ -107,9 +107,6 @@ - @@ -288,7 +285,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesVerb.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesVerb.html index d8c39942b..0cec57088 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesVerb.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SemanticRolesVerb.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SentimentOptions.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SentimentOptions.html index ca7d24ae3..57b5e277d 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SentimentOptions.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SentimentOptions.html @@ -107,9 +107,6 @@ - @@ -276,7 +273,10 @@

Declaration

Declaration

Swift

-
public init(document: Bool? = nil, targets: [String]? = nil)
+
public init(
+    document: Bool? = nil,
+    targets: [String]? = nil
+)
@@ -323,7 +323,7 @@

Return Value

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SentimentResult.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SentimentResult.html index de0b9b530..16918a5dc 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SentimentResult.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/SentimentResult.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/TargetedEmotionResults.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/TargetedEmotionResults.html index b5f919f70..4156ff3bb 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/TargetedEmotionResults.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/TargetedEmotionResults.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/TargetedSentimentResults.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/TargetedSentimentResults.html index c97e12266..abb057e9f 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/TargetedSentimentResults.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/TargetedSentimentResults.html @@ -107,9 +107,6 @@ - @@ -261,7 +258,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Usage.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Usage.html index 5f4ba6cae..f49260fb4 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Usage.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/Structs/Usage.html @@ -107,9 +107,6 @@ - @@ -288,7 +285,7 @@

Declaration

diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/index.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/index.html index fc872a96f..14106f1b0 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/index.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/index.html @@ -106,9 +106,6 @@ - @@ -229,7 +226,8 @@

Services

  • Assistant
  • Discovery
  • -
  • Language Translator
  • +
  • Language Translator V2
  • +
  • Language Translator V3
  • Natural Language Classifier
  • Natural Language Understanding
  • Personality Insights
  • @@ -274,7 +272,7 @@

    Swift Package Manager

    Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

    dependencies: [
    -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
    +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
     ]
     

    Service Instances

    @@ -317,7 +315,7 @@

    Username and Password

    API Key

    -

    Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

    +

    Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

    let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
     

    Using IAM

    @@ -552,7 +550,12 @@

    Private Data Collections

  • IBM Discovery - Documentation
  • IBM Discovery - Demo
-

Language Translator

+

Language Translator V2

+ +

Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

@@ -563,6 +566,25 @@

Language Translator

let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} + +

Language Translator V3

+ +

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

+ +

The following example demonstrates how to use the Language Translator service:

+
import LanguageTranslatorV3
+
+let username = "your-username-here"
+let password = "your-password-here"
+let version = "yyyy-mm-dd" // use today's date for the most recent version
+let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
+
 let failure = { (error: Error) in print(error) }
 let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
 languageTranslator.translate(request: request, failure: failure) {
@@ -953,7 +975,7 @@ 

Visual Recognition

let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -961,6 +983,10 @@

Visual Recognition

print(classifiedImages) }
+ +

Note: a different initializer is used for authentication with instances created before May 23, 2018:

+
let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
+

Using Core ML

The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

@@ -1012,7 +1038,7 @@

Bundlin diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/search.json b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/search.json index 3944241cb..5956d7927 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/search.json +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/Documents/search.json @@ -1 +1 @@ -{"Structs/Usage.html#/s:30NaturalLanguageUnderstandingV15UsageV8featuresSiSgvp":{"name":"features","abstract":"

Number of features used in the API call.

","parent_name":"Usage"},"Structs/Usage.html#/s:30NaturalLanguageUnderstandingV15UsageV14textCharactersSiSgvp":{"name":"textCharacters","abstract":"

Number of text characters processed.

","parent_name":"Usage"},"Structs/Usage.html#/s:30NaturalLanguageUnderstandingV15UsageV9textUnitsSiSgvp":{"name":"textUnits","abstract":"

Number of 10,000-character units processed.

","parent_name":"Usage"},"Structs/TargetedSentimentResults.html#/s:30NaturalLanguageUnderstandingV124TargetedSentimentResultsV4textSSSgvp":{"name":"text","abstract":"

Targeted text.

","parent_name":"TargetedSentimentResults"},"Structs/TargetedSentimentResults.html#/s:30NaturalLanguageUnderstandingV124TargetedSentimentResultsV5scoreSdSgvp":{"name":"score","abstract":"

Sentiment score from -1 (negative) to 1 (positive).

","parent_name":"TargetedSentimentResults"},"Structs/TargetedEmotionResults.html#/s:30NaturalLanguageUnderstandingV122TargetedEmotionResultsV4textSSSgvp":{"name":"text","abstract":"

Targeted text.

","parent_name":"TargetedEmotionResults"},"Structs/TargetedEmotionResults.html#/s:30NaturalLanguageUnderstandingV122TargetedEmotionResultsV7emotionAA0F6ScoresVSgvp":{"name":"emotion","abstract":"

An object containing the emotion results for the target.

","parent_name":"TargetedEmotionResults"},"Structs/SentimentResult.html#/s:30NaturalLanguageUnderstandingV115SentimentResultV8documentAA08DocumentE7ResultsVSgvp":{"name":"document","abstract":"

The document level sentiment.

","parent_name":"SentimentResult"},"Structs/SentimentResult.html#/s:30NaturalLanguageUnderstandingV115SentimentResultV7targetsSayAA08TargetedE7ResultsVGSgvp":{"name":"targets","abstract":"

The targeted sentiment to analyze.

","parent_name":"SentimentResult"},"Structs/SentimentOptions.html#/s:30NaturalLanguageUnderstandingV116SentimentOptionsV8documentSbSgvp":{"name":"document","abstract":"

Set this to false to hide document-level sentiment results.

","parent_name":"SentimentOptions"},"Structs/SentimentOptions.html#/s:30NaturalLanguageUnderstandingV116SentimentOptionsV7targetsSaySSGSgvp":{"name":"targets","abstract":"

Sentiment results will be returned for each target string that is found in the document.

","parent_name":"SentimentOptions"},"Structs/SentimentOptions.html#/s:30NaturalLanguageUnderstandingV116SentimentOptionsVACSbSg8document_SaySSGSg7targetstcfc":{"name":"init(document:targets:)","abstract":"

Initialize a SentimentOptions with member variables.

","parent_name":"SentimentOptions"},"Structs/SemanticRolesVerb.html#/s:30NaturalLanguageUnderstandingV117SemanticRolesVerbV4textSSSgvp":{"name":"text","abstract":"

The keyword text.

","parent_name":"SemanticRolesVerb"},"Structs/SemanticRolesVerb.html#/s:30NaturalLanguageUnderstandingV117SemanticRolesVerbV5tenseSSSgvp":{"name":"tense","abstract":"

Verb tense.

","parent_name":"SemanticRolesVerb"},"Structs/SemanticRolesSubject.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesSubjectV4textSSSgvp":{"name":"text","abstract":"

Text that corresponds to the subject role.

","parent_name":"SemanticRolesSubject"},"Structs/SemanticRolesSubject.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesSubjectV8entitiesSayAA0eF6EntityVGSgvp":{"name":"entities","abstract":"

Undocumented

","parent_name":"SemanticRolesSubject"},"Structs/SemanticRolesSubject.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesSubjectV8keywordsSayAA0eF7KeywordVGSgvp":{"name":"keywords","abstract":"

Undocumented

","parent_name":"SemanticRolesSubject"},"Structs/SemanticRolesResult.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesResultV8sentenceSSSgvp":{"name":"sentence","abstract":"

Sentence from the source that contains the subject, action, and object.

","parent_name":"SemanticRolesResult"},"Structs/SemanticRolesResult.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesResultV7subjectAA0eF7SubjectVSgvp":{"name":"subject","abstract":"

The extracted subject from the sentence.

","parent_name":"SemanticRolesResult"},"Structs/SemanticRolesResult.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesResultV6actionAA0eF6ActionVSgvp":{"name":"action","abstract":"

The extracted action from the sentence.

","parent_name":"SemanticRolesResult"},"Structs/SemanticRolesResult.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesResultV6objectAA0eF6ObjectVSgvp":{"name":"object","abstract":"

The extracted object from the sentence.

","parent_name":"SemanticRolesResult"},"Structs/SemanticRolesOptions.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesOptionsV5limitSiSgvp":{"name":"limit","abstract":"

Maximum number of semantic_roles results to return.

","parent_name":"SemanticRolesOptions"},"Structs/SemanticRolesOptions.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesOptionsV8keywordsSbSgvp":{"name":"keywords","abstract":"

Set this to true to return keyword information for subjects and objects.

","parent_name":"SemanticRolesOptions"},"Structs/SemanticRolesOptions.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesOptionsV8entitiesSbSgvp":{"name":"entities","abstract":"

Set this to true to return entity information for subjects and objects.

","parent_name":"SemanticRolesOptions"},"Structs/SemanticRolesOptions.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesOptionsVACSiSg5limit_SbSg8keywordsAF8entitiestcfc":{"name":"init(limit:keywords:entities:)","abstract":"

Initialize a SemanticRolesOptions with member variables.

","parent_name":"SemanticRolesOptions"},"Structs/SemanticRolesObject.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesObjectV4textSSSgvp":{"name":"text","abstract":"

Object text.

","parent_name":"SemanticRolesObject"},"Structs/SemanticRolesObject.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesObjectV8keywordsSayAA0eF7KeywordVGSgvp":{"name":"keywords","abstract":"

Undocumented

","parent_name":"SemanticRolesObject"},"Structs/SemanticRolesKeyword.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesKeywordV4textSSSgvp":{"name":"text","abstract":"

The keyword text.

","parent_name":"SemanticRolesKeyword"},"Structs/SemanticRolesEntity.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesEntityV4typeSSSgvp":{"name":"type","abstract":"

Entity type.

","parent_name":"SemanticRolesEntity"},"Structs/SemanticRolesEntity.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesEntityV4textSSSgvp":{"name":"text","abstract":"

The entity text.

","parent_name":"SemanticRolesEntity"},"Structs/SemanticRolesAction.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesActionV4textSSSgvp":{"name":"text","abstract":"

Analyzed text that corresponds to the action.

","parent_name":"SemanticRolesAction"},"Structs/SemanticRolesAction.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesActionV10normalizedSSSgvp":{"name":"normalized","abstract":"

normalized version of the action.

","parent_name":"SemanticRolesAction"},"Structs/SemanticRolesAction.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesActionV4verbAA0eF4VerbVSgvp":{"name":"verb","abstract":"

Undocumented

","parent_name":"SemanticRolesAction"},"Structs/RelationsResult.html#/s:30NaturalLanguageUnderstandingV115RelationsResultV5scoreSdSgvp":{"name":"score","abstract":"

Confidence score for the relation. Higher values indicate greater confidence.

","parent_name":"RelationsResult"},"Structs/RelationsResult.html#/s:30NaturalLanguageUnderstandingV115RelationsResultV8sentenceSSSgvp":{"name":"sentence","abstract":"

The sentence that contains the relation.

","parent_name":"RelationsResult"},"Structs/RelationsResult.html#/s:30NaturalLanguageUnderstandingV115RelationsResultV4typeSSSgvp":{"name":"type","abstract":"

The type of the relation.

","parent_name":"RelationsResult"},"Structs/RelationsResult.html#/s:30NaturalLanguageUnderstandingV115RelationsResultV9argumentsSayAA16RelationArgumentVGSgvp":{"name":"arguments","abstract":"

The extracted relation objects from the text.

","parent_name":"RelationsResult"},"Structs/RelationsOptions.html#/s:30NaturalLanguageUnderstandingV116RelationsOptionsV5modelSSSgvp":{"name":"model","abstract":"

Enter a custom model ID to override the default model.

","parent_name":"RelationsOptions"},"Structs/RelationsOptions.html#/s:30NaturalLanguageUnderstandingV116RelationsOptionsVACSSSg5model_tcfc":{"name":"init(model:)","abstract":"

Initialize a RelationsOptions with member variables.

","parent_name":"RelationsOptions"},"Structs/RelationEntity.html#/s:30NaturalLanguageUnderstandingV114RelationEntityV4textSSSgvp":{"name":"text","abstract":"

Text that corresponds to the entity.

","parent_name":"RelationEntity"},"Structs/RelationEntity.html#/s:30NaturalLanguageUnderstandingV114RelationEntityV4typeSSSgvp":{"name":"type","abstract":"

Entity type.

","parent_name":"RelationEntity"},"Structs/RelationArgument.html#/s:30NaturalLanguageUnderstandingV116RelationArgumentV8entitiesSayAA0E6EntityVGSgvp":{"name":"entities","abstract":"

Undocumented

","parent_name":"RelationArgument"},"Structs/RelationArgument.html#/s:30NaturalLanguageUnderstandingV116RelationArgumentV8locationSaySiGSgvp":{"name":"location","abstract":"

Character offsets indicating the beginning and end of the mention in the analyzed text.

","parent_name":"RelationArgument"},"Structs/RelationArgument.html#/s:30NaturalLanguageUnderstandingV116RelationArgumentV4textSSSgvp":{"name":"text","abstract":"

Text that corresponds to the argument.

","parent_name":"RelationArgument"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV4textSSSgvp":{"name":"text","abstract":"

The plain text to analyze.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV4htmlSSSgvp":{"name":"html","abstract":"

The HTML file to analyze.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV3urlSSSgvp":{"name":"url","abstract":"

The web page to analyze.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV8featuresAA8FeaturesVvp":{"name":"features","abstract":"

Specific features to analyze the document for.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV5cleanSbSgvp":{"name":"clean","abstract":"

Remove website elements, such as links, ads, etc.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV5xpathSSSgvp":{"name":"xpath","abstract":"

XPath query for targeting nodes in HTML.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV13fallbackToRawSbSgvp":{"name":"fallbackToRaw","abstract":"

Whether to use raw HTML content if text cleaning fails.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV18returnAnalyzedTextSbSgvp":{"name":"returnAnalyzedText","abstract":"

Whether or not to return the analyzed text.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV8languageSSSgvp":{"name":"language","abstract":"

ISO 639-1 code indicating the language to use in the analysis.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV19limitTextCharactersSiSgvp":{"name":"limitTextCharacters","abstract":"

Sets the maximum number of characters that are processed by the service.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersVAcA8FeaturesV8features_SSSg4textAG4htmlAG3urlSbSg5cleanAG5xpathAK13fallbackToRawAK18returnAnalyzedTextAG8languageSiSg05limitR10Characterstcfc":{"name":"init(features:text:html:url:clean:xpath:fallbackToRaw:returnAnalyzedText:language:limitTextCharacters:)","abstract":"

Initialize a Parameters with member variables.

","parent_name":"Parameters"},"Structs/Model.html#/s:30NaturalLanguageUnderstandingV15ModelV6statusSSSgvp":{"name":"status","abstract":"

Shows as available if the model is ready for use.

","parent_name":"Model"},"Structs/Model.html#/s:30NaturalLanguageUnderstandingV15ModelV7modelIDSSSgvp":{"name":"modelID","abstract":"

Unique model ID.

","parent_name":"Model"},"Structs/Model.html#/s:30NaturalLanguageUnderstandingV15ModelV8languageSSSgvp":{"name":"language","abstract":"

ISO 639-1 code indicating the language of the model.

","parent_name":"Model"},"Structs/Model.html#/s:30NaturalLanguageUnderstandingV15ModelV11descriptionSSSgvp":{"name":"description","abstract":"

Model description.

","parent_name":"Model"},"Structs/MetadataResult.html#/s:30NaturalLanguageUnderstandingV114MetadataResultV7authorsSayAA6AuthorVGSgvp":{"name":"authors","abstract":"

The authors of the document.

","parent_name":"MetadataResult"},"Structs/MetadataResult.html#/s:30NaturalLanguageUnderstandingV114MetadataResultV15publicationDateSSSgvp":{"name":"publicationDate","abstract":"

The publication date in the format ISO 8601.

","parent_name":"MetadataResult"},"Structs/MetadataResult.html#/s:30NaturalLanguageUnderstandingV114MetadataResultV5titleSSSgvp":{"name":"title","abstract":"

The title of the document.

","parent_name":"MetadataResult"},"Structs/MetadataResult.html#/s:30NaturalLanguageUnderstandingV114MetadataResultV5imageSSSgvp":{"name":"image","abstract":"

URL of a prominent image on the webpage.

","parent_name":"MetadataResult"},"Structs/MetadataResult.html#/s:30NaturalLanguageUnderstandingV114MetadataResultV5feedsSayAA4FeedVGSgvp":{"name":"feeds","abstract":"

RSS/ATOM feeds found on the webpage.

","parent_name":"MetadataResult"},"Structs/MetadataOptions.html#/s:30NaturalLanguageUnderstandingV115MetadataOptionsV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"MetadataOptions"},"Structs/MetadataOptions.html#/s:30NaturalLanguageUnderstandingV115MetadataOptionsVACs10DictionaryVySSAA4JSONOG20additionalProperties_tcfc":{"name":"init(additionalProperties:)","abstract":"

Initialize a MetadataOptions.

","parent_name":"MetadataOptions"},"Structs/MetadataOptions.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"MetadataOptions"},"Structs/ListModelsResults.html#/s:30NaturalLanguageUnderstandingV117ListModelsResultsV6modelsSayAA5ModelVGSgvp":{"name":"models","abstract":"

Undocumented

","parent_name":"ListModelsResults"},"Structs/KeywordsResult.html#/s:30NaturalLanguageUnderstandingV114KeywordsResultV9relevanceSdSgvp":{"name":"relevance","abstract":"

Relevance score from 0 to 1. Higher values indicate greater relevance.

","parent_name":"KeywordsResult"},"Structs/KeywordsResult.html#/s:30NaturalLanguageUnderstandingV114KeywordsResultV4textSSSgvp":{"name":"text","abstract":"

The keyword text.

","parent_name":"KeywordsResult"},"Structs/KeywordsResult.html#/s:30NaturalLanguageUnderstandingV114KeywordsResultV7emotionAA13EmotionScoresVSgvp":{"name":"emotion","abstract":"

Emotion analysis results for the keyword, enabled with the emotion option.

","parent_name":"KeywordsResult"},"Structs/KeywordsResult.html#/s:30NaturalLanguageUnderstandingV114KeywordsResultV9sentimentAA23FeatureSentimentResultsVSgvp":{"name":"sentiment","abstract":"

Sentiment analysis results for the keyword, enabled with the sentiment option.

","parent_name":"KeywordsResult"},"Structs/KeywordsOptions.html#/s:30NaturalLanguageUnderstandingV115KeywordsOptionsV5limitSiSgvp":{"name":"limit","abstract":"

Maximum number of keywords to return.

","parent_name":"KeywordsOptions"},"Structs/KeywordsOptions.html#/s:30NaturalLanguageUnderstandingV115KeywordsOptionsV9sentimentSbSgvp":{"name":"sentiment","abstract":"

Set this to true to return sentiment information for detected keywords.

","parent_name":"KeywordsOptions"},"Structs/KeywordsOptions.html#/s:30NaturalLanguageUnderstandingV115KeywordsOptionsV7emotionSbSgvp":{"name":"emotion","abstract":"

Set this to true to analyze emotion for detected keywords.

","parent_name":"KeywordsOptions"},"Structs/KeywordsOptions.html#/s:30NaturalLanguageUnderstandingV115KeywordsOptionsVACSiSg5limit_SbSg9sentimentAF7emotiontcfc":{"name":"init(limit:sentiment:emotion:)","abstract":"

Initialize a KeywordsOptions with member variables.

","parent_name":"KeywordsOptions"},"Structs/Feed.html#/s:30NaturalLanguageUnderstandingV14FeedV4linkSSSgvp":{"name":"link","abstract":"

URL of the RSS or ATOM feed.

","parent_name":"Feed"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV8conceptsAA15ConceptsOptionsVSgvp":{"name":"concepts","abstract":"

Whether or not to return the concepts that are mentioned in the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV7emotionAA14EmotionOptionsVSgvp":{"name":"emotion","abstract":"

Whether or not to extract the emotions implied in the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV8entitiesAA15EntitiesOptionsVSgvp":{"name":"entities","abstract":"

Whether or not to extract detected entity objects from the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV8keywordsAA15KeywordsOptionsVSgvp":{"name":"keywords","abstract":"

Whether or not to return the keywords in the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV8metadataAA15MetadataOptionsVSgvp":{"name":"metadata","abstract":"

Whether or not the author, publication date, and title of the analyzed text should be returned. This parameter is only available for URL and HTML input.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV9relationsAA16RelationsOptionsVSgvp":{"name":"relations","abstract":"

Whether or not to return the relationships between detected entities in the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV13semanticRolesAA08SemanticG7OptionsVSgvp":{"name":"semanticRoles","abstract":"

Whether or not to return the subject-action-object relations from the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV9sentimentAA16SentimentOptionsVSgvp":{"name":"sentiment","abstract":"

Whether or not to return the overall sentiment of the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV10categoriesAA17CategoriesOptionsVSgvp":{"name":"categories","abstract":"

Whether or not to return the high level category the content is categorized as (i.e. news, art).

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesVAcA15ConceptsOptionsVSg8concepts_AA07EmotionG0VSg7emotionAA08EntitiesG0VSg8entitiesAA08KeywordsG0VSg8keywordsAA08MetadataG0VSg8metadataAA09RelationsG0VSg9relationsAA013SemanticRolesG0VSg08semanticT0AA09SentimentG0VSg9sentimentAA010CategoriesG0VSg10categoriestcfc":{"name":"init(concepts:emotion:entities:keywords:metadata:relations:semanticRoles:sentiment:categories:)","abstract":"

Initialize a Features with member variables.

","parent_name":"Features"},"Structs/FeatureSentimentResults.html#/s:30NaturalLanguageUnderstandingV123FeatureSentimentResultsV5scoreSdSgvp":{"name":"score","abstract":"

Sentiment score from -1 (negative) to 1 (positive).

","parent_name":"FeatureSentimentResults"},"Structs/EntityMention.html#/s:30NaturalLanguageUnderstandingV113EntityMentionV4textSSSgvp":{"name":"text","abstract":"

Entity mention text.

","parent_name":"EntityMention"},"Structs/EntityMention.html#/s:30NaturalLanguageUnderstandingV113EntityMentionV8locationSaySiGSgvp":{"name":"location","abstract":"

Character offsets indicating the beginning and end of the mention in the analyzed text.

","parent_name":"EntityMention"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV4typeSSSgvp":{"name":"type","abstract":"

Entity type.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV4textSSSgvp":{"name":"text","abstract":"

The name of the entity.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV9relevanceSdSgvp":{"name":"relevance","abstract":"

Relevance score from 0 to 1. Higher values indicate greater relevance.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV8mentionsSayAA13EntityMentionVGSgvp":{"name":"mentions","abstract":"

Entity mentions and locations.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV5countSiSgvp":{"name":"count","abstract":"

How many times the entity was mentioned in the text.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV7emotionAA13EmotionScoresVSgvp":{"name":"emotion","abstract":"

Emotion analysis results for the entity, enabled with the emotion option.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV9sentimentAA23FeatureSentimentResultsVSgvp":{"name":"sentiment","abstract":"

Sentiment analysis results for the entity, enabled with the sentiment option.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV14disambiguationAA014DisambiguationF0VSgvp":{"name":"disambiguation","abstract":"

Disambiguation information for the entity.

","parent_name":"EntitiesResult"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsV5limitSiSgvp":{"name":"limit","abstract":"

Maximum number of entities to return.

","parent_name":"EntitiesOptions"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsV8mentionsSbSgvp":{"name":"mentions","abstract":"

Set this to true to return locations of entity mentions.

","parent_name":"EntitiesOptions"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsV5modelSSSgvp":{"name":"model","abstract":"

Enter a custom model ID to override the standard entity detection model.

","parent_name":"EntitiesOptions"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsV9sentimentSbSgvp":{"name":"sentiment","abstract":"

Set this to true to return sentiment information for detected entities.

","parent_name":"EntitiesOptions"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsV7emotionSbSgvp":{"name":"emotion","abstract":"

Set this to true to analyze emotion for detected keywords.

","parent_name":"EntitiesOptions"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsVACSiSg5limit_SbSg8mentionsSSSg5modelAF9sentimentAF7emotiontcfc":{"name":"init(limit:mentions:model:sentiment:emotion:)","abstract":"

Initialize a EntitiesOptions with member variables.

","parent_name":"EntitiesOptions"},"Structs/EmotionScores.html#/s:30NaturalLanguageUnderstandingV113EmotionScoresV5angerSdSgvp":{"name":"anger","abstract":"

Anger score from 0 to 1. A higher score means that the text is more likely to convey anger.

","parent_name":"EmotionScores"},"Structs/EmotionScores.html#/s:30NaturalLanguageUnderstandingV113EmotionScoresV7disgustSdSgvp":{"name":"disgust","abstract":"

Disgust score from 0 to 1. A higher score means that the text is more likely to convey disgust.

","parent_name":"EmotionScores"},"Structs/EmotionScores.html#/s:30NaturalLanguageUnderstandingV113EmotionScoresV4fearSdSgvp":{"name":"fear","abstract":"

Fear score from 0 to 1. A higher score means that the text is more likely to convey fear.

","parent_name":"EmotionScores"},"Structs/EmotionScores.html#/s:30NaturalLanguageUnderstandingV113EmotionScoresV3joySdSgvp":{"name":"joy","abstract":"

Joy score from 0 to 1. A higher score means that the text is more likely to convey joy.

","parent_name":"EmotionScores"},"Structs/EmotionScores.html#/s:30NaturalLanguageUnderstandingV113EmotionScoresV7sadnessSdSgvp":{"name":"sadness","abstract":"

Sadness score from 0 to 1. A higher score means that the text is more likely to convey sadness.

","parent_name":"EmotionScores"},"Structs/EmotionResult.html#/s:30NaturalLanguageUnderstandingV113EmotionResultV8documentAA08DocumentE7ResultsVSgvp":{"name":"document","abstract":"

The returned emotion results across the document.

","parent_name":"EmotionResult"},"Structs/EmotionResult.html#/s:30NaturalLanguageUnderstandingV113EmotionResultV7targetsSayAA08TargetedE7ResultsVGSgvp":{"name":"targets","abstract":"

The returned emotion results per specified target.

","parent_name":"EmotionResult"},"Structs/EmotionOptions.html#/s:30NaturalLanguageUnderstandingV114EmotionOptionsV8documentSbSgvp":{"name":"document","abstract":"

Set this to false to hide document-level emotion results.

","parent_name":"EmotionOptions"},"Structs/EmotionOptions.html#/s:30NaturalLanguageUnderstandingV114EmotionOptionsV7targetsSaySSGSgvp":{"name":"targets","abstract":"

Emotion results will be returned for each target string that is found in the document.

","parent_name":"EmotionOptions"},"Structs/EmotionOptions.html#/s:30NaturalLanguageUnderstandingV114EmotionOptionsVACSbSg8document_SaySSGSg7targetstcfc":{"name":"init(document:targets:)","abstract":"

Initialize a EmotionOptions with member variables.

","parent_name":"EmotionOptions"},"Structs/DocumentSentimentResults.html#/s:30NaturalLanguageUnderstandingV124DocumentSentimentResultsV5labelSSSgvp":{"name":"label","abstract":"

Indicates whether the sentiment is positive, neutral, or negative.

","parent_name":"DocumentSentimentResults"},"Structs/DocumentSentimentResults.html#/s:30NaturalLanguageUnderstandingV124DocumentSentimentResultsV5scoreSdSgvp":{"name":"score","abstract":"

Sentiment score from -1 (negative) to 1 (positive).

","parent_name":"DocumentSentimentResults"},"Structs/DocumentEmotionResults.html#/s:30NaturalLanguageUnderstandingV122DocumentEmotionResultsV7emotionAA0F6ScoresVSgvp":{"name":"emotion","abstract":"

An object containing the emotion results for the document.

","parent_name":"DocumentEmotionResults"},"Structs/DisambiguationResult.html#/s:30NaturalLanguageUnderstandingV120DisambiguationResultV4nameSSSgvp":{"name":"name","abstract":"

Common entity name.

","parent_name":"DisambiguationResult"},"Structs/DisambiguationResult.html#/s:30NaturalLanguageUnderstandingV120DisambiguationResultV15dbpediaResourceSSSgvp":{"name":"dbpediaResource","abstract":"

Link to the corresponding DBpedia resource.

","parent_name":"DisambiguationResult"},"Structs/DisambiguationResult.html#/s:30NaturalLanguageUnderstandingV120DisambiguationResultV7subtypeSaySSGSgvp":{"name":"subtype","abstract":"

Entity subtype information.

","parent_name":"DisambiguationResult"},"Structs/DeleteModelResults.html#/s:30NaturalLanguageUnderstandingV118DeleteModelResultsV7deletedSSSgvp":{"name":"deleted","abstract":"

model_id of the deleted model.

","parent_name":"DeleteModelResults"},"Structs/ConceptsResult.html#/s:30NaturalLanguageUnderstandingV114ConceptsResultV4textSSSgvp":{"name":"text","abstract":"

Name of the concept.

","parent_name":"ConceptsResult"},"Structs/ConceptsResult.html#/s:30NaturalLanguageUnderstandingV114ConceptsResultV9relevanceSdSgvp":{"name":"relevance","abstract":"

Relevance score between 0 and 1. Higher scores indicate greater relevance.

","parent_name":"ConceptsResult"},"Structs/ConceptsResult.html#/s:30NaturalLanguageUnderstandingV114ConceptsResultV15dbpediaResourceSSSgvp":{"name":"dbpediaResource","abstract":"

Link to the corresponding DBpedia resource.

","parent_name":"ConceptsResult"},"Structs/ConceptsOptions.html#/s:30NaturalLanguageUnderstandingV115ConceptsOptionsV5limitSiSgvp":{"name":"limit","abstract":"

Maximum number of concepts to return.

","parent_name":"ConceptsOptions"},"Structs/ConceptsOptions.html#/s:30NaturalLanguageUnderstandingV115ConceptsOptionsVACSiSg5limit_tcfc":{"name":"init(limit:)","abstract":"

Initialize a ConceptsOptions with member variables.

","parent_name":"ConceptsOptions"},"Structs/CategoriesResult.html#/s:30NaturalLanguageUnderstandingV116CategoriesResultV5labelSSSgvp":{"name":"label","abstract":"

The path to the category through the taxonomy hierarchy.

","parent_name":"CategoriesResult"},"Structs/CategoriesResult.html#/s:30NaturalLanguageUnderstandingV116CategoriesResultV5scoreSdSgvp":{"name":"score","abstract":"

Confidence score for the category classification. Higher values indicate greater confidence.

","parent_name":"CategoriesResult"},"Structs/CategoriesOptions.html#/s:30NaturalLanguageUnderstandingV117CategoriesOptionsV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"CategoriesOptions"},"Structs/CategoriesOptions.html#/s:30NaturalLanguageUnderstandingV117CategoriesOptionsVACs10DictionaryVySSAA4JSONOG20additionalProperties_tcfc":{"name":"init(additionalProperties:)","abstract":"

Initialize a CategoriesOptions.

","parent_name":"CategoriesOptions"},"Structs/CategoriesOptions.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"CategoriesOptions"},"Structs/Author.html#/s:30NaturalLanguageUnderstandingV16AuthorV4nameSSSgvp":{"name":"name","abstract":"

Name of the author.

","parent_name":"Author"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV8languageSSSgvp":{"name":"language","abstract":"

Language used to analyze the text.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV12analyzedTextSSSgvp":{"name":"analyzedText","abstract":"

Text that was used in the analysis.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV12retrievedUrlSSSgvp":{"name":"retrievedUrl","abstract":"

URL that was used to retrieve HTML content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV5usageAA5UsageVSgvp":{"name":"usage","abstract":"

API usage information for the request.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV8conceptsSayAA14ConceptsResultVGSgvp":{"name":"concepts","abstract":"

The general concepts referenced or alluded to in the specified content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV8entitiesSayAA14EntitiesResultVGSgvp":{"name":"entities","abstract":"

The important entities in the specified content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV8keywordsSayAA14KeywordsResultVGSgvp":{"name":"keywords","abstract":"

The important keywords in content organized by relevance.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV10categoriesSayAA16CategoriesResultVGSgvp":{"name":"categories","abstract":"

The hierarchical 5-level taxonomy the content is categorized into.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV7emotionAA13EmotionResultVSgvp":{"name":"emotion","abstract":"

The anger, disgust, fear, joy, or sadness conveyed by the content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV8metadataAA14MetadataResultVSgvp":{"name":"metadata","abstract":"

The metadata holds author information, publication date and the title of the text/HTML content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV9relationsSayAA15RelationsResultVGSgvp":{"name":"relations","abstract":"

The relationships between entities in the content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV13semanticRolesSayAA08SemanticH6ResultVGSgvp":{"name":"semanticRoles","abstract":"

The subjects of actions and the objects the actions act upon.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV9sentimentAA15SentimentResultVSgvp":{"name":"sentiment","abstract":"

The sentiment of the content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html":{"name":"AnalysisResults","abstract":"

Results of the analysis, organized by feature.

"},"Structs/Author.html":{"name":"Author","abstract":"

The author of the analyzed content.

"},"Structs/CategoriesOptions.html":{"name":"CategoriesOptions","abstract":"

The hierarchical 5-level taxonomy the content is categorized into.

"},"Structs/CategoriesResult.html":{"name":"CategoriesResult","abstract":"

The hierarchical 5-level taxonomy the content is categorized into.

"},"Structs/ConceptsOptions.html":{"name":"ConceptsOptions","abstract":"

Whether or not to analyze content for general concepts that are referenced or alluded to.

"},"Structs/ConceptsResult.html":{"name":"ConceptsResult","abstract":"

The general concepts referenced or alluded to in the specified content.

"},"Structs/DeleteModelResults.html":{"name":"DeleteModelResults","abstract":"

Information about the deleted model.

"},"Structs/DisambiguationResult.html":{"name":"DisambiguationResult","abstract":"

Disambiguation information for the entity.

"},"Structs/DocumentEmotionResults.html":{"name":"DocumentEmotionResults","abstract":"

An object containing the emotion results of a document.

"},"Structs/DocumentSentimentResults.html":{"name":"DocumentSentimentResults","abstract":"

DocumentSentimentResults.

"},"Structs/EmotionOptions.html":{"name":"EmotionOptions","abstract":"

Whether or not to return emotion analysis of the content.

"},"Structs/EmotionResult.html":{"name":"EmotionResult","abstract":"

The detected anger, disgust, fear, joy, or sadness that is conveyed by the content. Emotion information can be returned for detected entities, keywords, or user-specified target phrases found in the text.

"},"Structs/EmotionScores.html":{"name":"EmotionScores","abstract":"

EmotionScores.

"},"Structs/EntitiesOptions.html":{"name":"EntitiesOptions","abstract":"

Whether or not to return important people, places, geopolitical, and other entities detected in the analyzed content.

"},"Structs/EntitiesResult.html":{"name":"EntitiesResult","abstract":"

The important people, places, geopolitical entities and other types of entities in your content.

"},"Structs/EntityMention.html":{"name":"EntityMention","abstract":"

EntityMention.

"},"Structs/FeatureSentimentResults.html":{"name":"FeatureSentimentResults","abstract":"

FeatureSentimentResults.

"},"Structs/Features.html":{"name":"Features","abstract":"

Analysis features and options.

"},"Structs/Feed.html":{"name":"Feed","abstract":"

RSS or ATOM feed found on the webpage.

"},"Structs/KeywordsOptions.html":{"name":"KeywordsOptions","abstract":"

An option indicating whether or not important keywords from the analyzed content should be returned.

"},"Structs/KeywordsResult.html":{"name":"KeywordsResult","abstract":"

The most important keywords in the content, organized by relevance.

"},"Structs/ListModelsResults.html":{"name":"ListModelsResults","abstract":"

Models available for Relations and Entities features.

"},"Structs/MetadataOptions.html":{"name":"MetadataOptions","abstract":"

The Authors, Publication Date, and Title of the document. Supports URL and HTML input types.

"},"Structs/MetadataResult.html":{"name":"MetadataResult","abstract":"

The Authors, Publication Date, and Title of the document. Supports URL and HTML input types.

"},"Structs/Model.html":{"name":"Model","abstract":"

Model.

"},"Structs/Parameters.html":{"name":"Parameters","abstract":"

An object containing request parameters.

"},"Structs/RelationArgument.html":{"name":"RelationArgument","abstract":"

RelationArgument.

"},"Structs/RelationEntity.html":{"name":"RelationEntity","abstract":"

An entity that corresponds with an argument in a relation.

"},"Structs/RelationsOptions.html":{"name":"RelationsOptions","abstract":"

An option specifying if the relationships found between entities in the analyzed content should be returned.

"},"Structs/RelationsResult.html":{"name":"RelationsResult","abstract":"

The relations between entities found in the content.

"},"Structs/SemanticRolesAction.html":{"name":"SemanticRolesAction","abstract":"

SemanticRolesAction.

"},"Structs/SemanticRolesEntity.html":{"name":"SemanticRolesEntity","abstract":"

SemanticRolesEntity.

"},"Structs/SemanticRolesKeyword.html":{"name":"SemanticRolesKeyword","abstract":"

SemanticRolesKeyword.

"},"Structs/SemanticRolesObject.html":{"name":"SemanticRolesObject","abstract":"

SemanticRolesObject.

"},"Structs/SemanticRolesOptions.html":{"name":"SemanticRolesOptions","abstract":"

An option specifying whether or not to identify the subjects, actions, and verbs in the analyzed content.

"},"Structs/SemanticRolesResult.html":{"name":"SemanticRolesResult","abstract":"

The object containing the actions and the objects the actions act upon.

"},"Structs/SemanticRolesSubject.html":{"name":"SemanticRolesSubject","abstract":"

SemanticRolesSubject.

"},"Structs/SemanticRolesVerb.html":{"name":"SemanticRolesVerb","abstract":"

SemanticRolesVerb.

"},"Structs/SentimentOptions.html":{"name":"SentimentOptions","abstract":"

An option specifying if sentiment of detected entities, keywords, or phrases should be returned.

"},"Structs/SentimentResult.html":{"name":"SentimentResult","abstract":"

The sentiment of the content.

"},"Structs/TargetedEmotionResults.html":{"name":"TargetedEmotionResults","abstract":"

An object containing the emotion results for the target.

"},"Structs/TargetedSentimentResults.html":{"name":"TargetedSentimentResults","abstract":"

TargetedSentimentResults.

"},"Structs/Usage.html":{"name":"Usage","abstract":"

Usage information.

"},"Structs.html#/s:30NaturalLanguageUnderstandingV111JSONWrapperV":{"name":"JSONWrapper","abstract":"

Used internally to serialize and deserialize JSON."},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO013serializationF0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO08encodingF0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO011fileManagerF0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

Create a NaturalLanguageUnderstanding object.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a NaturalLanguageUnderstanding object.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a NaturalLanguageUnderstanding object.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C7analyzeyAA10ParametersV10parameters_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA15AnalysisResultsVc7successtF":{"name":"analyze(parameters:headers:failure:success:)","abstract":"

Analyze text, HTML, or a public webpage.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C10listModelsys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA04ListF7ResultsVc7successtF":{"name":"listModels(headers:failure:success:)","abstract":"

List models.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C11deleteModelySS7modelID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteF7ResultsVc7successtF":{"name":"deleteModel(modelID:headers:failure:success:)","abstract":"

Delete model.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html":{"name":"NaturalLanguageUnderstanding","abstract":"

Analyze various features of text content at scale. Provide text, raw HTML, or a public URL, and IBM Watson Natural"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file +{"Structs/Usage.html#/s:30NaturalLanguageUnderstandingV15UsageV8featuresSiSgvp":{"name":"features","abstract":"

Number of features used in the API call.

","parent_name":"Usage"},"Structs/Usage.html#/s:30NaturalLanguageUnderstandingV15UsageV14textCharactersSiSgvp":{"name":"textCharacters","abstract":"

Number of text characters processed.

","parent_name":"Usage"},"Structs/Usage.html#/s:30NaturalLanguageUnderstandingV15UsageV9textUnitsSiSgvp":{"name":"textUnits","abstract":"

Number of 10,000-character units processed.

","parent_name":"Usage"},"Structs/TargetedSentimentResults.html#/s:30NaturalLanguageUnderstandingV124TargetedSentimentResultsV4textSSSgvp":{"name":"text","abstract":"

Targeted text.

","parent_name":"TargetedSentimentResults"},"Structs/TargetedSentimentResults.html#/s:30NaturalLanguageUnderstandingV124TargetedSentimentResultsV5scoreSdSgvp":{"name":"score","abstract":"

Sentiment score from -1 (negative) to 1 (positive).

","parent_name":"TargetedSentimentResults"},"Structs/TargetedEmotionResults.html#/s:30NaturalLanguageUnderstandingV122TargetedEmotionResultsV4textSSSgvp":{"name":"text","abstract":"

Targeted text.

","parent_name":"TargetedEmotionResults"},"Structs/TargetedEmotionResults.html#/s:30NaturalLanguageUnderstandingV122TargetedEmotionResultsV7emotionAA0F6ScoresVSgvp":{"name":"emotion","abstract":"

An object containing the emotion results for the target.

","parent_name":"TargetedEmotionResults"},"Structs/SentimentResult.html#/s:30NaturalLanguageUnderstandingV115SentimentResultV8documentAA08DocumentE7ResultsVSgvp":{"name":"document","abstract":"

The document level sentiment.

","parent_name":"SentimentResult"},"Structs/SentimentResult.html#/s:30NaturalLanguageUnderstandingV115SentimentResultV7targetsSayAA08TargetedE7ResultsVGSgvp":{"name":"targets","abstract":"

The targeted sentiment to analyze.

","parent_name":"SentimentResult"},"Structs/SentimentOptions.html#/s:30NaturalLanguageUnderstandingV116SentimentOptionsV8documentSbSgvp":{"name":"document","abstract":"

Set this to false to hide document-level sentiment results.

","parent_name":"SentimentOptions"},"Structs/SentimentOptions.html#/s:30NaturalLanguageUnderstandingV116SentimentOptionsV7targetsSaySSGSgvp":{"name":"targets","abstract":"

Sentiment results will be returned for each target string that is found in the document.

","parent_name":"SentimentOptions"},"Structs/SentimentOptions.html#/s:30NaturalLanguageUnderstandingV116SentimentOptionsVACSbSg8document_SaySSGSg7targetstcfc":{"name":"init(document:targets:)","abstract":"

Initialize a SentimentOptions with member variables.

","parent_name":"SentimentOptions"},"Structs/SemanticRolesVerb.html#/s:30NaturalLanguageUnderstandingV117SemanticRolesVerbV4textSSSgvp":{"name":"text","abstract":"

The keyword text.

","parent_name":"SemanticRolesVerb"},"Structs/SemanticRolesVerb.html#/s:30NaturalLanguageUnderstandingV117SemanticRolesVerbV5tenseSSSgvp":{"name":"tense","abstract":"

Verb tense.

","parent_name":"SemanticRolesVerb"},"Structs/SemanticRolesSubject.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesSubjectV4textSSSgvp":{"name":"text","abstract":"

Text that corresponds to the subject role.

","parent_name":"SemanticRolesSubject"},"Structs/SemanticRolesSubject.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesSubjectV8entitiesSayAA0eF6EntityVGSgvp":{"name":"entities","abstract":"

Undocumented

","parent_name":"SemanticRolesSubject"},"Structs/SemanticRolesSubject.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesSubjectV8keywordsSayAA0eF7KeywordVGSgvp":{"name":"keywords","abstract":"

Undocumented

","parent_name":"SemanticRolesSubject"},"Structs/SemanticRolesResult.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesResultV8sentenceSSSgvp":{"name":"sentence","abstract":"

Sentence from the source that contains the subject, action, and object.

","parent_name":"SemanticRolesResult"},"Structs/SemanticRolesResult.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesResultV7subjectAA0eF7SubjectVSgvp":{"name":"subject","abstract":"

The extracted subject from the sentence.

","parent_name":"SemanticRolesResult"},"Structs/SemanticRolesResult.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesResultV6actionAA0eF6ActionVSgvp":{"name":"action","abstract":"

The extracted action from the sentence.

","parent_name":"SemanticRolesResult"},"Structs/SemanticRolesResult.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesResultV6objectAA0eF6ObjectVSgvp":{"name":"object","abstract":"

The extracted object from the sentence.

","parent_name":"SemanticRolesResult"},"Structs/SemanticRolesOptions.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesOptionsV5limitSiSgvp":{"name":"limit","abstract":"

Maximum number of semantic_roles results to return.

","parent_name":"SemanticRolesOptions"},"Structs/SemanticRolesOptions.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesOptionsV8keywordsSbSgvp":{"name":"keywords","abstract":"

Set this to true to return keyword information for subjects and objects.

","parent_name":"SemanticRolesOptions"},"Structs/SemanticRolesOptions.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesOptionsV8entitiesSbSgvp":{"name":"entities","abstract":"

Set this to true to return entity information for subjects and objects.

","parent_name":"SemanticRolesOptions"},"Structs/SemanticRolesOptions.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesOptionsVACSiSg5limit_SbSg8keywordsAF8entitiestcfc":{"name":"init(limit:keywords:entities:)","abstract":"

Initialize a SemanticRolesOptions with member variables.

","parent_name":"SemanticRolesOptions"},"Structs/SemanticRolesObject.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesObjectV4textSSSgvp":{"name":"text","abstract":"

Object text.

","parent_name":"SemanticRolesObject"},"Structs/SemanticRolesObject.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesObjectV8keywordsSayAA0eF7KeywordVGSgvp":{"name":"keywords","abstract":"

Undocumented

","parent_name":"SemanticRolesObject"},"Structs/SemanticRolesKeyword.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesKeywordV4textSSSgvp":{"name":"text","abstract":"

The keyword text.

","parent_name":"SemanticRolesKeyword"},"Structs/SemanticRolesEntity.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesEntityV4typeSSSgvp":{"name":"type","abstract":"

Entity type.

","parent_name":"SemanticRolesEntity"},"Structs/SemanticRolesEntity.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesEntityV4textSSSgvp":{"name":"text","abstract":"

The entity text.

","parent_name":"SemanticRolesEntity"},"Structs/SemanticRolesAction.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesActionV4textSSSgvp":{"name":"text","abstract":"

Analyzed text that corresponds to the action.

","parent_name":"SemanticRolesAction"},"Structs/SemanticRolesAction.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesActionV10normalizedSSSgvp":{"name":"normalized","abstract":"

normalized version of the action.

","parent_name":"SemanticRolesAction"},"Structs/SemanticRolesAction.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesActionV4verbAA0eF4VerbVSgvp":{"name":"verb","abstract":"

Undocumented

","parent_name":"SemanticRolesAction"},"Structs/RelationsResult.html#/s:30NaturalLanguageUnderstandingV115RelationsResultV5scoreSdSgvp":{"name":"score","abstract":"

Confidence score for the relation. Higher values indicate greater confidence.

","parent_name":"RelationsResult"},"Structs/RelationsResult.html#/s:30NaturalLanguageUnderstandingV115RelationsResultV8sentenceSSSgvp":{"name":"sentence","abstract":"

The sentence that contains the relation.

","parent_name":"RelationsResult"},"Structs/RelationsResult.html#/s:30NaturalLanguageUnderstandingV115RelationsResultV4typeSSSgvp":{"name":"type","abstract":"

The type of the relation.

","parent_name":"RelationsResult"},"Structs/RelationsResult.html#/s:30NaturalLanguageUnderstandingV115RelationsResultV9argumentsSayAA16RelationArgumentVGSgvp":{"name":"arguments","abstract":"

The extracted relation objects from the text.

","parent_name":"RelationsResult"},"Structs/RelationsOptions.html#/s:30NaturalLanguageUnderstandingV116RelationsOptionsV5modelSSSgvp":{"name":"model","abstract":"

Enter a custom model ID to override the default model.

","parent_name":"RelationsOptions"},"Structs/RelationsOptions.html#/s:30NaturalLanguageUnderstandingV116RelationsOptionsVACSSSg5model_tcfc":{"name":"init(model:)","abstract":"

Initialize a RelationsOptions with member variables.

","parent_name":"RelationsOptions"},"Structs/RelationEntity.html#/s:30NaturalLanguageUnderstandingV114RelationEntityV4textSSSgvp":{"name":"text","abstract":"

Text that corresponds to the entity.

","parent_name":"RelationEntity"},"Structs/RelationEntity.html#/s:30NaturalLanguageUnderstandingV114RelationEntityV4typeSSSgvp":{"name":"type","abstract":"

Entity type.

","parent_name":"RelationEntity"},"Structs/RelationArgument.html#/s:30NaturalLanguageUnderstandingV116RelationArgumentV8entitiesSayAA0E6EntityVGSgvp":{"name":"entities","abstract":"

Undocumented

","parent_name":"RelationArgument"},"Structs/RelationArgument.html#/s:30NaturalLanguageUnderstandingV116RelationArgumentV8locationSaySiGSgvp":{"name":"location","abstract":"

Character offsets indicating the beginning and end of the mention in the analyzed text.

","parent_name":"RelationArgument"},"Structs/RelationArgument.html#/s:30NaturalLanguageUnderstandingV116RelationArgumentV4textSSSgvp":{"name":"text","abstract":"

Text that corresponds to the argument.

","parent_name":"RelationArgument"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV4textSSSgvp":{"name":"text","abstract":"

The plain text to analyze.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV4htmlSSSgvp":{"name":"html","abstract":"

The HTML file to analyze.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV3urlSSSgvp":{"name":"url","abstract":"

The web page to analyze.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV8featuresAA8FeaturesVvp":{"name":"features","abstract":"

Specific features to analyze the document for.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV5cleanSbSgvp":{"name":"clean","abstract":"

Remove website elements, such as links, ads, etc.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV5xpathSSSgvp":{"name":"xpath","abstract":"

XPath query for targeting nodes in HTML.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV13fallbackToRawSbSgvp":{"name":"fallbackToRaw","abstract":"

Whether to use raw HTML content if text cleaning fails.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV18returnAnalyzedTextSbSgvp":{"name":"returnAnalyzedText","abstract":"

Whether or not to return the analyzed text.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV8languageSSSgvp":{"name":"language","abstract":"

ISO 639-1 code indicating the language to use in the analysis.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV19limitTextCharactersSiSgvp":{"name":"limitTextCharacters","abstract":"

Sets the maximum number of characters that are processed by the service.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersVAcA8FeaturesV8features_SSSg4textAG4htmlAG3urlSbSg5cleanAG5xpathAK13fallbackToRawAK18returnAnalyzedTextAG8languageSiSg05limitR10Characterstcfc":{"name":"init(features:text:html:url:clean:xpath:fallbackToRaw:returnAnalyzedText:language:limitTextCharacters:)","abstract":"

Initialize a Parameters with member variables.

","parent_name":"Parameters"},"Structs/Model.html#/s:30NaturalLanguageUnderstandingV15ModelV6statusSSSgvp":{"name":"status","abstract":"

Shows as available if the model is ready for use.

","parent_name":"Model"},"Structs/Model.html#/s:30NaturalLanguageUnderstandingV15ModelV7modelIDSSSgvp":{"name":"modelID","abstract":"

Unique model ID.

","parent_name":"Model"},"Structs/Model.html#/s:30NaturalLanguageUnderstandingV15ModelV8languageSSSgvp":{"name":"language","abstract":"

ISO 639-1 code indicating the language of the model.

","parent_name":"Model"},"Structs/Model.html#/s:30NaturalLanguageUnderstandingV15ModelV11descriptionSSSgvp":{"name":"description","abstract":"

Model description.

","parent_name":"Model"},"Structs/MetadataResult.html#/s:30NaturalLanguageUnderstandingV114MetadataResultV7authorsSayAA6AuthorVGSgvp":{"name":"authors","abstract":"

The authors of the document.

","parent_name":"MetadataResult"},"Structs/MetadataResult.html#/s:30NaturalLanguageUnderstandingV114MetadataResultV15publicationDateSSSgvp":{"name":"publicationDate","abstract":"

The publication date in the format ISO 8601.

","parent_name":"MetadataResult"},"Structs/MetadataResult.html#/s:30NaturalLanguageUnderstandingV114MetadataResultV5titleSSSgvp":{"name":"title","abstract":"

The title of the document.

","parent_name":"MetadataResult"},"Structs/MetadataResult.html#/s:30NaturalLanguageUnderstandingV114MetadataResultV5imageSSSgvp":{"name":"image","abstract":"

URL of a prominent image on the webpage.

","parent_name":"MetadataResult"},"Structs/MetadataResult.html#/s:30NaturalLanguageUnderstandingV114MetadataResultV5feedsSayAA4FeedVGSgvp":{"name":"feeds","abstract":"

RSS/ATOM feeds found on the webpage.

","parent_name":"MetadataResult"},"Structs/MetadataOptions.html#/s:30NaturalLanguageUnderstandingV115MetadataOptionsV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"MetadataOptions"},"Structs/MetadataOptions.html#/s:30NaturalLanguageUnderstandingV115MetadataOptionsVACs10DictionaryVySSAA4JSONOG20additionalProperties_tcfc":{"name":"init(additionalProperties:)","abstract":"

Initialize a MetadataOptions.

","parent_name":"MetadataOptions"},"Structs/MetadataOptions.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"MetadataOptions"},"Structs/ListModelsResults.html#/s:30NaturalLanguageUnderstandingV117ListModelsResultsV6modelsSayAA5ModelVGSgvp":{"name":"models","abstract":"

Undocumented

","parent_name":"ListModelsResults"},"Structs/KeywordsResult.html#/s:30NaturalLanguageUnderstandingV114KeywordsResultV9relevanceSdSgvp":{"name":"relevance","abstract":"

Relevance score from 0 to 1. Higher values indicate greater relevance.

","parent_name":"KeywordsResult"},"Structs/KeywordsResult.html#/s:30NaturalLanguageUnderstandingV114KeywordsResultV4textSSSgvp":{"name":"text","abstract":"

The keyword text.

","parent_name":"KeywordsResult"},"Structs/KeywordsResult.html#/s:30NaturalLanguageUnderstandingV114KeywordsResultV7emotionAA13EmotionScoresVSgvp":{"name":"emotion","abstract":"

Emotion analysis results for the keyword, enabled with the emotion option.

","parent_name":"KeywordsResult"},"Structs/KeywordsResult.html#/s:30NaturalLanguageUnderstandingV114KeywordsResultV9sentimentAA23FeatureSentimentResultsVSgvp":{"name":"sentiment","abstract":"

Sentiment analysis results for the keyword, enabled with the sentiment option.

","parent_name":"KeywordsResult"},"Structs/KeywordsOptions.html#/s:30NaturalLanguageUnderstandingV115KeywordsOptionsV5limitSiSgvp":{"name":"limit","abstract":"

Maximum number of keywords to return.

","parent_name":"KeywordsOptions"},"Structs/KeywordsOptions.html#/s:30NaturalLanguageUnderstandingV115KeywordsOptionsV9sentimentSbSgvp":{"name":"sentiment","abstract":"

Set this to true to return sentiment information for detected keywords.

","parent_name":"KeywordsOptions"},"Structs/KeywordsOptions.html#/s:30NaturalLanguageUnderstandingV115KeywordsOptionsV7emotionSbSgvp":{"name":"emotion","abstract":"

Set this to true to analyze emotion for detected keywords.

","parent_name":"KeywordsOptions"},"Structs/KeywordsOptions.html#/s:30NaturalLanguageUnderstandingV115KeywordsOptionsVACSiSg5limit_SbSg9sentimentAF7emotiontcfc":{"name":"init(limit:sentiment:emotion:)","abstract":"

Initialize a KeywordsOptions with member variables.

","parent_name":"KeywordsOptions"},"Structs/Feed.html#/s:30NaturalLanguageUnderstandingV14FeedV4linkSSSgvp":{"name":"link","abstract":"

URL of the RSS or ATOM feed.

","parent_name":"Feed"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV8conceptsAA15ConceptsOptionsVSgvp":{"name":"concepts","abstract":"

Whether or not to return the concepts that are mentioned in the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV7emotionAA14EmotionOptionsVSgvp":{"name":"emotion","abstract":"

Whether or not to extract the emotions implied in the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV8entitiesAA15EntitiesOptionsVSgvp":{"name":"entities","abstract":"

Whether or not to extract detected entity objects from the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV8keywordsAA15KeywordsOptionsVSgvp":{"name":"keywords","abstract":"

Whether or not to return the keywords in the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV8metadataAA15MetadataOptionsVSgvp":{"name":"metadata","abstract":"

Whether or not the author, publication date, and title of the analyzed text should be returned. This parameter is","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV9relationsAA16RelationsOptionsVSgvp":{"name":"relations","abstract":"

Whether or not to return the relationships between detected entities in the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV13semanticRolesAA08SemanticG7OptionsVSgvp":{"name":"semanticRoles","abstract":"

Whether or not to return the subject-action-object relations from the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV9sentimentAA16SentimentOptionsVSgvp":{"name":"sentiment","abstract":"

Whether or not to return the overall sentiment of the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV10categoriesAA17CategoriesOptionsVSgvp":{"name":"categories","abstract":"

Whether or not to return the high level category the content is categorized as (i.e. news, art).

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesVAcA15ConceptsOptionsVSg8concepts_AA07EmotionG0VSg7emotionAA08EntitiesG0VSg8entitiesAA08KeywordsG0VSg8keywordsAA08MetadataG0VSg8metadataAA09RelationsG0VSg9relationsAA013SemanticRolesG0VSg08semanticT0AA09SentimentG0VSg9sentimentAA010CategoriesG0VSg10categoriestcfc":{"name":"init(concepts:emotion:entities:keywords:metadata:relations:semanticRoles:sentiment:categories:)","abstract":"

Initialize a Features with member variables.

","parent_name":"Features"},"Structs/FeatureSentimentResults.html#/s:30NaturalLanguageUnderstandingV123FeatureSentimentResultsV5scoreSdSgvp":{"name":"score","abstract":"

Sentiment score from -1 (negative) to 1 (positive).

","parent_name":"FeatureSentimentResults"},"Structs/EntityMention.html#/s:30NaturalLanguageUnderstandingV113EntityMentionV4textSSSgvp":{"name":"text","abstract":"

Entity mention text.

","parent_name":"EntityMention"},"Structs/EntityMention.html#/s:30NaturalLanguageUnderstandingV113EntityMentionV8locationSaySiGSgvp":{"name":"location","abstract":"

Character offsets indicating the beginning and end of the mention in the analyzed text.

","parent_name":"EntityMention"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV4typeSSSgvp":{"name":"type","abstract":"

Entity type.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV4textSSSgvp":{"name":"text","abstract":"

The name of the entity.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV9relevanceSdSgvp":{"name":"relevance","abstract":"

Relevance score from 0 to 1. Higher values indicate greater relevance.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV8mentionsSayAA13EntityMentionVGSgvp":{"name":"mentions","abstract":"

Entity mentions and locations.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV5countSiSgvp":{"name":"count","abstract":"

How many times the entity was mentioned in the text.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV7emotionAA13EmotionScoresVSgvp":{"name":"emotion","abstract":"

Emotion analysis results for the entity, enabled with the emotion option.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV9sentimentAA23FeatureSentimentResultsVSgvp":{"name":"sentiment","abstract":"

Sentiment analysis results for the entity, enabled with the sentiment option.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV14disambiguationAA014DisambiguationF0VSgvp":{"name":"disambiguation","abstract":"

Disambiguation information for the entity.

","parent_name":"EntitiesResult"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsV5limitSiSgvp":{"name":"limit","abstract":"

Maximum number of entities to return.

","parent_name":"EntitiesOptions"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsV8mentionsSbSgvp":{"name":"mentions","abstract":"

Set this to true to return locations of entity mentions.

","parent_name":"EntitiesOptions"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsV5modelSSSgvp":{"name":"model","abstract":"

Enter a custom model ID to override the standard entity detection model.

","parent_name":"EntitiesOptions"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsV9sentimentSbSgvp":{"name":"sentiment","abstract":"

Set this to true to return sentiment information for detected entities.

","parent_name":"EntitiesOptions"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsV7emotionSbSgvp":{"name":"emotion","abstract":"

Set this to true to analyze emotion for detected keywords.

","parent_name":"EntitiesOptions"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsVACSiSg5limit_SbSg8mentionsSSSg5modelAF9sentimentAF7emotiontcfc":{"name":"init(limit:mentions:model:sentiment:emotion:)","abstract":"

Initialize a EntitiesOptions with member variables.

","parent_name":"EntitiesOptions"},"Structs/EmotionScores.html#/s:30NaturalLanguageUnderstandingV113EmotionScoresV5angerSdSgvp":{"name":"anger","abstract":"

Anger score from 0 to 1. A higher score means that the text is more likely to convey anger.

","parent_name":"EmotionScores"},"Structs/EmotionScores.html#/s:30NaturalLanguageUnderstandingV113EmotionScoresV7disgustSdSgvp":{"name":"disgust","abstract":"

Disgust score from 0 to 1. A higher score means that the text is more likely to convey disgust.

","parent_name":"EmotionScores"},"Structs/EmotionScores.html#/s:30NaturalLanguageUnderstandingV113EmotionScoresV4fearSdSgvp":{"name":"fear","abstract":"

Fear score from 0 to 1. A higher score means that the text is more likely to convey fear.

","parent_name":"EmotionScores"},"Structs/EmotionScores.html#/s:30NaturalLanguageUnderstandingV113EmotionScoresV3joySdSgvp":{"name":"joy","abstract":"

Joy score from 0 to 1. A higher score means that the text is more likely to convey joy.

","parent_name":"EmotionScores"},"Structs/EmotionScores.html#/s:30NaturalLanguageUnderstandingV113EmotionScoresV7sadnessSdSgvp":{"name":"sadness","abstract":"

Sadness score from 0 to 1. A higher score means that the text is more likely to convey sadness.

","parent_name":"EmotionScores"},"Structs/EmotionResult.html#/s:30NaturalLanguageUnderstandingV113EmotionResultV8documentAA08DocumentE7ResultsVSgvp":{"name":"document","abstract":"

The returned emotion results across the document.

","parent_name":"EmotionResult"},"Structs/EmotionResult.html#/s:30NaturalLanguageUnderstandingV113EmotionResultV7targetsSayAA08TargetedE7ResultsVGSgvp":{"name":"targets","abstract":"

The returned emotion results per specified target.

","parent_name":"EmotionResult"},"Structs/EmotionOptions.html#/s:30NaturalLanguageUnderstandingV114EmotionOptionsV8documentSbSgvp":{"name":"document","abstract":"

Set this to false to hide document-level emotion results.

","parent_name":"EmotionOptions"},"Structs/EmotionOptions.html#/s:30NaturalLanguageUnderstandingV114EmotionOptionsV7targetsSaySSGSgvp":{"name":"targets","abstract":"

Emotion results will be returned for each target string that is found in the document.

","parent_name":"EmotionOptions"},"Structs/EmotionOptions.html#/s:30NaturalLanguageUnderstandingV114EmotionOptionsVACSbSg8document_SaySSGSg7targetstcfc":{"name":"init(document:targets:)","abstract":"

Initialize a EmotionOptions with member variables.

","parent_name":"EmotionOptions"},"Structs/DocumentSentimentResults.html#/s:30NaturalLanguageUnderstandingV124DocumentSentimentResultsV5labelSSSgvp":{"name":"label","abstract":"

Indicates whether the sentiment is positive, neutral, or negative.

","parent_name":"DocumentSentimentResults"},"Structs/DocumentSentimentResults.html#/s:30NaturalLanguageUnderstandingV124DocumentSentimentResultsV5scoreSdSgvp":{"name":"score","abstract":"

Sentiment score from -1 (negative) to 1 (positive).

","parent_name":"DocumentSentimentResults"},"Structs/DocumentEmotionResults.html#/s:30NaturalLanguageUnderstandingV122DocumentEmotionResultsV7emotionAA0F6ScoresVSgvp":{"name":"emotion","abstract":"

An object containing the emotion results for the document.

","parent_name":"DocumentEmotionResults"},"Structs/DisambiguationResult.html#/s:30NaturalLanguageUnderstandingV120DisambiguationResultV4nameSSSgvp":{"name":"name","abstract":"

Common entity name.

","parent_name":"DisambiguationResult"},"Structs/DisambiguationResult.html#/s:30NaturalLanguageUnderstandingV120DisambiguationResultV15dbpediaResourceSSSgvp":{"name":"dbpediaResource","abstract":"

Link to the corresponding DBpedia resource.

","parent_name":"DisambiguationResult"},"Structs/DisambiguationResult.html#/s:30NaturalLanguageUnderstandingV120DisambiguationResultV7subtypeSaySSGSgvp":{"name":"subtype","abstract":"

Entity subtype information.

","parent_name":"DisambiguationResult"},"Structs/DeleteModelResults.html#/s:30NaturalLanguageUnderstandingV118DeleteModelResultsV7deletedSSSgvp":{"name":"deleted","abstract":"

model_id of the deleted model.

","parent_name":"DeleteModelResults"},"Structs/ConceptsResult.html#/s:30NaturalLanguageUnderstandingV114ConceptsResultV4textSSSgvp":{"name":"text","abstract":"

Name of the concept.

","parent_name":"ConceptsResult"},"Structs/ConceptsResult.html#/s:30NaturalLanguageUnderstandingV114ConceptsResultV9relevanceSdSgvp":{"name":"relevance","abstract":"

Relevance score between 0 and 1. Higher scores indicate greater relevance.

","parent_name":"ConceptsResult"},"Structs/ConceptsResult.html#/s:30NaturalLanguageUnderstandingV114ConceptsResultV15dbpediaResourceSSSgvp":{"name":"dbpediaResource","abstract":"

Link to the corresponding DBpedia resource.

","parent_name":"ConceptsResult"},"Structs/ConceptsOptions.html#/s:30NaturalLanguageUnderstandingV115ConceptsOptionsV5limitSiSgvp":{"name":"limit","abstract":"

Maximum number of concepts to return.

","parent_name":"ConceptsOptions"},"Structs/ConceptsOptions.html#/s:30NaturalLanguageUnderstandingV115ConceptsOptionsVACSiSg5limit_tcfc":{"name":"init(limit:)","abstract":"

Initialize a ConceptsOptions with member variables.

","parent_name":"ConceptsOptions"},"Structs/CategoriesResult.html#/s:30NaturalLanguageUnderstandingV116CategoriesResultV5labelSSSgvp":{"name":"label","abstract":"

The path to the category through the taxonomy hierarchy.

","parent_name":"CategoriesResult"},"Structs/CategoriesResult.html#/s:30NaturalLanguageUnderstandingV116CategoriesResultV5scoreSdSgvp":{"name":"score","abstract":"

Confidence score for the category classification. Higher values indicate greater confidence.

","parent_name":"CategoriesResult"},"Structs/CategoriesOptions.html#/s:30NaturalLanguageUnderstandingV117CategoriesOptionsV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"CategoriesOptions"},"Structs/CategoriesOptions.html#/s:30NaturalLanguageUnderstandingV117CategoriesOptionsVACs10DictionaryVySSAA4JSONOG20additionalProperties_tcfc":{"name":"init(additionalProperties:)","abstract":"

Initialize a CategoriesOptions.

","parent_name":"CategoriesOptions"},"Structs/CategoriesOptions.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"CategoriesOptions"},"Structs/Author.html#/s:30NaturalLanguageUnderstandingV16AuthorV4nameSSSgvp":{"name":"name","abstract":"

Name of the author.

","parent_name":"Author"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV8languageSSSgvp":{"name":"language","abstract":"

Language used to analyze the text.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV12analyzedTextSSSgvp":{"name":"analyzedText","abstract":"

Text that was used in the analysis.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV12retrievedUrlSSSgvp":{"name":"retrievedUrl","abstract":"

URL that was used to retrieve HTML content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV5usageAA5UsageVSgvp":{"name":"usage","abstract":"

API usage information for the request.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV8conceptsSayAA14ConceptsResultVGSgvp":{"name":"concepts","abstract":"

The general concepts referenced or alluded to in the specified content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV8entitiesSayAA14EntitiesResultVGSgvp":{"name":"entities","abstract":"

The important entities in the specified content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV8keywordsSayAA14KeywordsResultVGSgvp":{"name":"keywords","abstract":"

The important keywords in content organized by relevance.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV10categoriesSayAA16CategoriesResultVGSgvp":{"name":"categories","abstract":"

The hierarchical 5-level taxonomy the content is categorized into.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV7emotionAA13EmotionResultVSgvp":{"name":"emotion","abstract":"

The anger, disgust, fear, joy, or sadness conveyed by the content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV8metadataAA14MetadataResultVSgvp":{"name":"metadata","abstract":"

The metadata holds author information, publication date and the title of the text/HTML content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV9relationsSayAA15RelationsResultVGSgvp":{"name":"relations","abstract":"

The relationships between entities in the content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV13semanticRolesSayAA08SemanticH6ResultVGSgvp":{"name":"semanticRoles","abstract":"

The subjects of actions and the objects the actions act upon.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV9sentimentAA15SentimentResultVSgvp":{"name":"sentiment","abstract":"

The sentiment of the content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html":{"name":"AnalysisResults","abstract":"

Results of the analysis, organized by feature.

"},"Structs/Author.html":{"name":"Author","abstract":"

The author of the analyzed content.

"},"Structs/CategoriesOptions.html":{"name":"CategoriesOptions","abstract":"

The hierarchical 5-level taxonomy the content is categorized into.

"},"Structs/CategoriesResult.html":{"name":"CategoriesResult","abstract":"

The hierarchical 5-level taxonomy the content is categorized into.

"},"Structs/ConceptsOptions.html":{"name":"ConceptsOptions","abstract":"

Whether or not to analyze content for general concepts that are referenced or alluded to.

"},"Structs/ConceptsResult.html":{"name":"ConceptsResult","abstract":"

The general concepts referenced or alluded to in the specified content.

"},"Structs/DeleteModelResults.html":{"name":"DeleteModelResults","abstract":"

Information about the deleted model.

"},"Structs/DisambiguationResult.html":{"name":"DisambiguationResult","abstract":"

Disambiguation information for the entity.

"},"Structs/DocumentEmotionResults.html":{"name":"DocumentEmotionResults","abstract":"

An object containing the emotion results of a document.

"},"Structs/DocumentSentimentResults.html":{"name":"DocumentSentimentResults","abstract":"

DocumentSentimentResults.

"},"Structs/EmotionOptions.html":{"name":"EmotionOptions","abstract":"

Whether or not to return emotion analysis of the content.

"},"Structs/EmotionResult.html":{"name":"EmotionResult","abstract":"

The detected anger, disgust, fear, joy, or sadness that is conveyed by the content. Emotion information can be returned for detected entities, keywords, or user-specified target phrases found in the text.

"},"Structs/EmotionScores.html":{"name":"EmotionScores","abstract":"

EmotionScores.

"},"Structs/EntitiesOptions.html":{"name":"EntitiesOptions","abstract":"

Whether or not to return important people, places, geopolitical, and other entities detected in the analyzed content.

"},"Structs/EntitiesResult.html":{"name":"EntitiesResult","abstract":"

The important people, places, geopolitical entities and other types of entities in your content.

"},"Structs/EntityMention.html":{"name":"EntityMention","abstract":"

EntityMention.

"},"Structs/FeatureSentimentResults.html":{"name":"FeatureSentimentResults","abstract":"

FeatureSentimentResults.

"},"Structs/Features.html":{"name":"Features","abstract":"

Analysis features and options.

"},"Structs/Feed.html":{"name":"Feed","abstract":"

RSS or ATOM feed found on the webpage.

"},"Structs/KeywordsOptions.html":{"name":"KeywordsOptions","abstract":"

An option indicating whether or not important keywords from the analyzed content should be returned.

"},"Structs/KeywordsResult.html":{"name":"KeywordsResult","abstract":"

The most important keywords in the content, organized by relevance.

"},"Structs/ListModelsResults.html":{"name":"ListModelsResults","abstract":"

Models available for Relations and Entities features.

"},"Structs/MetadataOptions.html":{"name":"MetadataOptions","abstract":"

The Authors, Publication Date, and Title of the document. Supports URL and HTML input types.

"},"Structs/MetadataResult.html":{"name":"MetadataResult","abstract":"

The Authors, Publication Date, and Title of the document. Supports URL and HTML input types.

"},"Structs/Model.html":{"name":"Model","abstract":"

Model.

"},"Structs/Parameters.html":{"name":"Parameters","abstract":"

An object containing request parameters.

"},"Structs/RelationArgument.html":{"name":"RelationArgument","abstract":"

RelationArgument.

"},"Structs/RelationEntity.html":{"name":"RelationEntity","abstract":"

An entity that corresponds with an argument in a relation.

"},"Structs/RelationsOptions.html":{"name":"RelationsOptions","abstract":"

An option specifying if the relationships found between entities in the analyzed content should be returned.

"},"Structs/RelationsResult.html":{"name":"RelationsResult","abstract":"

The relations between entities found in the content.

"},"Structs/SemanticRolesAction.html":{"name":"SemanticRolesAction","abstract":"

SemanticRolesAction.

"},"Structs/SemanticRolesEntity.html":{"name":"SemanticRolesEntity","abstract":"

SemanticRolesEntity.

"},"Structs/SemanticRolesKeyword.html":{"name":"SemanticRolesKeyword","abstract":"

SemanticRolesKeyword.

"},"Structs/SemanticRolesObject.html":{"name":"SemanticRolesObject","abstract":"

SemanticRolesObject.

"},"Structs/SemanticRolesOptions.html":{"name":"SemanticRolesOptions","abstract":"

An option specifying whether or not to identify the subjects, actions, and verbs in the analyzed content.

"},"Structs/SemanticRolesResult.html":{"name":"SemanticRolesResult","abstract":"

The object containing the actions and the objects the actions act upon.

"},"Structs/SemanticRolesSubject.html":{"name":"SemanticRolesSubject","abstract":"

SemanticRolesSubject.

"},"Structs/SemanticRolesVerb.html":{"name":"SemanticRolesVerb","abstract":"

SemanticRolesVerb.

"},"Structs/SentimentOptions.html":{"name":"SentimentOptions","abstract":"

An option specifying if sentiment of detected entities, keywords, or phrases should be returned.

"},"Structs/SentimentResult.html":{"name":"SentimentResult","abstract":"

The sentiment of the content.

"},"Structs/TargetedEmotionResults.html":{"name":"TargetedEmotionResults","abstract":"

An object containing the emotion results for the target.

"},"Structs/TargetedSentimentResults.html":{"name":"TargetedSentimentResults","abstract":"

TargetedSentimentResults.

"},"Structs/Usage.html":{"name":"Usage","abstract":"

Usage information.

"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO013serializationF0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO08encodingF0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO011fileManagerF0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

Create a NaturalLanguageUnderstanding object.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a NaturalLanguageUnderstanding object.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a NaturalLanguageUnderstanding object.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C7analyzeyAA10ParametersV10parameters_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA15AnalysisResultsVc7successtF":{"name":"analyze(parameters:headers:failure:success:)","abstract":"

Analyze text, HTML, or a public webpage.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C10listModelsys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA04ListF7ResultsVc7successtF":{"name":"listModels(headers:failure:success:)","abstract":"

List models.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C11deleteModelySS7modelID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteF7ResultsVc7successtF":{"name":"deleteModel(modelID:headers:failure:success:)","abstract":"

Delete model.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html":{"name":"NaturalLanguageUnderstanding","abstract":"

Analyze various features of text content at scale. Provide text, raw HTML, or a public URL, and IBM Watson Natural"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/docSet.dsidx b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/docSet.dsidx index 21686e666..2cd033fea 100644 Binary files a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/docSet.dsidx and b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.docset/Contents/Resources/docSet.dsidx differ diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.tgz b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.tgz index 2816959e5..37ef31d85 100644 Binary files a/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.tgz and b/docs/swift-api/services/NaturalLanguageUnderstandingV1/docsets/.tgz differ diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/index.html b/docs/swift-api/services/NaturalLanguageUnderstandingV1/index.html index fc872a96f..14106f1b0 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/index.html +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/index.html @@ -106,9 +106,6 @@ - @@ -229,7 +226,8 @@

Services

  • Assistant
  • Discovery
  • -
  • Language Translator
  • +
  • Language Translator V2
  • +
  • Language Translator V3
  • Natural Language Classifier
  • Natural Language Understanding
  • Personality Insights
  • @@ -274,7 +272,7 @@

    Swift Package Manager

    Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

    dependencies: [
    -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
    +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
     ]
     

    Service Instances

    @@ -317,7 +315,7 @@

    Username and Password

    API Key

    -

    Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

    +

    Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

    let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
     

    Using IAM

    @@ -552,7 +550,12 @@

    Private Data Collections

  • IBM Discovery - Documentation
  • IBM Discovery - Demo
-

Language Translator

+

Language Translator V2

+ +

Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

@@ -563,6 +566,25 @@

Language Translator

let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} + +

Language Translator V3

+ +

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

+ +

The following example demonstrates how to use the Language Translator service:

+
import LanguageTranslatorV3
+
+let username = "your-username-here"
+let password = "your-password-here"
+let version = "yyyy-mm-dd" // use today's date for the most recent version
+let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
+
 let failure = { (error: Error) in print(error) }
 let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
 languageTranslator.translate(request: request, failure: failure) {
@@ -953,7 +975,7 @@ 

Visual Recognition

let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -961,6 +983,10 @@

Visual Recognition

print(classifiedImages) }
+ +

Note: a different initializer is used for authentication with instances created before May 23, 2018:

+
let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
+

Using Core ML

The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

@@ -1012,7 +1038,7 @@

Bundlin diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/search.json b/docs/swift-api/services/NaturalLanguageUnderstandingV1/search.json index 3944241cb..5956d7927 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/search.json +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/search.json @@ -1 +1 @@ -{"Structs/Usage.html#/s:30NaturalLanguageUnderstandingV15UsageV8featuresSiSgvp":{"name":"features","abstract":"

Number of features used in the API call.

","parent_name":"Usage"},"Structs/Usage.html#/s:30NaturalLanguageUnderstandingV15UsageV14textCharactersSiSgvp":{"name":"textCharacters","abstract":"

Number of text characters processed.

","parent_name":"Usage"},"Structs/Usage.html#/s:30NaturalLanguageUnderstandingV15UsageV9textUnitsSiSgvp":{"name":"textUnits","abstract":"

Number of 10,000-character units processed.

","parent_name":"Usage"},"Structs/TargetedSentimentResults.html#/s:30NaturalLanguageUnderstandingV124TargetedSentimentResultsV4textSSSgvp":{"name":"text","abstract":"

Targeted text.

","parent_name":"TargetedSentimentResults"},"Structs/TargetedSentimentResults.html#/s:30NaturalLanguageUnderstandingV124TargetedSentimentResultsV5scoreSdSgvp":{"name":"score","abstract":"

Sentiment score from -1 (negative) to 1 (positive).

","parent_name":"TargetedSentimentResults"},"Structs/TargetedEmotionResults.html#/s:30NaturalLanguageUnderstandingV122TargetedEmotionResultsV4textSSSgvp":{"name":"text","abstract":"

Targeted text.

","parent_name":"TargetedEmotionResults"},"Structs/TargetedEmotionResults.html#/s:30NaturalLanguageUnderstandingV122TargetedEmotionResultsV7emotionAA0F6ScoresVSgvp":{"name":"emotion","abstract":"

An object containing the emotion results for the target.

","parent_name":"TargetedEmotionResults"},"Structs/SentimentResult.html#/s:30NaturalLanguageUnderstandingV115SentimentResultV8documentAA08DocumentE7ResultsVSgvp":{"name":"document","abstract":"

The document level sentiment.

","parent_name":"SentimentResult"},"Structs/SentimentResult.html#/s:30NaturalLanguageUnderstandingV115SentimentResultV7targetsSayAA08TargetedE7ResultsVGSgvp":{"name":"targets","abstract":"

The targeted sentiment to analyze.

","parent_name":"SentimentResult"},"Structs/SentimentOptions.html#/s:30NaturalLanguageUnderstandingV116SentimentOptionsV8documentSbSgvp":{"name":"document","abstract":"

Set this to false to hide document-level sentiment results.

","parent_name":"SentimentOptions"},"Structs/SentimentOptions.html#/s:30NaturalLanguageUnderstandingV116SentimentOptionsV7targetsSaySSGSgvp":{"name":"targets","abstract":"

Sentiment results will be returned for each target string that is found in the document.

","parent_name":"SentimentOptions"},"Structs/SentimentOptions.html#/s:30NaturalLanguageUnderstandingV116SentimentOptionsVACSbSg8document_SaySSGSg7targetstcfc":{"name":"init(document:targets:)","abstract":"

Initialize a SentimentOptions with member variables.

","parent_name":"SentimentOptions"},"Structs/SemanticRolesVerb.html#/s:30NaturalLanguageUnderstandingV117SemanticRolesVerbV4textSSSgvp":{"name":"text","abstract":"

The keyword text.

","parent_name":"SemanticRolesVerb"},"Structs/SemanticRolesVerb.html#/s:30NaturalLanguageUnderstandingV117SemanticRolesVerbV5tenseSSSgvp":{"name":"tense","abstract":"

Verb tense.

","parent_name":"SemanticRolesVerb"},"Structs/SemanticRolesSubject.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesSubjectV4textSSSgvp":{"name":"text","abstract":"

Text that corresponds to the subject role.

","parent_name":"SemanticRolesSubject"},"Structs/SemanticRolesSubject.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesSubjectV8entitiesSayAA0eF6EntityVGSgvp":{"name":"entities","abstract":"

Undocumented

","parent_name":"SemanticRolesSubject"},"Structs/SemanticRolesSubject.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesSubjectV8keywordsSayAA0eF7KeywordVGSgvp":{"name":"keywords","abstract":"

Undocumented

","parent_name":"SemanticRolesSubject"},"Structs/SemanticRolesResult.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesResultV8sentenceSSSgvp":{"name":"sentence","abstract":"

Sentence from the source that contains the subject, action, and object.

","parent_name":"SemanticRolesResult"},"Structs/SemanticRolesResult.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesResultV7subjectAA0eF7SubjectVSgvp":{"name":"subject","abstract":"

The extracted subject from the sentence.

","parent_name":"SemanticRolesResult"},"Structs/SemanticRolesResult.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesResultV6actionAA0eF6ActionVSgvp":{"name":"action","abstract":"

The extracted action from the sentence.

","parent_name":"SemanticRolesResult"},"Structs/SemanticRolesResult.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesResultV6objectAA0eF6ObjectVSgvp":{"name":"object","abstract":"

The extracted object from the sentence.

","parent_name":"SemanticRolesResult"},"Structs/SemanticRolesOptions.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesOptionsV5limitSiSgvp":{"name":"limit","abstract":"

Maximum number of semantic_roles results to return.

","parent_name":"SemanticRolesOptions"},"Structs/SemanticRolesOptions.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesOptionsV8keywordsSbSgvp":{"name":"keywords","abstract":"

Set this to true to return keyword information for subjects and objects.

","parent_name":"SemanticRolesOptions"},"Structs/SemanticRolesOptions.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesOptionsV8entitiesSbSgvp":{"name":"entities","abstract":"

Set this to true to return entity information for subjects and objects.

","parent_name":"SemanticRolesOptions"},"Structs/SemanticRolesOptions.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesOptionsVACSiSg5limit_SbSg8keywordsAF8entitiestcfc":{"name":"init(limit:keywords:entities:)","abstract":"

Initialize a SemanticRolesOptions with member variables.

","parent_name":"SemanticRolesOptions"},"Structs/SemanticRolesObject.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesObjectV4textSSSgvp":{"name":"text","abstract":"

Object text.

","parent_name":"SemanticRolesObject"},"Structs/SemanticRolesObject.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesObjectV8keywordsSayAA0eF7KeywordVGSgvp":{"name":"keywords","abstract":"

Undocumented

","parent_name":"SemanticRolesObject"},"Structs/SemanticRolesKeyword.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesKeywordV4textSSSgvp":{"name":"text","abstract":"

The keyword text.

","parent_name":"SemanticRolesKeyword"},"Structs/SemanticRolesEntity.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesEntityV4typeSSSgvp":{"name":"type","abstract":"

Entity type.

","parent_name":"SemanticRolesEntity"},"Structs/SemanticRolesEntity.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesEntityV4textSSSgvp":{"name":"text","abstract":"

The entity text.

","parent_name":"SemanticRolesEntity"},"Structs/SemanticRolesAction.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesActionV4textSSSgvp":{"name":"text","abstract":"

Analyzed text that corresponds to the action.

","parent_name":"SemanticRolesAction"},"Structs/SemanticRolesAction.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesActionV10normalizedSSSgvp":{"name":"normalized","abstract":"

normalized version of the action.

","parent_name":"SemanticRolesAction"},"Structs/SemanticRolesAction.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesActionV4verbAA0eF4VerbVSgvp":{"name":"verb","abstract":"

Undocumented

","parent_name":"SemanticRolesAction"},"Structs/RelationsResult.html#/s:30NaturalLanguageUnderstandingV115RelationsResultV5scoreSdSgvp":{"name":"score","abstract":"

Confidence score for the relation. Higher values indicate greater confidence.

","parent_name":"RelationsResult"},"Structs/RelationsResult.html#/s:30NaturalLanguageUnderstandingV115RelationsResultV8sentenceSSSgvp":{"name":"sentence","abstract":"

The sentence that contains the relation.

","parent_name":"RelationsResult"},"Structs/RelationsResult.html#/s:30NaturalLanguageUnderstandingV115RelationsResultV4typeSSSgvp":{"name":"type","abstract":"

The type of the relation.

","parent_name":"RelationsResult"},"Structs/RelationsResult.html#/s:30NaturalLanguageUnderstandingV115RelationsResultV9argumentsSayAA16RelationArgumentVGSgvp":{"name":"arguments","abstract":"

The extracted relation objects from the text.

","parent_name":"RelationsResult"},"Structs/RelationsOptions.html#/s:30NaturalLanguageUnderstandingV116RelationsOptionsV5modelSSSgvp":{"name":"model","abstract":"

Enter a custom model ID to override the default model.

","parent_name":"RelationsOptions"},"Structs/RelationsOptions.html#/s:30NaturalLanguageUnderstandingV116RelationsOptionsVACSSSg5model_tcfc":{"name":"init(model:)","abstract":"

Initialize a RelationsOptions with member variables.

","parent_name":"RelationsOptions"},"Structs/RelationEntity.html#/s:30NaturalLanguageUnderstandingV114RelationEntityV4textSSSgvp":{"name":"text","abstract":"

Text that corresponds to the entity.

","parent_name":"RelationEntity"},"Structs/RelationEntity.html#/s:30NaturalLanguageUnderstandingV114RelationEntityV4typeSSSgvp":{"name":"type","abstract":"

Entity type.

","parent_name":"RelationEntity"},"Structs/RelationArgument.html#/s:30NaturalLanguageUnderstandingV116RelationArgumentV8entitiesSayAA0E6EntityVGSgvp":{"name":"entities","abstract":"

Undocumented

","parent_name":"RelationArgument"},"Structs/RelationArgument.html#/s:30NaturalLanguageUnderstandingV116RelationArgumentV8locationSaySiGSgvp":{"name":"location","abstract":"

Character offsets indicating the beginning and end of the mention in the analyzed text.

","parent_name":"RelationArgument"},"Structs/RelationArgument.html#/s:30NaturalLanguageUnderstandingV116RelationArgumentV4textSSSgvp":{"name":"text","abstract":"

Text that corresponds to the argument.

","parent_name":"RelationArgument"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV4textSSSgvp":{"name":"text","abstract":"

The plain text to analyze.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV4htmlSSSgvp":{"name":"html","abstract":"

The HTML file to analyze.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV3urlSSSgvp":{"name":"url","abstract":"

The web page to analyze.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV8featuresAA8FeaturesVvp":{"name":"features","abstract":"

Specific features to analyze the document for.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV5cleanSbSgvp":{"name":"clean","abstract":"

Remove website elements, such as links, ads, etc.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV5xpathSSSgvp":{"name":"xpath","abstract":"

XPath query for targeting nodes in HTML.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV13fallbackToRawSbSgvp":{"name":"fallbackToRaw","abstract":"

Whether to use raw HTML content if text cleaning fails.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV18returnAnalyzedTextSbSgvp":{"name":"returnAnalyzedText","abstract":"

Whether or not to return the analyzed text.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV8languageSSSgvp":{"name":"language","abstract":"

ISO 639-1 code indicating the language to use in the analysis.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV19limitTextCharactersSiSgvp":{"name":"limitTextCharacters","abstract":"

Sets the maximum number of characters that are processed by the service.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersVAcA8FeaturesV8features_SSSg4textAG4htmlAG3urlSbSg5cleanAG5xpathAK13fallbackToRawAK18returnAnalyzedTextAG8languageSiSg05limitR10Characterstcfc":{"name":"init(features:text:html:url:clean:xpath:fallbackToRaw:returnAnalyzedText:language:limitTextCharacters:)","abstract":"

Initialize a Parameters with member variables.

","parent_name":"Parameters"},"Structs/Model.html#/s:30NaturalLanguageUnderstandingV15ModelV6statusSSSgvp":{"name":"status","abstract":"

Shows as available if the model is ready for use.

","parent_name":"Model"},"Structs/Model.html#/s:30NaturalLanguageUnderstandingV15ModelV7modelIDSSSgvp":{"name":"modelID","abstract":"

Unique model ID.

","parent_name":"Model"},"Structs/Model.html#/s:30NaturalLanguageUnderstandingV15ModelV8languageSSSgvp":{"name":"language","abstract":"

ISO 639-1 code indicating the language of the model.

","parent_name":"Model"},"Structs/Model.html#/s:30NaturalLanguageUnderstandingV15ModelV11descriptionSSSgvp":{"name":"description","abstract":"

Model description.

","parent_name":"Model"},"Structs/MetadataResult.html#/s:30NaturalLanguageUnderstandingV114MetadataResultV7authorsSayAA6AuthorVGSgvp":{"name":"authors","abstract":"

The authors of the document.

","parent_name":"MetadataResult"},"Structs/MetadataResult.html#/s:30NaturalLanguageUnderstandingV114MetadataResultV15publicationDateSSSgvp":{"name":"publicationDate","abstract":"

The publication date in the format ISO 8601.

","parent_name":"MetadataResult"},"Structs/MetadataResult.html#/s:30NaturalLanguageUnderstandingV114MetadataResultV5titleSSSgvp":{"name":"title","abstract":"

The title of the document.

","parent_name":"MetadataResult"},"Structs/MetadataResult.html#/s:30NaturalLanguageUnderstandingV114MetadataResultV5imageSSSgvp":{"name":"image","abstract":"

URL of a prominent image on the webpage.

","parent_name":"MetadataResult"},"Structs/MetadataResult.html#/s:30NaturalLanguageUnderstandingV114MetadataResultV5feedsSayAA4FeedVGSgvp":{"name":"feeds","abstract":"

RSS/ATOM feeds found on the webpage.

","parent_name":"MetadataResult"},"Structs/MetadataOptions.html#/s:30NaturalLanguageUnderstandingV115MetadataOptionsV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"MetadataOptions"},"Structs/MetadataOptions.html#/s:30NaturalLanguageUnderstandingV115MetadataOptionsVACs10DictionaryVySSAA4JSONOG20additionalProperties_tcfc":{"name":"init(additionalProperties:)","abstract":"

Initialize a MetadataOptions.

","parent_name":"MetadataOptions"},"Structs/MetadataOptions.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"MetadataOptions"},"Structs/ListModelsResults.html#/s:30NaturalLanguageUnderstandingV117ListModelsResultsV6modelsSayAA5ModelVGSgvp":{"name":"models","abstract":"

Undocumented

","parent_name":"ListModelsResults"},"Structs/KeywordsResult.html#/s:30NaturalLanguageUnderstandingV114KeywordsResultV9relevanceSdSgvp":{"name":"relevance","abstract":"

Relevance score from 0 to 1. Higher values indicate greater relevance.

","parent_name":"KeywordsResult"},"Structs/KeywordsResult.html#/s:30NaturalLanguageUnderstandingV114KeywordsResultV4textSSSgvp":{"name":"text","abstract":"

The keyword text.

","parent_name":"KeywordsResult"},"Structs/KeywordsResult.html#/s:30NaturalLanguageUnderstandingV114KeywordsResultV7emotionAA13EmotionScoresVSgvp":{"name":"emotion","abstract":"

Emotion analysis results for the keyword, enabled with the emotion option.

","parent_name":"KeywordsResult"},"Structs/KeywordsResult.html#/s:30NaturalLanguageUnderstandingV114KeywordsResultV9sentimentAA23FeatureSentimentResultsVSgvp":{"name":"sentiment","abstract":"

Sentiment analysis results for the keyword, enabled with the sentiment option.

","parent_name":"KeywordsResult"},"Structs/KeywordsOptions.html#/s:30NaturalLanguageUnderstandingV115KeywordsOptionsV5limitSiSgvp":{"name":"limit","abstract":"

Maximum number of keywords to return.

","parent_name":"KeywordsOptions"},"Structs/KeywordsOptions.html#/s:30NaturalLanguageUnderstandingV115KeywordsOptionsV9sentimentSbSgvp":{"name":"sentiment","abstract":"

Set this to true to return sentiment information for detected keywords.

","parent_name":"KeywordsOptions"},"Structs/KeywordsOptions.html#/s:30NaturalLanguageUnderstandingV115KeywordsOptionsV7emotionSbSgvp":{"name":"emotion","abstract":"

Set this to true to analyze emotion for detected keywords.

","parent_name":"KeywordsOptions"},"Structs/KeywordsOptions.html#/s:30NaturalLanguageUnderstandingV115KeywordsOptionsVACSiSg5limit_SbSg9sentimentAF7emotiontcfc":{"name":"init(limit:sentiment:emotion:)","abstract":"

Initialize a KeywordsOptions with member variables.

","parent_name":"KeywordsOptions"},"Structs/Feed.html#/s:30NaturalLanguageUnderstandingV14FeedV4linkSSSgvp":{"name":"link","abstract":"

URL of the RSS or ATOM feed.

","parent_name":"Feed"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV8conceptsAA15ConceptsOptionsVSgvp":{"name":"concepts","abstract":"

Whether or not to return the concepts that are mentioned in the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV7emotionAA14EmotionOptionsVSgvp":{"name":"emotion","abstract":"

Whether or not to extract the emotions implied in the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV8entitiesAA15EntitiesOptionsVSgvp":{"name":"entities","abstract":"

Whether or not to extract detected entity objects from the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV8keywordsAA15KeywordsOptionsVSgvp":{"name":"keywords","abstract":"

Whether or not to return the keywords in the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV8metadataAA15MetadataOptionsVSgvp":{"name":"metadata","abstract":"

Whether or not the author, publication date, and title of the analyzed text should be returned. This parameter is only available for URL and HTML input.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV9relationsAA16RelationsOptionsVSgvp":{"name":"relations","abstract":"

Whether or not to return the relationships between detected entities in the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV13semanticRolesAA08SemanticG7OptionsVSgvp":{"name":"semanticRoles","abstract":"

Whether or not to return the subject-action-object relations from the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV9sentimentAA16SentimentOptionsVSgvp":{"name":"sentiment","abstract":"

Whether or not to return the overall sentiment of the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV10categoriesAA17CategoriesOptionsVSgvp":{"name":"categories","abstract":"

Whether or not to return the high level category the content is categorized as (i.e. news, art).

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesVAcA15ConceptsOptionsVSg8concepts_AA07EmotionG0VSg7emotionAA08EntitiesG0VSg8entitiesAA08KeywordsG0VSg8keywordsAA08MetadataG0VSg8metadataAA09RelationsG0VSg9relationsAA013SemanticRolesG0VSg08semanticT0AA09SentimentG0VSg9sentimentAA010CategoriesG0VSg10categoriestcfc":{"name":"init(concepts:emotion:entities:keywords:metadata:relations:semanticRoles:sentiment:categories:)","abstract":"

Initialize a Features with member variables.

","parent_name":"Features"},"Structs/FeatureSentimentResults.html#/s:30NaturalLanguageUnderstandingV123FeatureSentimentResultsV5scoreSdSgvp":{"name":"score","abstract":"

Sentiment score from -1 (negative) to 1 (positive).

","parent_name":"FeatureSentimentResults"},"Structs/EntityMention.html#/s:30NaturalLanguageUnderstandingV113EntityMentionV4textSSSgvp":{"name":"text","abstract":"

Entity mention text.

","parent_name":"EntityMention"},"Structs/EntityMention.html#/s:30NaturalLanguageUnderstandingV113EntityMentionV8locationSaySiGSgvp":{"name":"location","abstract":"

Character offsets indicating the beginning and end of the mention in the analyzed text.

","parent_name":"EntityMention"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV4typeSSSgvp":{"name":"type","abstract":"

Entity type.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV4textSSSgvp":{"name":"text","abstract":"

The name of the entity.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV9relevanceSdSgvp":{"name":"relevance","abstract":"

Relevance score from 0 to 1. Higher values indicate greater relevance.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV8mentionsSayAA13EntityMentionVGSgvp":{"name":"mentions","abstract":"

Entity mentions and locations.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV5countSiSgvp":{"name":"count","abstract":"

How many times the entity was mentioned in the text.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV7emotionAA13EmotionScoresVSgvp":{"name":"emotion","abstract":"

Emotion analysis results for the entity, enabled with the emotion option.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV9sentimentAA23FeatureSentimentResultsVSgvp":{"name":"sentiment","abstract":"

Sentiment analysis results for the entity, enabled with the sentiment option.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV14disambiguationAA014DisambiguationF0VSgvp":{"name":"disambiguation","abstract":"

Disambiguation information for the entity.

","parent_name":"EntitiesResult"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsV5limitSiSgvp":{"name":"limit","abstract":"

Maximum number of entities to return.

","parent_name":"EntitiesOptions"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsV8mentionsSbSgvp":{"name":"mentions","abstract":"

Set this to true to return locations of entity mentions.

","parent_name":"EntitiesOptions"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsV5modelSSSgvp":{"name":"model","abstract":"

Enter a custom model ID to override the standard entity detection model.

","parent_name":"EntitiesOptions"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsV9sentimentSbSgvp":{"name":"sentiment","abstract":"

Set this to true to return sentiment information for detected entities.

","parent_name":"EntitiesOptions"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsV7emotionSbSgvp":{"name":"emotion","abstract":"

Set this to true to analyze emotion for detected keywords.

","parent_name":"EntitiesOptions"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsVACSiSg5limit_SbSg8mentionsSSSg5modelAF9sentimentAF7emotiontcfc":{"name":"init(limit:mentions:model:sentiment:emotion:)","abstract":"

Initialize a EntitiesOptions with member variables.

","parent_name":"EntitiesOptions"},"Structs/EmotionScores.html#/s:30NaturalLanguageUnderstandingV113EmotionScoresV5angerSdSgvp":{"name":"anger","abstract":"

Anger score from 0 to 1. A higher score means that the text is more likely to convey anger.

","parent_name":"EmotionScores"},"Structs/EmotionScores.html#/s:30NaturalLanguageUnderstandingV113EmotionScoresV7disgustSdSgvp":{"name":"disgust","abstract":"

Disgust score from 0 to 1. A higher score means that the text is more likely to convey disgust.

","parent_name":"EmotionScores"},"Structs/EmotionScores.html#/s:30NaturalLanguageUnderstandingV113EmotionScoresV4fearSdSgvp":{"name":"fear","abstract":"

Fear score from 0 to 1. A higher score means that the text is more likely to convey fear.

","parent_name":"EmotionScores"},"Structs/EmotionScores.html#/s:30NaturalLanguageUnderstandingV113EmotionScoresV3joySdSgvp":{"name":"joy","abstract":"

Joy score from 0 to 1. A higher score means that the text is more likely to convey joy.

","parent_name":"EmotionScores"},"Structs/EmotionScores.html#/s:30NaturalLanguageUnderstandingV113EmotionScoresV7sadnessSdSgvp":{"name":"sadness","abstract":"

Sadness score from 0 to 1. A higher score means that the text is more likely to convey sadness.

","parent_name":"EmotionScores"},"Structs/EmotionResult.html#/s:30NaturalLanguageUnderstandingV113EmotionResultV8documentAA08DocumentE7ResultsVSgvp":{"name":"document","abstract":"

The returned emotion results across the document.

","parent_name":"EmotionResult"},"Structs/EmotionResult.html#/s:30NaturalLanguageUnderstandingV113EmotionResultV7targetsSayAA08TargetedE7ResultsVGSgvp":{"name":"targets","abstract":"

The returned emotion results per specified target.

","parent_name":"EmotionResult"},"Structs/EmotionOptions.html#/s:30NaturalLanguageUnderstandingV114EmotionOptionsV8documentSbSgvp":{"name":"document","abstract":"

Set this to false to hide document-level emotion results.

","parent_name":"EmotionOptions"},"Structs/EmotionOptions.html#/s:30NaturalLanguageUnderstandingV114EmotionOptionsV7targetsSaySSGSgvp":{"name":"targets","abstract":"

Emotion results will be returned for each target string that is found in the document.

","parent_name":"EmotionOptions"},"Structs/EmotionOptions.html#/s:30NaturalLanguageUnderstandingV114EmotionOptionsVACSbSg8document_SaySSGSg7targetstcfc":{"name":"init(document:targets:)","abstract":"

Initialize a EmotionOptions with member variables.

","parent_name":"EmotionOptions"},"Structs/DocumentSentimentResults.html#/s:30NaturalLanguageUnderstandingV124DocumentSentimentResultsV5labelSSSgvp":{"name":"label","abstract":"

Indicates whether the sentiment is positive, neutral, or negative.

","parent_name":"DocumentSentimentResults"},"Structs/DocumentSentimentResults.html#/s:30NaturalLanguageUnderstandingV124DocumentSentimentResultsV5scoreSdSgvp":{"name":"score","abstract":"

Sentiment score from -1 (negative) to 1 (positive).

","parent_name":"DocumentSentimentResults"},"Structs/DocumentEmotionResults.html#/s:30NaturalLanguageUnderstandingV122DocumentEmotionResultsV7emotionAA0F6ScoresVSgvp":{"name":"emotion","abstract":"

An object containing the emotion results for the document.

","parent_name":"DocumentEmotionResults"},"Structs/DisambiguationResult.html#/s:30NaturalLanguageUnderstandingV120DisambiguationResultV4nameSSSgvp":{"name":"name","abstract":"

Common entity name.

","parent_name":"DisambiguationResult"},"Structs/DisambiguationResult.html#/s:30NaturalLanguageUnderstandingV120DisambiguationResultV15dbpediaResourceSSSgvp":{"name":"dbpediaResource","abstract":"

Link to the corresponding DBpedia resource.

","parent_name":"DisambiguationResult"},"Structs/DisambiguationResult.html#/s:30NaturalLanguageUnderstandingV120DisambiguationResultV7subtypeSaySSGSgvp":{"name":"subtype","abstract":"

Entity subtype information.

","parent_name":"DisambiguationResult"},"Structs/DeleteModelResults.html#/s:30NaturalLanguageUnderstandingV118DeleteModelResultsV7deletedSSSgvp":{"name":"deleted","abstract":"

model_id of the deleted model.

","parent_name":"DeleteModelResults"},"Structs/ConceptsResult.html#/s:30NaturalLanguageUnderstandingV114ConceptsResultV4textSSSgvp":{"name":"text","abstract":"

Name of the concept.

","parent_name":"ConceptsResult"},"Structs/ConceptsResult.html#/s:30NaturalLanguageUnderstandingV114ConceptsResultV9relevanceSdSgvp":{"name":"relevance","abstract":"

Relevance score between 0 and 1. Higher scores indicate greater relevance.

","parent_name":"ConceptsResult"},"Structs/ConceptsResult.html#/s:30NaturalLanguageUnderstandingV114ConceptsResultV15dbpediaResourceSSSgvp":{"name":"dbpediaResource","abstract":"

Link to the corresponding DBpedia resource.

","parent_name":"ConceptsResult"},"Structs/ConceptsOptions.html#/s:30NaturalLanguageUnderstandingV115ConceptsOptionsV5limitSiSgvp":{"name":"limit","abstract":"

Maximum number of concepts to return.

","parent_name":"ConceptsOptions"},"Structs/ConceptsOptions.html#/s:30NaturalLanguageUnderstandingV115ConceptsOptionsVACSiSg5limit_tcfc":{"name":"init(limit:)","abstract":"

Initialize a ConceptsOptions with member variables.

","parent_name":"ConceptsOptions"},"Structs/CategoriesResult.html#/s:30NaturalLanguageUnderstandingV116CategoriesResultV5labelSSSgvp":{"name":"label","abstract":"

The path to the category through the taxonomy hierarchy.

","parent_name":"CategoriesResult"},"Structs/CategoriesResult.html#/s:30NaturalLanguageUnderstandingV116CategoriesResultV5scoreSdSgvp":{"name":"score","abstract":"

Confidence score for the category classification. Higher values indicate greater confidence.

","parent_name":"CategoriesResult"},"Structs/CategoriesOptions.html#/s:30NaturalLanguageUnderstandingV117CategoriesOptionsV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"CategoriesOptions"},"Structs/CategoriesOptions.html#/s:30NaturalLanguageUnderstandingV117CategoriesOptionsVACs10DictionaryVySSAA4JSONOG20additionalProperties_tcfc":{"name":"init(additionalProperties:)","abstract":"

Initialize a CategoriesOptions.

","parent_name":"CategoriesOptions"},"Structs/CategoriesOptions.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"CategoriesOptions"},"Structs/Author.html#/s:30NaturalLanguageUnderstandingV16AuthorV4nameSSSgvp":{"name":"name","abstract":"

Name of the author.

","parent_name":"Author"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV8languageSSSgvp":{"name":"language","abstract":"

Language used to analyze the text.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV12analyzedTextSSSgvp":{"name":"analyzedText","abstract":"

Text that was used in the analysis.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV12retrievedUrlSSSgvp":{"name":"retrievedUrl","abstract":"

URL that was used to retrieve HTML content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV5usageAA5UsageVSgvp":{"name":"usage","abstract":"

API usage information for the request.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV8conceptsSayAA14ConceptsResultVGSgvp":{"name":"concepts","abstract":"

The general concepts referenced or alluded to in the specified content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV8entitiesSayAA14EntitiesResultVGSgvp":{"name":"entities","abstract":"

The important entities in the specified content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV8keywordsSayAA14KeywordsResultVGSgvp":{"name":"keywords","abstract":"

The important keywords in content organized by relevance.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV10categoriesSayAA16CategoriesResultVGSgvp":{"name":"categories","abstract":"

The hierarchical 5-level taxonomy the content is categorized into.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV7emotionAA13EmotionResultVSgvp":{"name":"emotion","abstract":"

The anger, disgust, fear, joy, or sadness conveyed by the content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV8metadataAA14MetadataResultVSgvp":{"name":"metadata","abstract":"

The metadata holds author information, publication date and the title of the text/HTML content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV9relationsSayAA15RelationsResultVGSgvp":{"name":"relations","abstract":"

The relationships between entities in the content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV13semanticRolesSayAA08SemanticH6ResultVGSgvp":{"name":"semanticRoles","abstract":"

The subjects of actions and the objects the actions act upon.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV9sentimentAA15SentimentResultVSgvp":{"name":"sentiment","abstract":"

The sentiment of the content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html":{"name":"AnalysisResults","abstract":"

Results of the analysis, organized by feature.

"},"Structs/Author.html":{"name":"Author","abstract":"

The author of the analyzed content.

"},"Structs/CategoriesOptions.html":{"name":"CategoriesOptions","abstract":"

The hierarchical 5-level taxonomy the content is categorized into.

"},"Structs/CategoriesResult.html":{"name":"CategoriesResult","abstract":"

The hierarchical 5-level taxonomy the content is categorized into.

"},"Structs/ConceptsOptions.html":{"name":"ConceptsOptions","abstract":"

Whether or not to analyze content for general concepts that are referenced or alluded to.

"},"Structs/ConceptsResult.html":{"name":"ConceptsResult","abstract":"

The general concepts referenced or alluded to in the specified content.

"},"Structs/DeleteModelResults.html":{"name":"DeleteModelResults","abstract":"

Information about the deleted model.

"},"Structs/DisambiguationResult.html":{"name":"DisambiguationResult","abstract":"

Disambiguation information for the entity.

"},"Structs/DocumentEmotionResults.html":{"name":"DocumentEmotionResults","abstract":"

An object containing the emotion results of a document.

"},"Structs/DocumentSentimentResults.html":{"name":"DocumentSentimentResults","abstract":"

DocumentSentimentResults.

"},"Structs/EmotionOptions.html":{"name":"EmotionOptions","abstract":"

Whether or not to return emotion analysis of the content.

"},"Structs/EmotionResult.html":{"name":"EmotionResult","abstract":"

The detected anger, disgust, fear, joy, or sadness that is conveyed by the content. Emotion information can be returned for detected entities, keywords, or user-specified target phrases found in the text.

"},"Structs/EmotionScores.html":{"name":"EmotionScores","abstract":"

EmotionScores.

"},"Structs/EntitiesOptions.html":{"name":"EntitiesOptions","abstract":"

Whether or not to return important people, places, geopolitical, and other entities detected in the analyzed content.

"},"Structs/EntitiesResult.html":{"name":"EntitiesResult","abstract":"

The important people, places, geopolitical entities and other types of entities in your content.

"},"Structs/EntityMention.html":{"name":"EntityMention","abstract":"

EntityMention.

"},"Structs/FeatureSentimentResults.html":{"name":"FeatureSentimentResults","abstract":"

FeatureSentimentResults.

"},"Structs/Features.html":{"name":"Features","abstract":"

Analysis features and options.

"},"Structs/Feed.html":{"name":"Feed","abstract":"

RSS or ATOM feed found on the webpage.

"},"Structs/KeywordsOptions.html":{"name":"KeywordsOptions","abstract":"

An option indicating whether or not important keywords from the analyzed content should be returned.

"},"Structs/KeywordsResult.html":{"name":"KeywordsResult","abstract":"

The most important keywords in the content, organized by relevance.

"},"Structs/ListModelsResults.html":{"name":"ListModelsResults","abstract":"

Models available for Relations and Entities features.

"},"Structs/MetadataOptions.html":{"name":"MetadataOptions","abstract":"

The Authors, Publication Date, and Title of the document. Supports URL and HTML input types.

"},"Structs/MetadataResult.html":{"name":"MetadataResult","abstract":"

The Authors, Publication Date, and Title of the document. Supports URL and HTML input types.

"},"Structs/Model.html":{"name":"Model","abstract":"

Model.

"},"Structs/Parameters.html":{"name":"Parameters","abstract":"

An object containing request parameters.

"},"Structs/RelationArgument.html":{"name":"RelationArgument","abstract":"

RelationArgument.

"},"Structs/RelationEntity.html":{"name":"RelationEntity","abstract":"

An entity that corresponds with an argument in a relation.

"},"Structs/RelationsOptions.html":{"name":"RelationsOptions","abstract":"

An option specifying if the relationships found between entities in the analyzed content should be returned.

"},"Structs/RelationsResult.html":{"name":"RelationsResult","abstract":"

The relations between entities found in the content.

"},"Structs/SemanticRolesAction.html":{"name":"SemanticRolesAction","abstract":"

SemanticRolesAction.

"},"Structs/SemanticRolesEntity.html":{"name":"SemanticRolesEntity","abstract":"

SemanticRolesEntity.

"},"Structs/SemanticRolesKeyword.html":{"name":"SemanticRolesKeyword","abstract":"

SemanticRolesKeyword.

"},"Structs/SemanticRolesObject.html":{"name":"SemanticRolesObject","abstract":"

SemanticRolesObject.

"},"Structs/SemanticRolesOptions.html":{"name":"SemanticRolesOptions","abstract":"

An option specifying whether or not to identify the subjects, actions, and verbs in the analyzed content.

"},"Structs/SemanticRolesResult.html":{"name":"SemanticRolesResult","abstract":"

The object containing the actions and the objects the actions act upon.

"},"Structs/SemanticRolesSubject.html":{"name":"SemanticRolesSubject","abstract":"

SemanticRolesSubject.

"},"Structs/SemanticRolesVerb.html":{"name":"SemanticRolesVerb","abstract":"

SemanticRolesVerb.

"},"Structs/SentimentOptions.html":{"name":"SentimentOptions","abstract":"

An option specifying if sentiment of detected entities, keywords, or phrases should be returned.

"},"Structs/SentimentResult.html":{"name":"SentimentResult","abstract":"

The sentiment of the content.

"},"Structs/TargetedEmotionResults.html":{"name":"TargetedEmotionResults","abstract":"

An object containing the emotion results for the target.

"},"Structs/TargetedSentimentResults.html":{"name":"TargetedSentimentResults","abstract":"

TargetedSentimentResults.

"},"Structs/Usage.html":{"name":"Usage","abstract":"

Usage information.

"},"Structs.html#/s:30NaturalLanguageUnderstandingV111JSONWrapperV":{"name":"JSONWrapper","abstract":"

Used internally to serialize and deserialize JSON."},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO013serializationF0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO08encodingF0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO011fileManagerF0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

Create a NaturalLanguageUnderstanding object.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a NaturalLanguageUnderstanding object.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a NaturalLanguageUnderstanding object.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C7analyzeyAA10ParametersV10parameters_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA15AnalysisResultsVc7successtF":{"name":"analyze(parameters:headers:failure:success:)","abstract":"

Analyze text, HTML, or a public webpage.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C10listModelsys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA04ListF7ResultsVc7successtF":{"name":"listModels(headers:failure:success:)","abstract":"

List models.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C11deleteModelySS7modelID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteF7ResultsVc7successtF":{"name":"deleteModel(modelID:headers:failure:success:)","abstract":"

Delete model.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html":{"name":"NaturalLanguageUnderstanding","abstract":"

Analyze various features of text content at scale. Provide text, raw HTML, or a public URL, and IBM Watson Natural"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file +{"Structs/Usage.html#/s:30NaturalLanguageUnderstandingV15UsageV8featuresSiSgvp":{"name":"features","abstract":"

Number of features used in the API call.

","parent_name":"Usage"},"Structs/Usage.html#/s:30NaturalLanguageUnderstandingV15UsageV14textCharactersSiSgvp":{"name":"textCharacters","abstract":"

Number of text characters processed.

","parent_name":"Usage"},"Structs/Usage.html#/s:30NaturalLanguageUnderstandingV15UsageV9textUnitsSiSgvp":{"name":"textUnits","abstract":"

Number of 10,000-character units processed.

","parent_name":"Usage"},"Structs/TargetedSentimentResults.html#/s:30NaturalLanguageUnderstandingV124TargetedSentimentResultsV4textSSSgvp":{"name":"text","abstract":"

Targeted text.

","parent_name":"TargetedSentimentResults"},"Structs/TargetedSentimentResults.html#/s:30NaturalLanguageUnderstandingV124TargetedSentimentResultsV5scoreSdSgvp":{"name":"score","abstract":"

Sentiment score from -1 (negative) to 1 (positive).

","parent_name":"TargetedSentimentResults"},"Structs/TargetedEmotionResults.html#/s:30NaturalLanguageUnderstandingV122TargetedEmotionResultsV4textSSSgvp":{"name":"text","abstract":"

Targeted text.

","parent_name":"TargetedEmotionResults"},"Structs/TargetedEmotionResults.html#/s:30NaturalLanguageUnderstandingV122TargetedEmotionResultsV7emotionAA0F6ScoresVSgvp":{"name":"emotion","abstract":"

An object containing the emotion results for the target.

","parent_name":"TargetedEmotionResults"},"Structs/SentimentResult.html#/s:30NaturalLanguageUnderstandingV115SentimentResultV8documentAA08DocumentE7ResultsVSgvp":{"name":"document","abstract":"

The document level sentiment.

","parent_name":"SentimentResult"},"Structs/SentimentResult.html#/s:30NaturalLanguageUnderstandingV115SentimentResultV7targetsSayAA08TargetedE7ResultsVGSgvp":{"name":"targets","abstract":"

The targeted sentiment to analyze.

","parent_name":"SentimentResult"},"Structs/SentimentOptions.html#/s:30NaturalLanguageUnderstandingV116SentimentOptionsV8documentSbSgvp":{"name":"document","abstract":"

Set this to false to hide document-level sentiment results.

","parent_name":"SentimentOptions"},"Structs/SentimentOptions.html#/s:30NaturalLanguageUnderstandingV116SentimentOptionsV7targetsSaySSGSgvp":{"name":"targets","abstract":"

Sentiment results will be returned for each target string that is found in the document.

","parent_name":"SentimentOptions"},"Structs/SentimentOptions.html#/s:30NaturalLanguageUnderstandingV116SentimentOptionsVACSbSg8document_SaySSGSg7targetstcfc":{"name":"init(document:targets:)","abstract":"

Initialize a SentimentOptions with member variables.

","parent_name":"SentimentOptions"},"Structs/SemanticRolesVerb.html#/s:30NaturalLanguageUnderstandingV117SemanticRolesVerbV4textSSSgvp":{"name":"text","abstract":"

The keyword text.

","parent_name":"SemanticRolesVerb"},"Structs/SemanticRolesVerb.html#/s:30NaturalLanguageUnderstandingV117SemanticRolesVerbV5tenseSSSgvp":{"name":"tense","abstract":"

Verb tense.

","parent_name":"SemanticRolesVerb"},"Structs/SemanticRolesSubject.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesSubjectV4textSSSgvp":{"name":"text","abstract":"

Text that corresponds to the subject role.

","parent_name":"SemanticRolesSubject"},"Structs/SemanticRolesSubject.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesSubjectV8entitiesSayAA0eF6EntityVGSgvp":{"name":"entities","abstract":"

Undocumented

","parent_name":"SemanticRolesSubject"},"Structs/SemanticRolesSubject.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesSubjectV8keywordsSayAA0eF7KeywordVGSgvp":{"name":"keywords","abstract":"

Undocumented

","parent_name":"SemanticRolesSubject"},"Structs/SemanticRolesResult.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesResultV8sentenceSSSgvp":{"name":"sentence","abstract":"

Sentence from the source that contains the subject, action, and object.

","parent_name":"SemanticRolesResult"},"Structs/SemanticRolesResult.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesResultV7subjectAA0eF7SubjectVSgvp":{"name":"subject","abstract":"

The extracted subject from the sentence.

","parent_name":"SemanticRolesResult"},"Structs/SemanticRolesResult.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesResultV6actionAA0eF6ActionVSgvp":{"name":"action","abstract":"

The extracted action from the sentence.

","parent_name":"SemanticRolesResult"},"Structs/SemanticRolesResult.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesResultV6objectAA0eF6ObjectVSgvp":{"name":"object","abstract":"

The extracted object from the sentence.

","parent_name":"SemanticRolesResult"},"Structs/SemanticRolesOptions.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesOptionsV5limitSiSgvp":{"name":"limit","abstract":"

Maximum number of semantic_roles results to return.

","parent_name":"SemanticRolesOptions"},"Structs/SemanticRolesOptions.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesOptionsV8keywordsSbSgvp":{"name":"keywords","abstract":"

Set this to true to return keyword information for subjects and objects.

","parent_name":"SemanticRolesOptions"},"Structs/SemanticRolesOptions.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesOptionsV8entitiesSbSgvp":{"name":"entities","abstract":"

Set this to true to return entity information for subjects and objects.

","parent_name":"SemanticRolesOptions"},"Structs/SemanticRolesOptions.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesOptionsVACSiSg5limit_SbSg8keywordsAF8entitiestcfc":{"name":"init(limit:keywords:entities:)","abstract":"

Initialize a SemanticRolesOptions with member variables.

","parent_name":"SemanticRolesOptions"},"Structs/SemanticRolesObject.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesObjectV4textSSSgvp":{"name":"text","abstract":"

Object text.

","parent_name":"SemanticRolesObject"},"Structs/SemanticRolesObject.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesObjectV8keywordsSayAA0eF7KeywordVGSgvp":{"name":"keywords","abstract":"

Undocumented

","parent_name":"SemanticRolesObject"},"Structs/SemanticRolesKeyword.html#/s:30NaturalLanguageUnderstandingV120SemanticRolesKeywordV4textSSSgvp":{"name":"text","abstract":"

The keyword text.

","parent_name":"SemanticRolesKeyword"},"Structs/SemanticRolesEntity.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesEntityV4typeSSSgvp":{"name":"type","abstract":"

Entity type.

","parent_name":"SemanticRolesEntity"},"Structs/SemanticRolesEntity.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesEntityV4textSSSgvp":{"name":"text","abstract":"

The entity text.

","parent_name":"SemanticRolesEntity"},"Structs/SemanticRolesAction.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesActionV4textSSSgvp":{"name":"text","abstract":"

Analyzed text that corresponds to the action.

","parent_name":"SemanticRolesAction"},"Structs/SemanticRolesAction.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesActionV10normalizedSSSgvp":{"name":"normalized","abstract":"

normalized version of the action.

","parent_name":"SemanticRolesAction"},"Structs/SemanticRolesAction.html#/s:30NaturalLanguageUnderstandingV119SemanticRolesActionV4verbAA0eF4VerbVSgvp":{"name":"verb","abstract":"

Undocumented

","parent_name":"SemanticRolesAction"},"Structs/RelationsResult.html#/s:30NaturalLanguageUnderstandingV115RelationsResultV5scoreSdSgvp":{"name":"score","abstract":"

Confidence score for the relation. Higher values indicate greater confidence.

","parent_name":"RelationsResult"},"Structs/RelationsResult.html#/s:30NaturalLanguageUnderstandingV115RelationsResultV8sentenceSSSgvp":{"name":"sentence","abstract":"

The sentence that contains the relation.

","parent_name":"RelationsResult"},"Structs/RelationsResult.html#/s:30NaturalLanguageUnderstandingV115RelationsResultV4typeSSSgvp":{"name":"type","abstract":"

The type of the relation.

","parent_name":"RelationsResult"},"Structs/RelationsResult.html#/s:30NaturalLanguageUnderstandingV115RelationsResultV9argumentsSayAA16RelationArgumentVGSgvp":{"name":"arguments","abstract":"

The extracted relation objects from the text.

","parent_name":"RelationsResult"},"Structs/RelationsOptions.html#/s:30NaturalLanguageUnderstandingV116RelationsOptionsV5modelSSSgvp":{"name":"model","abstract":"

Enter a custom model ID to override the default model.

","parent_name":"RelationsOptions"},"Structs/RelationsOptions.html#/s:30NaturalLanguageUnderstandingV116RelationsOptionsVACSSSg5model_tcfc":{"name":"init(model:)","abstract":"

Initialize a RelationsOptions with member variables.

","parent_name":"RelationsOptions"},"Structs/RelationEntity.html#/s:30NaturalLanguageUnderstandingV114RelationEntityV4textSSSgvp":{"name":"text","abstract":"

Text that corresponds to the entity.

","parent_name":"RelationEntity"},"Structs/RelationEntity.html#/s:30NaturalLanguageUnderstandingV114RelationEntityV4typeSSSgvp":{"name":"type","abstract":"

Entity type.

","parent_name":"RelationEntity"},"Structs/RelationArgument.html#/s:30NaturalLanguageUnderstandingV116RelationArgumentV8entitiesSayAA0E6EntityVGSgvp":{"name":"entities","abstract":"

Undocumented

","parent_name":"RelationArgument"},"Structs/RelationArgument.html#/s:30NaturalLanguageUnderstandingV116RelationArgumentV8locationSaySiGSgvp":{"name":"location","abstract":"

Character offsets indicating the beginning and end of the mention in the analyzed text.

","parent_name":"RelationArgument"},"Structs/RelationArgument.html#/s:30NaturalLanguageUnderstandingV116RelationArgumentV4textSSSgvp":{"name":"text","abstract":"

Text that corresponds to the argument.

","parent_name":"RelationArgument"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV4textSSSgvp":{"name":"text","abstract":"

The plain text to analyze.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV4htmlSSSgvp":{"name":"html","abstract":"

The HTML file to analyze.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV3urlSSSgvp":{"name":"url","abstract":"

The web page to analyze.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV8featuresAA8FeaturesVvp":{"name":"features","abstract":"

Specific features to analyze the document for.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV5cleanSbSgvp":{"name":"clean","abstract":"

Remove website elements, such as links, ads, etc.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV5xpathSSSgvp":{"name":"xpath","abstract":"

XPath query for targeting nodes in HTML.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV13fallbackToRawSbSgvp":{"name":"fallbackToRaw","abstract":"

Whether to use raw HTML content if text cleaning fails.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV18returnAnalyzedTextSbSgvp":{"name":"returnAnalyzedText","abstract":"

Whether or not to return the analyzed text.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV8languageSSSgvp":{"name":"language","abstract":"

ISO 639-1 code indicating the language to use in the analysis.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersV19limitTextCharactersSiSgvp":{"name":"limitTextCharacters","abstract":"

Sets the maximum number of characters that are processed by the service.

","parent_name":"Parameters"},"Structs/Parameters.html#/s:30NaturalLanguageUnderstandingV110ParametersVAcA8FeaturesV8features_SSSg4textAG4htmlAG3urlSbSg5cleanAG5xpathAK13fallbackToRawAK18returnAnalyzedTextAG8languageSiSg05limitR10Characterstcfc":{"name":"init(features:text:html:url:clean:xpath:fallbackToRaw:returnAnalyzedText:language:limitTextCharacters:)","abstract":"

Initialize a Parameters with member variables.

","parent_name":"Parameters"},"Structs/Model.html#/s:30NaturalLanguageUnderstandingV15ModelV6statusSSSgvp":{"name":"status","abstract":"

Shows as available if the model is ready for use.

","parent_name":"Model"},"Structs/Model.html#/s:30NaturalLanguageUnderstandingV15ModelV7modelIDSSSgvp":{"name":"modelID","abstract":"

Unique model ID.

","parent_name":"Model"},"Structs/Model.html#/s:30NaturalLanguageUnderstandingV15ModelV8languageSSSgvp":{"name":"language","abstract":"

ISO 639-1 code indicating the language of the model.

","parent_name":"Model"},"Structs/Model.html#/s:30NaturalLanguageUnderstandingV15ModelV11descriptionSSSgvp":{"name":"description","abstract":"

Model description.

","parent_name":"Model"},"Structs/MetadataResult.html#/s:30NaturalLanguageUnderstandingV114MetadataResultV7authorsSayAA6AuthorVGSgvp":{"name":"authors","abstract":"

The authors of the document.

","parent_name":"MetadataResult"},"Structs/MetadataResult.html#/s:30NaturalLanguageUnderstandingV114MetadataResultV15publicationDateSSSgvp":{"name":"publicationDate","abstract":"

The publication date in the format ISO 8601.

","parent_name":"MetadataResult"},"Structs/MetadataResult.html#/s:30NaturalLanguageUnderstandingV114MetadataResultV5titleSSSgvp":{"name":"title","abstract":"

The title of the document.

","parent_name":"MetadataResult"},"Structs/MetadataResult.html#/s:30NaturalLanguageUnderstandingV114MetadataResultV5imageSSSgvp":{"name":"image","abstract":"

URL of a prominent image on the webpage.

","parent_name":"MetadataResult"},"Structs/MetadataResult.html#/s:30NaturalLanguageUnderstandingV114MetadataResultV5feedsSayAA4FeedVGSgvp":{"name":"feeds","abstract":"

RSS/ATOM feeds found on the webpage.

","parent_name":"MetadataResult"},"Structs/MetadataOptions.html#/s:30NaturalLanguageUnderstandingV115MetadataOptionsV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"MetadataOptions"},"Structs/MetadataOptions.html#/s:30NaturalLanguageUnderstandingV115MetadataOptionsVACs10DictionaryVySSAA4JSONOG20additionalProperties_tcfc":{"name":"init(additionalProperties:)","abstract":"

Initialize a MetadataOptions.

","parent_name":"MetadataOptions"},"Structs/MetadataOptions.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"MetadataOptions"},"Structs/ListModelsResults.html#/s:30NaturalLanguageUnderstandingV117ListModelsResultsV6modelsSayAA5ModelVGSgvp":{"name":"models","abstract":"

Undocumented

","parent_name":"ListModelsResults"},"Structs/KeywordsResult.html#/s:30NaturalLanguageUnderstandingV114KeywordsResultV9relevanceSdSgvp":{"name":"relevance","abstract":"

Relevance score from 0 to 1. Higher values indicate greater relevance.

","parent_name":"KeywordsResult"},"Structs/KeywordsResult.html#/s:30NaturalLanguageUnderstandingV114KeywordsResultV4textSSSgvp":{"name":"text","abstract":"

The keyword text.

","parent_name":"KeywordsResult"},"Structs/KeywordsResult.html#/s:30NaturalLanguageUnderstandingV114KeywordsResultV7emotionAA13EmotionScoresVSgvp":{"name":"emotion","abstract":"

Emotion analysis results for the keyword, enabled with the emotion option.

","parent_name":"KeywordsResult"},"Structs/KeywordsResult.html#/s:30NaturalLanguageUnderstandingV114KeywordsResultV9sentimentAA23FeatureSentimentResultsVSgvp":{"name":"sentiment","abstract":"

Sentiment analysis results for the keyword, enabled with the sentiment option.

","parent_name":"KeywordsResult"},"Structs/KeywordsOptions.html#/s:30NaturalLanguageUnderstandingV115KeywordsOptionsV5limitSiSgvp":{"name":"limit","abstract":"

Maximum number of keywords to return.

","parent_name":"KeywordsOptions"},"Structs/KeywordsOptions.html#/s:30NaturalLanguageUnderstandingV115KeywordsOptionsV9sentimentSbSgvp":{"name":"sentiment","abstract":"

Set this to true to return sentiment information for detected keywords.

","parent_name":"KeywordsOptions"},"Structs/KeywordsOptions.html#/s:30NaturalLanguageUnderstandingV115KeywordsOptionsV7emotionSbSgvp":{"name":"emotion","abstract":"

Set this to true to analyze emotion for detected keywords.

","parent_name":"KeywordsOptions"},"Structs/KeywordsOptions.html#/s:30NaturalLanguageUnderstandingV115KeywordsOptionsVACSiSg5limit_SbSg9sentimentAF7emotiontcfc":{"name":"init(limit:sentiment:emotion:)","abstract":"

Initialize a KeywordsOptions with member variables.

","parent_name":"KeywordsOptions"},"Structs/Feed.html#/s:30NaturalLanguageUnderstandingV14FeedV4linkSSSgvp":{"name":"link","abstract":"

URL of the RSS or ATOM feed.

","parent_name":"Feed"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV8conceptsAA15ConceptsOptionsVSgvp":{"name":"concepts","abstract":"

Whether or not to return the concepts that are mentioned in the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV7emotionAA14EmotionOptionsVSgvp":{"name":"emotion","abstract":"

Whether or not to extract the emotions implied in the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV8entitiesAA15EntitiesOptionsVSgvp":{"name":"entities","abstract":"

Whether or not to extract detected entity objects from the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV8keywordsAA15KeywordsOptionsVSgvp":{"name":"keywords","abstract":"

Whether or not to return the keywords in the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV8metadataAA15MetadataOptionsVSgvp":{"name":"metadata","abstract":"

Whether or not the author, publication date, and title of the analyzed text should be returned. This parameter is","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV9relationsAA16RelationsOptionsVSgvp":{"name":"relations","abstract":"

Whether or not to return the relationships between detected entities in the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV13semanticRolesAA08SemanticG7OptionsVSgvp":{"name":"semanticRoles","abstract":"

Whether or not to return the subject-action-object relations from the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV9sentimentAA16SentimentOptionsVSgvp":{"name":"sentiment","abstract":"

Whether or not to return the overall sentiment of the analyzed text.

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesV10categoriesAA17CategoriesOptionsVSgvp":{"name":"categories","abstract":"

Whether or not to return the high level category the content is categorized as (i.e. news, art).

","parent_name":"Features"},"Structs/Features.html#/s:30NaturalLanguageUnderstandingV18FeaturesVAcA15ConceptsOptionsVSg8concepts_AA07EmotionG0VSg7emotionAA08EntitiesG0VSg8entitiesAA08KeywordsG0VSg8keywordsAA08MetadataG0VSg8metadataAA09RelationsG0VSg9relationsAA013SemanticRolesG0VSg08semanticT0AA09SentimentG0VSg9sentimentAA010CategoriesG0VSg10categoriestcfc":{"name":"init(concepts:emotion:entities:keywords:metadata:relations:semanticRoles:sentiment:categories:)","abstract":"

Initialize a Features with member variables.

","parent_name":"Features"},"Structs/FeatureSentimentResults.html#/s:30NaturalLanguageUnderstandingV123FeatureSentimentResultsV5scoreSdSgvp":{"name":"score","abstract":"

Sentiment score from -1 (negative) to 1 (positive).

","parent_name":"FeatureSentimentResults"},"Structs/EntityMention.html#/s:30NaturalLanguageUnderstandingV113EntityMentionV4textSSSgvp":{"name":"text","abstract":"

Entity mention text.

","parent_name":"EntityMention"},"Structs/EntityMention.html#/s:30NaturalLanguageUnderstandingV113EntityMentionV8locationSaySiGSgvp":{"name":"location","abstract":"

Character offsets indicating the beginning and end of the mention in the analyzed text.

","parent_name":"EntityMention"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV4typeSSSgvp":{"name":"type","abstract":"

Entity type.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV4textSSSgvp":{"name":"text","abstract":"

The name of the entity.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV9relevanceSdSgvp":{"name":"relevance","abstract":"

Relevance score from 0 to 1. Higher values indicate greater relevance.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV8mentionsSayAA13EntityMentionVGSgvp":{"name":"mentions","abstract":"

Entity mentions and locations.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV5countSiSgvp":{"name":"count","abstract":"

How many times the entity was mentioned in the text.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV7emotionAA13EmotionScoresVSgvp":{"name":"emotion","abstract":"

Emotion analysis results for the entity, enabled with the emotion option.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV9sentimentAA23FeatureSentimentResultsVSgvp":{"name":"sentiment","abstract":"

Sentiment analysis results for the entity, enabled with the sentiment option.

","parent_name":"EntitiesResult"},"Structs/EntitiesResult.html#/s:30NaturalLanguageUnderstandingV114EntitiesResultV14disambiguationAA014DisambiguationF0VSgvp":{"name":"disambiguation","abstract":"

Disambiguation information for the entity.

","parent_name":"EntitiesResult"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsV5limitSiSgvp":{"name":"limit","abstract":"

Maximum number of entities to return.

","parent_name":"EntitiesOptions"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsV8mentionsSbSgvp":{"name":"mentions","abstract":"

Set this to true to return locations of entity mentions.

","parent_name":"EntitiesOptions"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsV5modelSSSgvp":{"name":"model","abstract":"

Enter a custom model ID to override the standard entity detection model.

","parent_name":"EntitiesOptions"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsV9sentimentSbSgvp":{"name":"sentiment","abstract":"

Set this to true to return sentiment information for detected entities.

","parent_name":"EntitiesOptions"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsV7emotionSbSgvp":{"name":"emotion","abstract":"

Set this to true to analyze emotion for detected keywords.

","parent_name":"EntitiesOptions"},"Structs/EntitiesOptions.html#/s:30NaturalLanguageUnderstandingV115EntitiesOptionsVACSiSg5limit_SbSg8mentionsSSSg5modelAF9sentimentAF7emotiontcfc":{"name":"init(limit:mentions:model:sentiment:emotion:)","abstract":"

Initialize a EntitiesOptions with member variables.

","parent_name":"EntitiesOptions"},"Structs/EmotionScores.html#/s:30NaturalLanguageUnderstandingV113EmotionScoresV5angerSdSgvp":{"name":"anger","abstract":"

Anger score from 0 to 1. A higher score means that the text is more likely to convey anger.

","parent_name":"EmotionScores"},"Structs/EmotionScores.html#/s:30NaturalLanguageUnderstandingV113EmotionScoresV7disgustSdSgvp":{"name":"disgust","abstract":"

Disgust score from 0 to 1. A higher score means that the text is more likely to convey disgust.

","parent_name":"EmotionScores"},"Structs/EmotionScores.html#/s:30NaturalLanguageUnderstandingV113EmotionScoresV4fearSdSgvp":{"name":"fear","abstract":"

Fear score from 0 to 1. A higher score means that the text is more likely to convey fear.

","parent_name":"EmotionScores"},"Structs/EmotionScores.html#/s:30NaturalLanguageUnderstandingV113EmotionScoresV3joySdSgvp":{"name":"joy","abstract":"

Joy score from 0 to 1. A higher score means that the text is more likely to convey joy.

","parent_name":"EmotionScores"},"Structs/EmotionScores.html#/s:30NaturalLanguageUnderstandingV113EmotionScoresV7sadnessSdSgvp":{"name":"sadness","abstract":"

Sadness score from 0 to 1. A higher score means that the text is more likely to convey sadness.

","parent_name":"EmotionScores"},"Structs/EmotionResult.html#/s:30NaturalLanguageUnderstandingV113EmotionResultV8documentAA08DocumentE7ResultsVSgvp":{"name":"document","abstract":"

The returned emotion results across the document.

","parent_name":"EmotionResult"},"Structs/EmotionResult.html#/s:30NaturalLanguageUnderstandingV113EmotionResultV7targetsSayAA08TargetedE7ResultsVGSgvp":{"name":"targets","abstract":"

The returned emotion results per specified target.

","parent_name":"EmotionResult"},"Structs/EmotionOptions.html#/s:30NaturalLanguageUnderstandingV114EmotionOptionsV8documentSbSgvp":{"name":"document","abstract":"

Set this to false to hide document-level emotion results.

","parent_name":"EmotionOptions"},"Structs/EmotionOptions.html#/s:30NaturalLanguageUnderstandingV114EmotionOptionsV7targetsSaySSGSgvp":{"name":"targets","abstract":"

Emotion results will be returned for each target string that is found in the document.

","parent_name":"EmotionOptions"},"Structs/EmotionOptions.html#/s:30NaturalLanguageUnderstandingV114EmotionOptionsVACSbSg8document_SaySSGSg7targetstcfc":{"name":"init(document:targets:)","abstract":"

Initialize a EmotionOptions with member variables.

","parent_name":"EmotionOptions"},"Structs/DocumentSentimentResults.html#/s:30NaturalLanguageUnderstandingV124DocumentSentimentResultsV5labelSSSgvp":{"name":"label","abstract":"

Indicates whether the sentiment is positive, neutral, or negative.

","parent_name":"DocumentSentimentResults"},"Structs/DocumentSentimentResults.html#/s:30NaturalLanguageUnderstandingV124DocumentSentimentResultsV5scoreSdSgvp":{"name":"score","abstract":"

Sentiment score from -1 (negative) to 1 (positive).

","parent_name":"DocumentSentimentResults"},"Structs/DocumentEmotionResults.html#/s:30NaturalLanguageUnderstandingV122DocumentEmotionResultsV7emotionAA0F6ScoresVSgvp":{"name":"emotion","abstract":"

An object containing the emotion results for the document.

","parent_name":"DocumentEmotionResults"},"Structs/DisambiguationResult.html#/s:30NaturalLanguageUnderstandingV120DisambiguationResultV4nameSSSgvp":{"name":"name","abstract":"

Common entity name.

","parent_name":"DisambiguationResult"},"Structs/DisambiguationResult.html#/s:30NaturalLanguageUnderstandingV120DisambiguationResultV15dbpediaResourceSSSgvp":{"name":"dbpediaResource","abstract":"

Link to the corresponding DBpedia resource.

","parent_name":"DisambiguationResult"},"Structs/DisambiguationResult.html#/s:30NaturalLanguageUnderstandingV120DisambiguationResultV7subtypeSaySSGSgvp":{"name":"subtype","abstract":"

Entity subtype information.

","parent_name":"DisambiguationResult"},"Structs/DeleteModelResults.html#/s:30NaturalLanguageUnderstandingV118DeleteModelResultsV7deletedSSSgvp":{"name":"deleted","abstract":"

model_id of the deleted model.

","parent_name":"DeleteModelResults"},"Structs/ConceptsResult.html#/s:30NaturalLanguageUnderstandingV114ConceptsResultV4textSSSgvp":{"name":"text","abstract":"

Name of the concept.

","parent_name":"ConceptsResult"},"Structs/ConceptsResult.html#/s:30NaturalLanguageUnderstandingV114ConceptsResultV9relevanceSdSgvp":{"name":"relevance","abstract":"

Relevance score between 0 and 1. Higher scores indicate greater relevance.

","parent_name":"ConceptsResult"},"Structs/ConceptsResult.html#/s:30NaturalLanguageUnderstandingV114ConceptsResultV15dbpediaResourceSSSgvp":{"name":"dbpediaResource","abstract":"

Link to the corresponding DBpedia resource.

","parent_name":"ConceptsResult"},"Structs/ConceptsOptions.html#/s:30NaturalLanguageUnderstandingV115ConceptsOptionsV5limitSiSgvp":{"name":"limit","abstract":"

Maximum number of concepts to return.

","parent_name":"ConceptsOptions"},"Structs/ConceptsOptions.html#/s:30NaturalLanguageUnderstandingV115ConceptsOptionsVACSiSg5limit_tcfc":{"name":"init(limit:)","abstract":"

Initialize a ConceptsOptions with member variables.

","parent_name":"ConceptsOptions"},"Structs/CategoriesResult.html#/s:30NaturalLanguageUnderstandingV116CategoriesResultV5labelSSSgvp":{"name":"label","abstract":"

The path to the category through the taxonomy hierarchy.

","parent_name":"CategoriesResult"},"Structs/CategoriesResult.html#/s:30NaturalLanguageUnderstandingV116CategoriesResultV5scoreSdSgvp":{"name":"score","abstract":"

Confidence score for the category classification. Higher values indicate greater confidence.

","parent_name":"CategoriesResult"},"Structs/CategoriesOptions.html#/s:30NaturalLanguageUnderstandingV117CategoriesOptionsV20additionalPropertiess10DictionaryVySSAA4JSONOGvp":{"name":"additionalProperties","abstract":"

Additional properties associated with this model.

","parent_name":"CategoriesOptions"},"Structs/CategoriesOptions.html#/s:30NaturalLanguageUnderstandingV117CategoriesOptionsVACs10DictionaryVySSAA4JSONOG20additionalProperties_tcfc":{"name":"init(additionalProperties:)","abstract":"

Initialize a CategoriesOptions.

","parent_name":"CategoriesOptions"},"Structs/CategoriesOptions.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"CategoriesOptions"},"Structs/Author.html#/s:30NaturalLanguageUnderstandingV16AuthorV4nameSSSgvp":{"name":"name","abstract":"

Name of the author.

","parent_name":"Author"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV8languageSSSgvp":{"name":"language","abstract":"

Language used to analyze the text.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV12analyzedTextSSSgvp":{"name":"analyzedText","abstract":"

Text that was used in the analysis.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV12retrievedUrlSSSgvp":{"name":"retrievedUrl","abstract":"

URL that was used to retrieve HTML content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV5usageAA5UsageVSgvp":{"name":"usage","abstract":"

API usage information for the request.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV8conceptsSayAA14ConceptsResultVGSgvp":{"name":"concepts","abstract":"

The general concepts referenced or alluded to in the specified content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV8entitiesSayAA14EntitiesResultVGSgvp":{"name":"entities","abstract":"

The important entities in the specified content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV8keywordsSayAA14KeywordsResultVGSgvp":{"name":"keywords","abstract":"

The important keywords in content organized by relevance.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV10categoriesSayAA16CategoriesResultVGSgvp":{"name":"categories","abstract":"

The hierarchical 5-level taxonomy the content is categorized into.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV7emotionAA13EmotionResultVSgvp":{"name":"emotion","abstract":"

The anger, disgust, fear, joy, or sadness conveyed by the content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV8metadataAA14MetadataResultVSgvp":{"name":"metadata","abstract":"

The metadata holds author information, publication date and the title of the text/HTML content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV9relationsSayAA15RelationsResultVGSgvp":{"name":"relations","abstract":"

The relationships between entities in the content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV13semanticRolesSayAA08SemanticH6ResultVGSgvp":{"name":"semanticRoles","abstract":"

The subjects of actions and the objects the actions act upon.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html#/s:30NaturalLanguageUnderstandingV115AnalysisResultsV9sentimentAA15SentimentResultVSgvp":{"name":"sentiment","abstract":"

The sentiment of the content.

","parent_name":"AnalysisResults"},"Structs/AnalysisResults.html":{"name":"AnalysisResults","abstract":"

Results of the analysis, organized by feature.

"},"Structs/Author.html":{"name":"Author","abstract":"

The author of the analyzed content.

"},"Structs/CategoriesOptions.html":{"name":"CategoriesOptions","abstract":"

The hierarchical 5-level taxonomy the content is categorized into.

"},"Structs/CategoriesResult.html":{"name":"CategoriesResult","abstract":"

The hierarchical 5-level taxonomy the content is categorized into.

"},"Structs/ConceptsOptions.html":{"name":"ConceptsOptions","abstract":"

Whether or not to analyze content for general concepts that are referenced or alluded to.

"},"Structs/ConceptsResult.html":{"name":"ConceptsResult","abstract":"

The general concepts referenced or alluded to in the specified content.

"},"Structs/DeleteModelResults.html":{"name":"DeleteModelResults","abstract":"

Information about the deleted model.

"},"Structs/DisambiguationResult.html":{"name":"DisambiguationResult","abstract":"

Disambiguation information for the entity.

"},"Structs/DocumentEmotionResults.html":{"name":"DocumentEmotionResults","abstract":"

An object containing the emotion results of a document.

"},"Structs/DocumentSentimentResults.html":{"name":"DocumentSentimentResults","abstract":"

DocumentSentimentResults.

"},"Structs/EmotionOptions.html":{"name":"EmotionOptions","abstract":"

Whether or not to return emotion analysis of the content.

"},"Structs/EmotionResult.html":{"name":"EmotionResult","abstract":"

The detected anger, disgust, fear, joy, or sadness that is conveyed by the content. Emotion information can be returned for detected entities, keywords, or user-specified target phrases found in the text.

"},"Structs/EmotionScores.html":{"name":"EmotionScores","abstract":"

EmotionScores.

"},"Structs/EntitiesOptions.html":{"name":"EntitiesOptions","abstract":"

Whether or not to return important people, places, geopolitical, and other entities detected in the analyzed content.

"},"Structs/EntitiesResult.html":{"name":"EntitiesResult","abstract":"

The important people, places, geopolitical entities and other types of entities in your content.

"},"Structs/EntityMention.html":{"name":"EntityMention","abstract":"

EntityMention.

"},"Structs/FeatureSentimentResults.html":{"name":"FeatureSentimentResults","abstract":"

FeatureSentimentResults.

"},"Structs/Features.html":{"name":"Features","abstract":"

Analysis features and options.

"},"Structs/Feed.html":{"name":"Feed","abstract":"

RSS or ATOM feed found on the webpage.

"},"Structs/KeywordsOptions.html":{"name":"KeywordsOptions","abstract":"

An option indicating whether or not important keywords from the analyzed content should be returned.

"},"Structs/KeywordsResult.html":{"name":"KeywordsResult","abstract":"

The most important keywords in the content, organized by relevance.

"},"Structs/ListModelsResults.html":{"name":"ListModelsResults","abstract":"

Models available for Relations and Entities features.

"},"Structs/MetadataOptions.html":{"name":"MetadataOptions","abstract":"

The Authors, Publication Date, and Title of the document. Supports URL and HTML input types.

"},"Structs/MetadataResult.html":{"name":"MetadataResult","abstract":"

The Authors, Publication Date, and Title of the document. Supports URL and HTML input types.

"},"Structs/Model.html":{"name":"Model","abstract":"

Model.

"},"Structs/Parameters.html":{"name":"Parameters","abstract":"

An object containing request parameters.

"},"Structs/RelationArgument.html":{"name":"RelationArgument","abstract":"

RelationArgument.

"},"Structs/RelationEntity.html":{"name":"RelationEntity","abstract":"

An entity that corresponds with an argument in a relation.

"},"Structs/RelationsOptions.html":{"name":"RelationsOptions","abstract":"

An option specifying if the relationships found between entities in the analyzed content should be returned.

"},"Structs/RelationsResult.html":{"name":"RelationsResult","abstract":"

The relations between entities found in the content.

"},"Structs/SemanticRolesAction.html":{"name":"SemanticRolesAction","abstract":"

SemanticRolesAction.

"},"Structs/SemanticRolesEntity.html":{"name":"SemanticRolesEntity","abstract":"

SemanticRolesEntity.

"},"Structs/SemanticRolesKeyword.html":{"name":"SemanticRolesKeyword","abstract":"

SemanticRolesKeyword.

"},"Structs/SemanticRolesObject.html":{"name":"SemanticRolesObject","abstract":"

SemanticRolesObject.

"},"Structs/SemanticRolesOptions.html":{"name":"SemanticRolesOptions","abstract":"

An option specifying whether or not to identify the subjects, actions, and verbs in the analyzed content.

"},"Structs/SemanticRolesResult.html":{"name":"SemanticRolesResult","abstract":"

The object containing the actions and the objects the actions act upon.

"},"Structs/SemanticRolesSubject.html":{"name":"SemanticRolesSubject","abstract":"

SemanticRolesSubject.

"},"Structs/SemanticRolesVerb.html":{"name":"SemanticRolesVerb","abstract":"

SemanticRolesVerb.

"},"Structs/SentimentOptions.html":{"name":"SentimentOptions","abstract":"

An option specifying if sentiment of detected entities, keywords, or phrases should be returned.

"},"Structs/SentimentResult.html":{"name":"SentimentResult","abstract":"

The sentiment of the content.

"},"Structs/TargetedEmotionResults.html":{"name":"TargetedEmotionResults","abstract":"

An object containing the emotion results for the target.

"},"Structs/TargetedSentimentResults.html":{"name":"TargetedSentimentResults","abstract":"

TargetedSentimentResults.

"},"Structs/Usage.html":{"name":"Usage","abstract":"

Usage information.

"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO013serializationF0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO08encodingF0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO011fileManagerF0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:30NaturalLanguageUnderstandingV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:30NaturalLanguageUnderstandingV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

Create a NaturalLanguageUnderstanding object.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a NaturalLanguageUnderstanding object.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a NaturalLanguageUnderstanding object.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C7analyzeyAA10ParametersV10parameters_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA15AnalysisResultsVc7successtF":{"name":"analyze(parameters:headers:failure:success:)","abstract":"

Analyze text, HTML, or a public webpage.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C10listModelsys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA04ListF7ResultsVc7successtF":{"name":"listModels(headers:failure:success:)","abstract":"

List models.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html#/s:30NaturalLanguageUnderstandingV10abC0C11deleteModelySS7modelID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA06DeleteF7ResultsVc7successtF":{"name":"deleteModel(modelID:headers:failure:success:)","abstract":"

Delete model.

","parent_name":"NaturalLanguageUnderstanding"},"Classes/NaturalLanguageUnderstanding.html":{"name":"NaturalLanguageUnderstanding","abstract":"

Analyze various features of text content at scale. Provide text, raw HTML, or a public URL, and IBM Watson Natural"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file diff --git a/docs/swift-api/services/NaturalLanguageUnderstandingV1/undocumented.json b/docs/swift-api/services/NaturalLanguageUnderstandingV1/undocumented.json index 1752e28ee..4010d521a 100644 --- a/docs/swift-api/services/NaturalLanguageUnderstandingV1/undocumented.json +++ b/docs/swift-api/services/NaturalLanguageUnderstandingV1/undocumented.json @@ -16,28 +16,28 @@ }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesAction.swift", - "line": 28, + "line": 32, "symbol": "SemanticRolesAction.verb", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesObject.swift", - "line": 25, + "line": 27, "symbol": "SemanticRolesObject.keywords", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesSubject.swift", - "line": 25, + "line": 27, "symbol": "SemanticRolesSubject.entities", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesSubject.swift", - "line": 27, + "line": 29, "symbol": "SemanticRolesSubject.keywords", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" diff --git a/docs/swift-api/services/PersonalityInsightsV3/Classes.html b/docs/swift-api/services/PersonalityInsightsV3/Classes.html index 49f011169..e5bc891b4 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/Classes.html +++ b/docs/swift-api/services/PersonalityInsightsV3/Classes.html @@ -71,9 +71,6 @@ - @@ -119,10 +116,10 @@

Classes

-

The IBM Watson Personality Insights service enables applications to derive insights from social media, enterprise data, -or other digital communications. The service uses linguistic analytics to infer individuals’ intrinsic personality -characteristics, including Big Five, Needs, and Values, from digital communications such as email, text messages, -tweets, and forum posts. +

The IBM Watson™ Personality Insights service enables applications to derive insights from social media, +enterprise data, or other digital communications. The service uses linguistic analytics to infer individuals’ intrinsic +personality characteristics, including Big Five, Needs, and Values, from digital communications such as email, text +messages, tweets, and forum posts. The service can automatically infer, from potentially noisy social media, portraits of individuals that reflect their personality characteristics. The service can infer consumption preferences based on the results of its analysis and, for JSON content that is timestamped, can report temporal behavior.

@@ -154,7 +151,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/Classes/PersonalityInsights.html b/docs/swift-api/services/PersonalityInsightsV3/Classes/PersonalityInsights.html index 05008c0d9..22481046a 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/Classes/PersonalityInsights.html +++ b/docs/swift-api/services/PersonalityInsightsV3/Classes/PersonalityInsights.html @@ -71,9 +71,6 @@ - @@ -106,10 +103,10 @@

PersonalityInsights

-

The IBM Watson Personality Insights service enables applications to derive insights from social media, enterprise data, -or other digital communications. The service uses linguistic analytics to infer individuals’ intrinsic personality -characteristics, including Big Five, Needs, and Values, from digital communications such as email, text messages, -tweets, and forum posts. +

The IBM Watson™ Personality Insights service enables applications to derive insights from social media, +enterprise data, or other digital communications. The service uses linguistic analytics to infer individuals’ intrinsic +personality characteristics, including Big Five, Needs, and Values, from digital communications such as email, text +messages, tweets, and forum posts. The service can automatically infer, from potentially noisy social media, portraits of individuals that reflect their personality characteristics. The service can infer consumption preferences based on the results of its analysis and, for JSON content that is timestamped, can report temporal behavior.

@@ -430,12 +427,12 @@

Declaration

service analyzes text in Arabic, English, Japanese, Korean, or Spanish and returns its results in a variety of languages. You can provide plain text, HTML, or JSON input by specifying the Content-Type parameter; the default is text/plain. Request a JSON or comma-separated values (CSV) response by specifying the Accept -parameter; CSV output includes a fixed number of columns and optional headers. Per the JSON specification, the -default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default -encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content -type of plain text or HTML, include the charset parameter to indicate the character encoding of the input text; -for example: Content-Type: text/plain;charset=utf-8. For detailed information about calling the service and the -responses it can generate, see Requesting a +parameter; CSV output includes a fixed number of columns and optional headers. +Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the +HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character +set). When specifying a content type of plain text or HTML, include the charset parameter to indicate the +character encoding of the input text; for example: Content-Type: text/plain;charset=utf-8. +For detailed information about calling the service and the responses it can generate, see Requesting a profile, Understanding a JSON profile, and Understanding a CSV profile.

@@ -470,8 +467,9 @@

Parameters

A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see -Providing sufficient input. -For JSON input, provide an object of type Content.

+Providing sufficient +input. For JSON input, +provide an object of type Content.

@@ -484,13 +482,13 @@

Parameters

The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish. Regional variants -are treated as their parent language; for example, en-US is interpreted as en. The effect of the -Content-Language parameter depends on the Content-Type parameter. When Content-Type is text/plain or -text/html, Content-Language is the only way to specify the language. When Content-Type is -application/json, Content-Language overrides a language specified with the language parameter of a -ContentItem object, and content items that specify a different language are ignored; omit this parameter to base -the language on the specification of the content items. You can specify any combination of languages for -Content-Language and Accept-Language.

+are treated as their parent language; for example, en-US is interpreted as en. +The effect of the Content-Language parameter depends on the Content-Type parameter. When Content-Type +is text/plain or text/html, Content-Language is the only way to specify the language. When +Content-Type is application/json, Content-Language overrides a language specified with the language +parameter of a ContentItem object, and content items that specify a different language are ignored; omit this +parameter to base the language on the specification of the content items. You can specify any combination of +languages for Content-Language and Accept-Language.

@@ -529,8 +527,8 @@

Parameters

-

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences are -returned.

+

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences +are returned.

@@ -597,12 +595,12 @@

Parameters

service analyzes text in Arabic, English, Japanese, Korean, or Spanish and returns its results in a variety of languages. You can provide plain text, HTML, or JSON input by specifying the Content-Type parameter; the default is text/plain. Request a JSON or comma-separated values (CSV) response by specifying the Accept -parameter; CSV output includes a fixed number of columns and optional headers. Per the JSON specification, the -default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default -encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content -type of plain text or HTML, include the charset parameter to indicate the character encoding of the input text; -for example: Content-Type: text/plain;charset=utf-8. For detailed information about calling the service and the -responses it can generate, see Requesting a +parameter; CSV output includes a fixed number of columns and optional headers. +Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the +HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character +set). When specifying a content type of plain text or HTML, include the charset parameter to indicate the +character encoding of the input text; for example: Content-Type: text/plain;charset=utf-8. +For detailed information about calling the service and the responses it can generate, see Requesting a profile, Understanding a JSON profile, and Understanding a CSV profile.

@@ -637,8 +635,9 @@

Parameters

A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see -Providing sufficient input. -For JSON input, provide an object of type Content.

+Providing sufficient +input. For JSON input, +provide an object of type Content.

@@ -651,13 +650,13 @@

Parameters

The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish. Regional variants -are treated as their parent language; for example, en-US is interpreted as en. The effect of the -Content-Language parameter depends on the Content-Type parameter. When Content-Type is text/plain or -text/html, Content-Language is the only way to specify the language. When Content-Type is -application/json, Content-Language overrides a language specified with the language parameter of a -ContentItem object, and content items that specify a different language are ignored; omit this parameter to base -the language on the specification of the content items. You can specify any combination of languages for -Content-Language and Accept-Language.

+are treated as their parent language; for example, en-US is interpreted as en. +The effect of the Content-Language parameter depends on the Content-Type parameter. When Content-Type +is text/plain or text/html, Content-Language is the only way to specify the language. When +Content-Type is application/json, Content-Language overrides a language specified with the language +parameter of a ContentItem object, and content items that specify a different language are ignored; omit this +parameter to base the language on the specification of the content items. You can specify any combination of +languages for Content-Language and Accept-Language.

@@ -696,8 +695,8 @@

Parameters

-

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences are -returned.

+

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences +are returned.

@@ -764,12 +763,12 @@

Parameters

service analyzes text in Arabic, English, Japanese, Korean, or Spanish and returns its results in a variety of languages. You can provide plain text, HTML, or JSON input by specifying the Content-Type parameter; the default is text/plain. Request a JSON or comma-separated values (CSV) response by specifying the Accept -parameter; CSV output includes a fixed number of columns and optional headers. Per the JSON specification, the -default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default -encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content -type of plain text or HTML, include the charset parameter to indicate the character encoding of the input text; -for example: Content-Type: text/plain;charset=utf-8. For detailed information about calling the service and the -responses it can generate, see Requesting a +parameter; CSV output includes a fixed number of columns and optional headers. +Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the +HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character +set). When specifying a content type of plain text or HTML, include the charset parameter to indicate the +character encoding of the input text; for example: Content-Type: text/plain;charset=utf-8. +For detailed information about calling the service and the responses it can generate, see Requesting a profile, Understanding a JSON profile, and Understanding a CSV profile.

@@ -804,8 +803,9 @@

Parameters

A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see -Providing sufficient input. -For JSON input, provide an object of type Content.

+Providing sufficient +input. For JSON input, +provide an object of type Content.

@@ -818,13 +818,13 @@

Parameters

The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish. Regional variants -are treated as their parent language; for example, en-US is interpreted as en. The effect of the -Content-Language parameter depends on the Content-Type parameter. When Content-Type is text/plain or -text/html, Content-Language is the only way to specify the language. When Content-Type is -application/json, Content-Language overrides a language specified with the language parameter of a -ContentItem object, and content items that specify a different language are ignored; omit this parameter to base -the language on the specification of the content items. You can specify any combination of languages for -Content-Language and Accept-Language.

+are treated as their parent language; for example, en-US is interpreted as en. +The effect of the Content-Language parameter depends on the Content-Type parameter. When Content-Type +is text/plain or text/html, Content-Language is the only way to specify the language. When +Content-Type is application/json, Content-Language overrides a language specified with the language +parameter of a ContentItem object, and content items that specify a different language are ignored; omit this +parameter to base the language on the specification of the content items. You can specify any combination of +languages for Content-Language and Accept-Language.

@@ -863,8 +863,8 @@

Parameters

-

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences are -returned.

+

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences +are returned.

@@ -923,7 +923,7 @@

Parameters

-

Get profile. as csv

+

Get profile as csv.

Generates a personality profile for the author of the input text. The service accepts a maximum of 20 MB of input content, but it requires much less text to produce an accurate profile; for more information, see Providing @@ -931,12 +931,12 @@

Parameters

service analyzes text in Arabic, English, Japanese, Korean, or Spanish and returns its results in a variety of languages. You can provide plain text, HTML, or JSON input by specifying the Content-Type parameter; the default is text/plain. Request a JSON or comma-separated values (CSV) response by specifying the Accept -parameter; CSV output includes a fixed number of columns and optional headers. Per the JSON specification, the -default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default -encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content -type of plain text or HTML, include the charset parameter to indicate the character encoding of the input text; -for example: Content-Type: text/plain;charset=utf-8. For detailed information about calling the service and the -responses it can generate, see Requesting a +parameter; CSV output includes a fixed number of columns and optional headers. +Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the +HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character +set). When specifying a content type of plain text or HTML, include the charset parameter to indicate the +character encoding of the input text; for example: Content-Type: text/plain;charset=utf-8. +For detailed information about calling the service and the responses it can generate, see Requesting a profile, Understanding a JSON profile, and Understanding a CSV profile.

@@ -972,8 +972,9 @@

Parameters

A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see -Providing sufficient input. -For JSON input, provide an object of type Content.

+Providing sufficient +input. For JSON input, +provide an object of type Content.

@@ -986,13 +987,13 @@

Parameters

The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish. Regional variants -are treated as their parent language; for example, en-US is interpreted as en. The effect of the -Content-Language parameter depends on the Content-Type parameter. When Content-Type is text/plain or -text/html, Content-Language is the only way to specify the language. When Content-Type is -application/json, Content-Language overrides a language specified with the language parameter of a -ContentItem object, and content items that specify a different language are ignored; omit this parameter to base -the language on the specification of the content items. You can specify any combination of languages for -Content-Language and Accept-Language.

+are treated as their parent language; for example, en-US is interpreted as en. +The effect of the Content-Language parameter depends on the Content-Type parameter. When Content-Type +is text/plain or text/html, Content-Language is the only way to specify the language. When +Content-Type is application/json, Content-Language overrides a language specified with the language +parameter of a ContentItem object, and content items that specify a different language are ignored; omit this +parameter to base the language on the specification of the content items. You can specify any combination of +languages for Content-Language and Accept-Language.

@@ -1044,8 +1045,8 @@

Parameters

-

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences are -returned.

+

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences +are returned.

@@ -1104,7 +1105,7 @@

Parameters

-

Get profile. as csv

+

Get profile as csv.

Generates a personality profile for the author of the input text. The service accepts a maximum of 20 MB of input content, but it requires much less text to produce an accurate profile; for more information, see Providing @@ -1112,12 +1113,12 @@

Parameters

service analyzes text in Arabic, English, Japanese, Korean, or Spanish and returns its results in a variety of languages. You can provide plain text, HTML, or JSON input by specifying the Content-Type parameter; the default is text/plain. Request a JSON or comma-separated values (CSV) response by specifying the Accept -parameter; CSV output includes a fixed number of columns and optional headers. Per the JSON specification, the -default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default -encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content -type of plain text or HTML, include the charset parameter to indicate the character encoding of the input text; -for example: Content-Type: text/plain;charset=utf-8. For detailed information about calling the service and the -responses it can generate, see Requesting a +parameter; CSV output includes a fixed number of columns and optional headers. +Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the +HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character +set). When specifying a content type of plain text or HTML, include the charset parameter to indicate the +character encoding of the input text; for example: Content-Type: text/plain;charset=utf-8. +For detailed information about calling the service and the responses it can generate, see Requesting a profile, Understanding a JSON profile, and Understanding a CSV profile.

@@ -1153,8 +1154,9 @@

Parameters

A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see -Providing sufficient input. -For JSON input, provide an object of type Content.

+Providing sufficient +input. For JSON input, +provide an object of type Content.

@@ -1167,13 +1169,13 @@

Parameters

The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish. Regional variants -are treated as their parent language; for example, en-US is interpreted as en. The effect of the -Content-Language parameter depends on the Content-Type parameter. When Content-Type is text/plain or -text/html, Content-Language is the only way to specify the language. When Content-Type is -application/json, Content-Language overrides a language specified with the language parameter of a -ContentItem object, and content items that specify a different language are ignored; omit this parameter to base -the language on the specification of the content items. You can specify any combination of languages for -Content-Language and Accept-Language.

+are treated as their parent language; for example, en-US is interpreted as en. +The effect of the Content-Language parameter depends on the Content-Type parameter. When Content-Type +is text/plain or text/html, Content-Language is the only way to specify the language. When +Content-Type is application/json, Content-Language overrides a language specified with the language +parameter of a ContentItem object, and content items that specify a different language are ignored; omit this +parameter to base the language on the specification of the content items. You can specify any combination of +languages for Content-Language and Accept-Language.

@@ -1225,8 +1227,8 @@

Parameters

-

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences are -returned.

+

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences +are returned.

@@ -1285,7 +1287,7 @@

Parameters

-

Get profile. as csv

+

Get profile as csv.

Generates a personality profile for the author of the input text. The service accepts a maximum of 20 MB of input content, but it requires much less text to produce an accurate profile; for more information, see Providing @@ -1293,12 +1295,12 @@

Parameters

service analyzes text in Arabic, English, Japanese, Korean, or Spanish and returns its results in a variety of languages. You can provide plain text, HTML, or JSON input by specifying the Content-Type parameter; the default is text/plain. Request a JSON or comma-separated values (CSV) response by specifying the Accept -parameter; CSV output includes a fixed number of columns and optional headers. Per the JSON specification, the -default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default -encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content -type of plain text or HTML, include the charset parameter to indicate the character encoding of the input text; -for example: Content-Type: text/plain;charset=utf-8. For detailed information about calling the service and the -responses it can generate, see Requesting a +parameter; CSV output includes a fixed number of columns and optional headers. +Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the +HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character +set). When specifying a content type of plain text or HTML, include the charset parameter to indicate the +character encoding of the input text; for example: Content-Type: text/plain;charset=utf-8. +For detailed information about calling the service and the responses it can generate, see Requesting a profile, Understanding a JSON profile, and Understanding a CSV profile.

@@ -1334,8 +1336,9 @@

Parameters

A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see -Providing sufficient input. -For JSON input, provide an object of type Content.

+Providing sufficient +input. For JSON input, +provide an object of type Content.

@@ -1348,13 +1351,13 @@

Parameters

The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish. Regional variants -are treated as their parent language; for example, en-US is interpreted as en. The effect of the -Content-Language parameter depends on the Content-Type parameter. When Content-Type is text/plain or -text/html, Content-Language is the only way to specify the language. When Content-Type is -application/json, Content-Language overrides a language specified with the language parameter of a -ContentItem object, and content items that specify a different language are ignored; omit this parameter to base -the language on the specification of the content items. You can specify any combination of languages for -Content-Language and Accept-Language.

+are treated as their parent language; for example, en-US is interpreted as en. +The effect of the Content-Language parameter depends on the Content-Type parameter. When Content-Type +is text/plain or text/html, Content-Language is the only way to specify the language. When +Content-Type is application/json, Content-Language overrides a language specified with the language +parameter of a ContentItem object, and content items that specify a different language are ignored; omit this +parameter to base the language on the specification of the content items. You can specify any combination of +languages for Content-Language and Accept-Language.

@@ -1406,8 +1409,8 @@

Parameters

-

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences are -returned.

+

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences +are returned.

@@ -1458,7 +1461,7 @@

Parameters

diff --git a/docs/swift-api/services/PersonalityInsightsV3/Enums.html b/docs/swift-api/services/PersonalityInsightsV3/Enums.html index 60657ec9c..35a33d944 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/Enums.html +++ b/docs/swift-api/services/PersonalityInsightsV3/Enums.html @@ -71,9 +71,6 @@ - @@ -171,7 +168,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/Enums/JSON.html b/docs/swift-api/services/PersonalityInsightsV3/Enums/JSON.html index 752eb44d0..2974b5686 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/Enums/JSON.html +++ b/docs/swift-api/services/PersonalityInsightsV3/Enums/JSON.html @@ -71,9 +71,6 @@ - @@ -441,7 +438,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/Enums/RestError.html b/docs/swift-api/services/PersonalityInsightsV3/Enums/RestError.html index 6d74dc86b..7f62ad014 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/Enums/RestError.html +++ b/docs/swift-api/services/PersonalityInsightsV3/Enums/RestError.html @@ -71,9 +71,6 @@ - @@ -308,7 +305,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/Structs.html b/docs/swift-api/services/PersonalityInsightsV3/Structs.html index 4ea01761b..e3b90275f 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/Structs.html +++ b/docs/swift-api/services/PersonalityInsightsV3/Structs.html @@ -71,9 +71,6 @@ - @@ -360,49 +357,10 @@

Declaration

-
-
- - - -

JSON

-
-
-
    -
  • -
    - - - - JSONWrapper - -
    -
    -
    -
    -
    -
    -

    Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct JSONWrapper
    - -
    -
    -
    -
    -
  • -
-
diff --git a/docs/swift-api/services/PersonalityInsightsV3/Structs/Behavior.html b/docs/swift-api/services/PersonalityInsightsV3/Structs/Behavior.html index 8d3573e10..ada73ada6 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/Structs/Behavior.html +++ b/docs/swift-api/services/PersonalityInsightsV3/Structs/Behavior.html @@ -71,9 +71,6 @@ - @@ -125,7 +122,8 @@

Behavior

-

The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form behavior_{value}.

+

The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form +behavior_{value}.

@@ -206,7 +204,8 @@

Declaration

-

For JSON content that is timestamped, the percentage of timestamped input data that occurred during that day of the week or hour of the day. The range is 0 to 1.

+

For JSON content that is timestamped, the percentage of timestamped input data that occurred during that day of the +week or hour of the day. The range is 0 to 1.

@@ -225,7 +224,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/Structs/ConsumptionPreferences.html b/docs/swift-api/services/PersonalityInsightsV3/Structs/ConsumptionPreferences.html index f7a85a063..568d58084 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/Structs/ConsumptionPreferences.html +++ b/docs/swift-api/services/PersonalityInsightsV3/Structs/ConsumptionPreferences.html @@ -71,9 +71,6 @@ - @@ -125,7 +122,8 @@

ConsumptionPreferences

-

The unique, non-localized identifier of the consumption preference to which the results pertain. IDs have the form consumption_preferences_{preference}.

+

The unique, non-localized identifier of the consumption preference to which the results pertain. IDs have the form +consumption_preferences_{preference}.

@@ -179,7 +177,15 @@

Declaration

-

The score for the consumption preference: * 0.0: Unlikely * 0.5: Neutral * 1.0: Likely The scores for some preferences are binary and do not allow a neutral value. The score is an indication of preference based on the results inferred from the input text, not a normalized percentile.

+

The score for the consumption preference:

+ +
    +
  • 0.0: Unlikely
  • +
  • 0.5: Neutral
  • +
  • 1.0: Likely +The scores for some preferences are binary and do not allow a neutral value. The score is an indication of +preference based on the results inferred from the input text, not a normalized percentile.
  • +
@@ -198,7 +204,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/Structs/ConsumptionPreferencesCategory.html b/docs/swift-api/services/PersonalityInsightsV3/Structs/ConsumptionPreferencesCategory.html index 8762333f5..c85603bf1 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/Structs/ConsumptionPreferencesCategory.html +++ b/docs/swift-api/services/PersonalityInsightsV3/Structs/ConsumptionPreferencesCategory.html @@ -71,9 +71,6 @@ - @@ -125,7 +122,8 @@

ConsumptionPreferencesCategory

-

The unique, non-localized identifier of the consumption preferences category to which the results pertain. IDs have the form consumption_preferences_{category}.

+

The unique, non-localized identifier of the consumption preferences category to which the results pertain. IDs have +the form consumption_preferences_{category}.

@@ -198,7 +196,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/Structs/Content.html b/docs/swift-api/services/PersonalityInsightsV3/Structs/Content.html index a5953da99..6f15246b1 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/Structs/Content.html +++ b/docs/swift-api/services/PersonalityInsightsV3/Structs/Content.html @@ -71,9 +71,6 @@ - @@ -159,7 +156,9 @@

Declaration

Declaration

Swift

-
public init(contentItems: [ContentItem])
+
public init(
+    contentItems: [ContentItem]
+)
@@ -194,7 +193,7 @@

Return Value

diff --git a/docs/swift-api/services/PersonalityInsightsV3/Structs/ContentItem.html b/docs/swift-api/services/PersonalityInsightsV3/Structs/ContentItem.html index f8d72c2d0..b18eec64a 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/Structs/ContentItem.html +++ b/docs/swift-api/services/PersonalityInsightsV3/Structs/ContentItem.html @@ -71,9 +71,6 @@ - @@ -125,7 +122,8 @@

ContentItem

-

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is analyzed; plain text is processed as submitted.

+

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is +analyzed; plain text is processed as submitted.

See more
@@ -153,7 +151,12 @@

Declaration

-

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en (English). Regional variants are treated as their parent language; for example, en-US is interpreted as en. A language specified with the Content-Type parameter overrides the value of this parameter; any content items that specify a different language are ignored. Omit the Content-Type parameter to base the language on the most prevalent specification among the content items; again, content items that specify a different language are ignored. You can specify any combination of languages for the input and response content.

+

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en +(English). Regional variants are treated as their parent language; for example, en-US is interpreted as en. A +language specified with the Content-Type parameter overrides the value of this parameter; any content items +that specify a different language are ignored. Omit the Content-Type parameter to base the language on the most +prevalent specification among the content items; again, content items that specify a different language are +ignored. You can specify any combination of languages for the input and response content.

See more
@@ -181,7 +184,8 @@

Declaration

-

The content that is to be analyzed. The service supports up to 20 MB of content for all ContentItem objects combined.

+

The content that is to be analyzed. The service supports up to 20 MB of content for all ContentItem objects +combined.

@@ -235,7 +239,8 @@

Declaration

-

A timestamp that identifies when this content was created. Specify a value in milliseconds since the UNIX Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.

+

A timestamp that identifies when this content was created. Specify a value in milliseconds since the UNIX Epoch +(January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.

@@ -262,7 +267,8 @@

Declaration

-

A timestamp that identifies when this content was last updated. Specify a value in milliseconds since the UNIX Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.

+

A timestamp that identifies when this content was last updated. Specify a value in milliseconds since the UNIX +Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.

@@ -289,7 +295,8 @@

Declaration

-

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is analyzed; plain text is processed as submitted.

+

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is +analyzed; plain text is processed as submitted.

@@ -316,7 +323,12 @@

Declaration

-

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en (English). Regional variants are treated as their parent language; for example, en-US is interpreted as en. A language specified with the Content-Type parameter overrides the value of this parameter; any content items that specify a different language are ignored. Omit the Content-Type parameter to base the language on the most prevalent specification among the content items; again, content items that specify a different language are ignored. You can specify any combination of languages for the input and response content.

+

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en +(English). Regional variants are treated as their parent language; for example, en-US is interpreted as en. A +language specified with the Content-Type parameter overrides the value of this parameter; any content items +that specify a different language are ignored. Omit the Content-Type parameter to base the language on the most +prevalent specification among the content items; again, content items that specify a different language are +ignored. You can specify any combination of languages for the input and response content.

@@ -343,7 +355,8 @@

Declaration

-

The unique ID of the parent content item for this item. Used to identify hierarchical relationships between posts/replies, messages/replies, and so on.

+

The unique ID of the parent content item for this item. Used to identify hierarchical relationships between +posts/replies, messages/replies, and so on.

@@ -431,7 +444,17 @@

Declaration

Declaration

Swift

-
public init(content: String, id: String? = nil, created: Int? = nil, updated: Int? = nil, contenttype: String? = nil, language: String? = nil, parentid: String? = nil, reply: Bool? = nil, forward: Bool? = nil)
+
public init(
+    content: String,
+    id: String? = nil,
+    created: Int? = nil,
+    updated: Int? = nil,
+    contenttype: String? = nil,
+    language: String? = nil,
+    parentid: String? = nil,
+    reply: Bool? = nil,
+    forward: Bool? = nil
+)
@@ -447,7 +470,8 @@

Parameters

-

The content that is to be analyzed. The service supports up to 20 MB of content for all ContentItem objects combined.

+

The content that is to be analyzed. The service supports up to 20 MB of content for all ContentItem objects +combined.

@@ -471,7 +495,8 @@

Parameters

-

A timestamp that identifies when this content was created. Specify a value in milliseconds since the UNIX Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.

+

A timestamp that identifies when this content was created. Specify a value in milliseconds since the UNIX Epoch +(January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.

@@ -483,7 +508,8 @@

Parameters

-

A timestamp that identifies when this content was last updated. Specify a value in milliseconds since the UNIX Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.

+

A timestamp that identifies when this content was last updated. Specify a value in milliseconds since the UNIX +Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.

@@ -495,7 +521,8 @@

Parameters

-

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is analyzed; plain text is processed as submitted.

+

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is +analyzed; plain text is processed as submitted.

@@ -507,7 +534,12 @@

Parameters

-

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en (English). Regional variants are treated as their parent language; for example, en-US is interpreted as en. A language specified with the Content-Type parameter overrides the value of this parameter; any content items that specify a different language are ignored. Omit the Content-Type parameter to base the language on the most prevalent specification among the content items; again, content items that specify a different language are ignored. You can specify any combination of languages for the input and response content.

+

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is +en (English). Regional variants are treated as their parent language; for example, en-US is interpreted as +en. A language specified with the Content-Type parameter overrides the value of this parameter; any content +items that specify a different language are ignored. Omit the Content-Type parameter to base the language on +the most prevalent specification among the content items; again, content items that specify a different language +are ignored. You can specify any combination of languages for the input and response content.

@@ -519,7 +551,8 @@

Parameters

-

The unique ID of the parent content item for this item. Used to identify hierarchical relationships between posts/replies, messages/replies, and so on.

+

The unique ID of the parent content item for this item. Used to identify hierarchical relationships between +posts/replies, messages/replies, and so on.

@@ -562,7 +595,7 @@

Return Value

diff --git a/docs/swift-api/services/PersonalityInsightsV3/Structs/ContentItem/Contenttype.html b/docs/swift-api/services/PersonalityInsightsV3/Structs/ContentItem/Contenttype.html index eee98d7f3..b3fbe7062 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/Structs/ContentItem/Contenttype.html +++ b/docs/swift-api/services/PersonalityInsightsV3/Structs/ContentItem/Contenttype.html @@ -71,9 +71,6 @@ - @@ -106,7 +103,8 @@

Contenttype

-

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is analyzed; plain text is processed as submitted.

+

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is +analyzed; plain text is processed as submitted.

@@ -171,7 +169,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/Structs/ContentItem/Language.html b/docs/swift-api/services/PersonalityInsightsV3/Structs/ContentItem/Language.html index 37e9f17de..698aba027 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/Structs/ContentItem/Language.html +++ b/docs/swift-api/services/PersonalityInsightsV3/Structs/ContentItem/Language.html @@ -71,9 +71,6 @@ - @@ -106,7 +103,12 @@

Language

-

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en (English). Regional variants are treated as their parent language; for example, en-US is interpreted as en. A language specified with the Content-Type parameter overrides the value of this parameter; any content items that specify a different language are ignored. Omit the Content-Type parameter to base the language on the most prevalent specification among the content items; again, content items that specify a different language are ignored. You can specify any combination of languages for the input and response content.

+

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en +(English). Regional variants are treated as their parent language; for example, en-US is interpreted as en. A +language specified with the Content-Type parameter overrides the value of this parameter; any content items +that specify a different language are ignored. Omit the Content-Type parameter to base the language on the most +prevalent specification among the content items; again, content items that specify a different language are +ignored. You can specify any combination of languages for the input and response content.

@@ -252,7 +254,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/Structs/Profile.html b/docs/swift-api/services/PersonalityInsightsV3/Structs/Profile.html index 39482d952..8d7268e42 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/Structs/Profile.html +++ b/docs/swift-api/services/PersonalityInsightsV3/Structs/Profile.html @@ -71,9 +71,6 @@ - @@ -207,7 +204,8 @@

Declaration

-

When guidance is appropriate, a string that provides a message that indicates the number of words found and where that value falls in the range of required or suggested number of words.

+

When guidance is appropriate, a string that provides a message that indicates the number of words found and where +that value falls in the range of required or suggested number of words.

@@ -234,7 +232,8 @@

Declaration

-

A recursive array of Trait objects that provides detailed results for the Big Five personality characteristics (dimensions and facets) inferred from the input text.

+

A recursive array of Trait objects that provides detailed results for the Big Five personality characteristics +(dimensions and facets) inferred from the input text.

@@ -315,7 +314,9 @@

Declaration

-

For JSON content that is timestamped, detailed results about the social behavior disclosed by the input in terms of temporal characteristics. The results include information about the distribution of the content over the days of the week and the hours of the day.

+

For JSON content that is timestamped, detailed results about the social behavior disclosed by the input in terms of +temporal characteristics. The results include information about the distribution of the content over the days of +the week and the hours of the day.

@@ -342,7 +343,9 @@

Declaration

-

If the consumption_preferences parameter is true, detailed results for each category of consumption preferences. Each element of the array provides information inferred from the input text for the individual preferences of that category.

+

If the consumption_preferences parameter is true, detailed results for each category of consumption +preferences. Each element of the array provides information inferred from the input text for the individual +preferences of that category.

@@ -369,7 +372,8 @@

Declaration

-

Warning messages associated with the input text submitted with the request. The array is empty if the input generated no warnings.

+

Warning messages associated with the input text submitted with the request. The array is empty if the input +generated no warnings.

@@ -388,7 +392,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/Structs/Profile/ProcessedLanguage.html b/docs/swift-api/services/PersonalityInsightsV3/Structs/Profile/ProcessedLanguage.html index dedbcee08..df626cad1 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/Structs/Profile/ProcessedLanguage.html +++ b/docs/swift-api/services/PersonalityInsightsV3/Structs/Profile/ProcessedLanguage.html @@ -71,9 +71,6 @@ - @@ -252,7 +249,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/Structs/Trait.html b/docs/swift-api/services/PersonalityInsightsV3/Structs/Trait.html index a6d91e440..3842a1cfe 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/Structs/Trait.html +++ b/docs/swift-api/services/PersonalityInsightsV3/Structs/Trait.html @@ -71,9 +71,6 @@ - @@ -125,7 +122,8 @@

Trait

-

The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and values for Values.

+

The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and +values for Values.

See more
@@ -153,7 +151,14 @@

Declaration

-

The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form * big5_{characteristic} for Big Five personality dimensions * facet_{characteristic} for Big Five personality facets * need_{characteristic} for Needs *value_{characteristic} for Values.

+

The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form

+ +
    +
  • big5_{characteristic} for Big Five personality dimensions
  • +
  • facet_{characteristic} for Big Five personality facets
  • +
  • need_{characteristic} for Needs +*value_{characteristic} for Values.
  • +
@@ -207,7 +212,8 @@

Declaration

-

The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and values for Values.

+

The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and +values for Values.

@@ -234,7 +240,9 @@

Declaration

-

The normalized percentile score for the characteristic. The range is 0 to 1. For example, if the percentage for Openness is 0.60, the author scored in the 60th percentile; the author is more open than 59 percent of the population and less open than 39 percent of the population.

+

The normalized percentile score for the characteristic. The range is 0 to 1. For example, if the percentage for +Openness is 0.60, the author scored in the 60th percentile; the author is more open than 59 percent of the +population and less open than 39 percent of the population.

@@ -261,7 +269,13 @@

Declaration

-

The raw score for the characteristic. The range is 0 to 1. A higher score generally indicates a greater likelihood that the author has that characteristic, but raw scores must be considered in aggregate: The range of values in practice might be much smaller than 0 to 1, so an individual score must be considered in the context of the overall scores and their range. The raw score is computed based on the input and the service model; it is not normalized or compared with a sample population. The raw score enables comparison of the results against a different sampling population and with a custom normalization approach.

+

The raw score for the characteristic. The range is 0 to 1. A higher score generally indicates a greater likelihood +that the author has that characteristic, but raw scores must be considered in aggregate: The range of values in +practice might be much smaller than 0 to 1, so an individual score must be considered in the context of the overall +scores and their range. +The raw score is computed based on the input and the service model; it is not normalized or compared with a sample +population. The raw score enables comparison of the results against a different sampling population and with a +custom normalization approach.

@@ -288,7 +302,10 @@

Declaration

-

2017-10-13: Indicates whether the characteristic is meaningful for the input language. The field is always true for all characteristics of English, Spanish, and Japanese input. The field is false for the subset of characteristics of Arabic and Korean input for which the service’s models are unable to generate meaningful results. **2016-10-19: Not returned.

+

2017-10-13: Indicates whether the characteristic is meaningful for the input language. The field is always +true for all characteristics of English, Spanish, and Japanese input. The field is false for the subset of +characteristics of Arabic and Korean input for which the service’s models are unable to generate meaningful +results. 2016-10-19: Not returned.

@@ -315,7 +332,8 @@

Declaration

-

For personality (Big Five) dimensions, more detailed results for the facets of each dimension as inferred from the input text.

+

For personality (Big Five) dimensions, more detailed results for the facets of each dimension as inferred from +the input text.

@@ -334,7 +352,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/Structs/Trait/Category.html b/docs/swift-api/services/PersonalityInsightsV3/Structs/Trait/Category.html index 701fe8128..7533b605d 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/Structs/Trait/Category.html +++ b/docs/swift-api/services/PersonalityInsightsV3/Structs/Trait/Category.html @@ -71,9 +71,6 @@ - @@ -106,7 +103,8 @@

Category

-

The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and values for Values.

+

The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and +values for Values.

@@ -198,7 +196,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/Structs/Warning.html b/docs/swift-api/services/PersonalityInsightsV3/Structs/Warning.html index d62fc5dd2..6fccaaa73 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/Structs/Warning.html +++ b/docs/swift-api/services/PersonalityInsightsV3/Structs/Warning.html @@ -71,9 +71,6 @@ - @@ -180,7 +177,20 @@

Declaration

-

The message associated with the warning_id: * WORD_COUNT_MESSAGE: There were {number} words in the input. We need a minimum of 600, preferably 1,200 or more, to compute statistically significant estimates. * JSON_AS_TEXT: Request input was processed as text/plain as indicated, however detected a JSON input. Did you mean application/json? * CONTENT_TRUNCATED: For maximum accuracy while also optimizing processing time, only the first 250KB of input text (excluding markup) was analyzed. Accuracy levels off at approximately 3,000 words so this did not affect the accuracy of the profile. * PARTIAL_TEXT_USED, The text provided to compute the profile was trimmed for performance reasons. This action does not affect the accuracy of the output, as not all of the input text was required. Applies only when Arabic input text exceeds a threshold at which additional words do not contribute to the accuracy of the profile.

+

The message associated with the warning_id:

+ +
    +
  • WORD_COUNT_MESSAGE: There were {number} words in the input. We need a minimum of 600, preferably 1,200 or +more, to compute statistically significant estimates.
  • +
  • JSON_AS_TEXT: Request input was processed as text/plain as indicated, however detected a JSON input. Did you +mean application/json?
  • +
  • CONTENT_TRUNCATED: For maximum accuracy while also optimizing processing time, only the first 250KB of input +text (excluding markup) was analyzed. Accuracy levels off at approximately 3,000 words so this did not affect the +accuracy of the profile.
  • +
  • PARTIAL_TEXT_USED, The text provided to compute the profile was trimmed for performance reasons. This action +does not affect the accuracy of the output, as not all of the input text was required. Applies only when Arabic +input text exceeds a threshold at which additional words do not contribute to the accuracy of the profile.
  • +
@@ -199,7 +209,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/Structs/Warning/WarningID.html b/docs/swift-api/services/PersonalityInsightsV3/Structs/Warning/WarningID.html index a089d81ad..6a32d84ef 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/Structs/Warning/WarningID.html +++ b/docs/swift-api/services/PersonalityInsightsV3/Structs/Warning/WarningID.html @@ -71,9 +71,6 @@ - @@ -225,7 +222,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Classes.html b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Classes.html index 49f011169..e5bc891b4 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Classes.html +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Classes.html @@ -71,9 +71,6 @@ - @@ -119,10 +116,10 @@

Classes

-

The IBM Watson Personality Insights service enables applications to derive insights from social media, enterprise data, -or other digital communications. The service uses linguistic analytics to infer individuals’ intrinsic personality -characteristics, including Big Five, Needs, and Values, from digital communications such as email, text messages, -tweets, and forum posts. +

The IBM Watson™ Personality Insights service enables applications to derive insights from social media, +enterprise data, or other digital communications. The service uses linguistic analytics to infer individuals’ intrinsic +personality characteristics, including Big Five, Needs, and Values, from digital communications such as email, text +messages, tweets, and forum posts. The service can automatically infer, from potentially noisy social media, portraits of individuals that reflect their personality characteristics. The service can infer consumption preferences based on the results of its analysis and, for JSON content that is timestamped, can report temporal behavior.

@@ -154,7 +151,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Classes/PersonalityInsights.html b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Classes/PersonalityInsights.html index 05008c0d9..22481046a 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Classes/PersonalityInsights.html +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Classes/PersonalityInsights.html @@ -71,9 +71,6 @@ - @@ -106,10 +103,10 @@

PersonalityInsights

-

The IBM Watson Personality Insights service enables applications to derive insights from social media, enterprise data, -or other digital communications. The service uses linguistic analytics to infer individuals’ intrinsic personality -characteristics, including Big Five, Needs, and Values, from digital communications such as email, text messages, -tweets, and forum posts. +

The IBM Watson™ Personality Insights service enables applications to derive insights from social media, +enterprise data, or other digital communications. The service uses linguistic analytics to infer individuals’ intrinsic +personality characteristics, including Big Five, Needs, and Values, from digital communications such as email, text +messages, tweets, and forum posts. The service can automatically infer, from potentially noisy social media, portraits of individuals that reflect their personality characteristics. The service can infer consumption preferences based on the results of its analysis and, for JSON content that is timestamped, can report temporal behavior.

@@ -430,12 +427,12 @@

Declaration

service analyzes text in Arabic, English, Japanese, Korean, or Spanish and returns its results in a variety of languages. You can provide plain text, HTML, or JSON input by specifying the Content-Type parameter; the default is text/plain. Request a JSON or comma-separated values (CSV) response by specifying the Accept -parameter; CSV output includes a fixed number of columns and optional headers. Per the JSON specification, the -default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default -encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content -type of plain text or HTML, include the charset parameter to indicate the character encoding of the input text; -for example: Content-Type: text/plain;charset=utf-8. For detailed information about calling the service and the -responses it can generate, see Requesting a +parameter; CSV output includes a fixed number of columns and optional headers. +Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the +HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character +set). When specifying a content type of plain text or HTML, include the charset parameter to indicate the +character encoding of the input text; for example: Content-Type: text/plain;charset=utf-8. +For detailed information about calling the service and the responses it can generate, see Requesting a profile, Understanding a JSON profile, and Understanding a CSV profile.

@@ -470,8 +467,9 @@

Parameters

A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see -Providing sufficient input. -For JSON input, provide an object of type Content.

+Providing sufficient +input. For JSON input, +provide an object of type Content.

@@ -484,13 +482,13 @@

Parameters

The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish. Regional variants -are treated as their parent language; for example, en-US is interpreted as en. The effect of the -Content-Language parameter depends on the Content-Type parameter. When Content-Type is text/plain or -text/html, Content-Language is the only way to specify the language. When Content-Type is -application/json, Content-Language overrides a language specified with the language parameter of a -ContentItem object, and content items that specify a different language are ignored; omit this parameter to base -the language on the specification of the content items. You can specify any combination of languages for -Content-Language and Accept-Language.

+are treated as their parent language; for example, en-US is interpreted as en. +The effect of the Content-Language parameter depends on the Content-Type parameter. When Content-Type +is text/plain or text/html, Content-Language is the only way to specify the language. When +Content-Type is application/json, Content-Language overrides a language specified with the language +parameter of a ContentItem object, and content items that specify a different language are ignored; omit this +parameter to base the language on the specification of the content items. You can specify any combination of +languages for Content-Language and Accept-Language.

@@ -529,8 +527,8 @@

Parameters

-

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences are -returned.

+

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences +are returned.

@@ -597,12 +595,12 @@

Parameters

service analyzes text in Arabic, English, Japanese, Korean, or Spanish and returns its results in a variety of languages. You can provide plain text, HTML, or JSON input by specifying the Content-Type parameter; the default is text/plain. Request a JSON or comma-separated values (CSV) response by specifying the Accept -parameter; CSV output includes a fixed number of columns and optional headers. Per the JSON specification, the -default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default -encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content -type of plain text or HTML, include the charset parameter to indicate the character encoding of the input text; -for example: Content-Type: text/plain;charset=utf-8. For detailed information about calling the service and the -responses it can generate, see Requesting a +parameter; CSV output includes a fixed number of columns and optional headers. +Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the +HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character +set). When specifying a content type of plain text or HTML, include the charset parameter to indicate the +character encoding of the input text; for example: Content-Type: text/plain;charset=utf-8. +For detailed information about calling the service and the responses it can generate, see Requesting a profile, Understanding a JSON profile, and Understanding a CSV profile.

@@ -637,8 +635,9 @@

Parameters

A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see -Providing sufficient input. -For JSON input, provide an object of type Content.

+Providing sufficient +input. For JSON input, +provide an object of type Content.

@@ -651,13 +650,13 @@

Parameters

The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish. Regional variants -are treated as their parent language; for example, en-US is interpreted as en. The effect of the -Content-Language parameter depends on the Content-Type parameter. When Content-Type is text/plain or -text/html, Content-Language is the only way to specify the language. When Content-Type is -application/json, Content-Language overrides a language specified with the language parameter of a -ContentItem object, and content items that specify a different language are ignored; omit this parameter to base -the language on the specification of the content items. You can specify any combination of languages for -Content-Language and Accept-Language.

+are treated as their parent language; for example, en-US is interpreted as en. +The effect of the Content-Language parameter depends on the Content-Type parameter. When Content-Type +is text/plain or text/html, Content-Language is the only way to specify the language. When +Content-Type is application/json, Content-Language overrides a language specified with the language +parameter of a ContentItem object, and content items that specify a different language are ignored; omit this +parameter to base the language on the specification of the content items. You can specify any combination of +languages for Content-Language and Accept-Language.

@@ -696,8 +695,8 @@

Parameters

-

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences are -returned.

+

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences +are returned.

@@ -764,12 +763,12 @@

Parameters

service analyzes text in Arabic, English, Japanese, Korean, or Spanish and returns its results in a variety of languages. You can provide plain text, HTML, or JSON input by specifying the Content-Type parameter; the default is text/plain. Request a JSON or comma-separated values (CSV) response by specifying the Accept -parameter; CSV output includes a fixed number of columns and optional headers. Per the JSON specification, the -default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default -encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content -type of plain text or HTML, include the charset parameter to indicate the character encoding of the input text; -for example: Content-Type: text/plain;charset=utf-8. For detailed information about calling the service and the -responses it can generate, see Requesting a +parameter; CSV output includes a fixed number of columns and optional headers. +Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the +HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character +set). When specifying a content type of plain text or HTML, include the charset parameter to indicate the +character encoding of the input text; for example: Content-Type: text/plain;charset=utf-8. +For detailed information about calling the service and the responses it can generate, see Requesting a profile, Understanding a JSON profile, and Understanding a CSV profile.

@@ -804,8 +803,9 @@

Parameters

A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see -Providing sufficient input. -For JSON input, provide an object of type Content.

+Providing sufficient +input. For JSON input, +provide an object of type Content.

@@ -818,13 +818,13 @@

Parameters

The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish. Regional variants -are treated as their parent language; for example, en-US is interpreted as en. The effect of the -Content-Language parameter depends on the Content-Type parameter. When Content-Type is text/plain or -text/html, Content-Language is the only way to specify the language. When Content-Type is -application/json, Content-Language overrides a language specified with the language parameter of a -ContentItem object, and content items that specify a different language are ignored; omit this parameter to base -the language on the specification of the content items. You can specify any combination of languages for -Content-Language and Accept-Language.

+are treated as their parent language; for example, en-US is interpreted as en. +The effect of the Content-Language parameter depends on the Content-Type parameter. When Content-Type +is text/plain or text/html, Content-Language is the only way to specify the language. When +Content-Type is application/json, Content-Language overrides a language specified with the language +parameter of a ContentItem object, and content items that specify a different language are ignored; omit this +parameter to base the language on the specification of the content items. You can specify any combination of +languages for Content-Language and Accept-Language.

@@ -863,8 +863,8 @@

Parameters

-

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences are -returned.

+

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences +are returned.

@@ -923,7 +923,7 @@

Parameters

-

Get profile. as csv

+

Get profile as csv.

Generates a personality profile for the author of the input text. The service accepts a maximum of 20 MB of input content, but it requires much less text to produce an accurate profile; for more information, see Providing @@ -931,12 +931,12 @@

Parameters

service analyzes text in Arabic, English, Japanese, Korean, or Spanish and returns its results in a variety of languages. You can provide plain text, HTML, or JSON input by specifying the Content-Type parameter; the default is text/plain. Request a JSON or comma-separated values (CSV) response by specifying the Accept -parameter; CSV output includes a fixed number of columns and optional headers. Per the JSON specification, the -default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default -encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content -type of plain text or HTML, include the charset parameter to indicate the character encoding of the input text; -for example: Content-Type: text/plain;charset=utf-8. For detailed information about calling the service and the -responses it can generate, see Requesting a +parameter; CSV output includes a fixed number of columns and optional headers. +Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the +HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character +set). When specifying a content type of plain text or HTML, include the charset parameter to indicate the +character encoding of the input text; for example: Content-Type: text/plain;charset=utf-8. +For detailed information about calling the service and the responses it can generate, see Requesting a profile, Understanding a JSON profile, and Understanding a CSV profile.

@@ -972,8 +972,9 @@

Parameters

A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see -Providing sufficient input. -For JSON input, provide an object of type Content.

+Providing sufficient +input. For JSON input, +provide an object of type Content.

@@ -986,13 +987,13 @@

Parameters

The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish. Regional variants -are treated as their parent language; for example, en-US is interpreted as en. The effect of the -Content-Language parameter depends on the Content-Type parameter. When Content-Type is text/plain or -text/html, Content-Language is the only way to specify the language. When Content-Type is -application/json, Content-Language overrides a language specified with the language parameter of a -ContentItem object, and content items that specify a different language are ignored; omit this parameter to base -the language on the specification of the content items. You can specify any combination of languages for -Content-Language and Accept-Language.

+are treated as their parent language; for example, en-US is interpreted as en. +The effect of the Content-Language parameter depends on the Content-Type parameter. When Content-Type +is text/plain or text/html, Content-Language is the only way to specify the language. When +Content-Type is application/json, Content-Language overrides a language specified with the language +parameter of a ContentItem object, and content items that specify a different language are ignored; omit this +parameter to base the language on the specification of the content items. You can specify any combination of +languages for Content-Language and Accept-Language.

@@ -1044,8 +1045,8 @@

Parameters

-

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences are -returned.

+

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences +are returned.

@@ -1104,7 +1105,7 @@

Parameters

-

Get profile. as csv

+

Get profile as csv.

Generates a personality profile for the author of the input text. The service accepts a maximum of 20 MB of input content, but it requires much less text to produce an accurate profile; for more information, see Providing @@ -1112,12 +1113,12 @@

Parameters

service analyzes text in Arabic, English, Japanese, Korean, or Spanish and returns its results in a variety of languages. You can provide plain text, HTML, or JSON input by specifying the Content-Type parameter; the default is text/plain. Request a JSON or comma-separated values (CSV) response by specifying the Accept -parameter; CSV output includes a fixed number of columns and optional headers. Per the JSON specification, the -default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default -encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content -type of plain text or HTML, include the charset parameter to indicate the character encoding of the input text; -for example: Content-Type: text/plain;charset=utf-8. For detailed information about calling the service and the -responses it can generate, see Requesting a +parameter; CSV output includes a fixed number of columns and optional headers. +Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the +HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character +set). When specifying a content type of plain text or HTML, include the charset parameter to indicate the +character encoding of the input text; for example: Content-Type: text/plain;charset=utf-8. +For detailed information about calling the service and the responses it can generate, see Requesting a profile, Understanding a JSON profile, and Understanding a CSV profile.

@@ -1153,8 +1154,9 @@

Parameters

A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see -Providing sufficient input. -For JSON input, provide an object of type Content.

+Providing sufficient +input. For JSON input, +provide an object of type Content.

@@ -1167,13 +1169,13 @@

Parameters

The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish. Regional variants -are treated as their parent language; for example, en-US is interpreted as en. The effect of the -Content-Language parameter depends on the Content-Type parameter. When Content-Type is text/plain or -text/html, Content-Language is the only way to specify the language. When Content-Type is -application/json, Content-Language overrides a language specified with the language parameter of a -ContentItem object, and content items that specify a different language are ignored; omit this parameter to base -the language on the specification of the content items. You can specify any combination of languages for -Content-Language and Accept-Language.

+are treated as their parent language; for example, en-US is interpreted as en. +The effect of the Content-Language parameter depends on the Content-Type parameter. When Content-Type +is text/plain or text/html, Content-Language is the only way to specify the language. When +Content-Type is application/json, Content-Language overrides a language specified with the language +parameter of a ContentItem object, and content items that specify a different language are ignored; omit this +parameter to base the language on the specification of the content items. You can specify any combination of +languages for Content-Language and Accept-Language.

@@ -1225,8 +1227,8 @@

Parameters

-

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences are -returned.

+

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences +are returned.

@@ -1285,7 +1287,7 @@

Parameters

-

Get profile. as csv

+

Get profile as csv.

Generates a personality profile for the author of the input text. The service accepts a maximum of 20 MB of input content, but it requires much less text to produce an accurate profile; for more information, see Providing @@ -1293,12 +1295,12 @@

Parameters

service analyzes text in Arabic, English, Japanese, Korean, or Spanish and returns its results in a variety of languages. You can provide plain text, HTML, or JSON input by specifying the Content-Type parameter; the default is text/plain. Request a JSON or comma-separated values (CSV) response by specifying the Accept -parameter; CSV output includes a fixed number of columns and optional headers. Per the JSON specification, the -default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default -encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content -type of plain text or HTML, include the charset parameter to indicate the character encoding of the input text; -for example: Content-Type: text/plain;charset=utf-8. For detailed information about calling the service and the -responses it can generate, see Requesting a +parameter; CSV output includes a fixed number of columns and optional headers. +Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the +HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character +set). When specifying a content type of plain text or HTML, include the charset parameter to indicate the +character encoding of the input text; for example: Content-Type: text/plain;charset=utf-8. +For detailed information about calling the service and the responses it can generate, see Requesting a profile, Understanding a JSON profile, and Understanding a CSV profile.

@@ -1334,8 +1336,9 @@

Parameters

A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see -Providing sufficient input. -For JSON input, provide an object of type Content.

+Providing sufficient +input. For JSON input, +provide an object of type Content.

@@ -1348,13 +1351,13 @@

Parameters

The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish. Regional variants -are treated as their parent language; for example, en-US is interpreted as en. The effect of the -Content-Language parameter depends on the Content-Type parameter. When Content-Type is text/plain or -text/html, Content-Language is the only way to specify the language. When Content-Type is -application/json, Content-Language overrides a language specified with the language parameter of a -ContentItem object, and content items that specify a different language are ignored; omit this parameter to base -the language on the specification of the content items. You can specify any combination of languages for -Content-Language and Accept-Language.

+are treated as their parent language; for example, en-US is interpreted as en. +The effect of the Content-Language parameter depends on the Content-Type parameter. When Content-Type +is text/plain or text/html, Content-Language is the only way to specify the language. When +Content-Type is application/json, Content-Language overrides a language specified with the language +parameter of a ContentItem object, and content items that specify a different language are ignored; omit this +parameter to base the language on the specification of the content items. You can specify any combination of +languages for Content-Language and Accept-Language.

@@ -1406,8 +1409,8 @@

Parameters

-

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences are -returned.

+

Indicates whether consumption preferences are returned with the results. By default, no consumption preferences +are returned.

@@ -1458,7 +1461,7 @@

Parameters

diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Enums.html b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Enums.html index 60657ec9c..35a33d944 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Enums.html +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Enums.html @@ -71,9 +71,6 @@ - @@ -171,7 +168,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html index 752eb44d0..2974b5686 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html @@ -71,9 +71,6 @@ - @@ -441,7 +438,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html index 6d74dc86b..7f62ad014 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html @@ -71,9 +71,6 @@ - @@ -308,7 +305,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs.html b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs.html index 4ea01761b..e3b90275f 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs.html +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs.html @@ -71,9 +71,6 @@ - @@ -360,49 +357,10 @@

Declaration

-
-
- - - -

JSON

-
-
-
    -
  • -
    - - - - JSONWrapper - -
    -
    -
    -
    -
    -
    -

    Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct JSONWrapper
    - -
    -
    -
    -
    -
  • -
-
diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Behavior.html b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Behavior.html index 8d3573e10..ada73ada6 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Behavior.html +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Behavior.html @@ -71,9 +71,6 @@ - @@ -125,7 +122,8 @@

Behavior

-

The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form behavior_{value}.

+

The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form +behavior_{value}.

@@ -206,7 +204,8 @@

Declaration

-

For JSON content that is timestamped, the percentage of timestamped input data that occurred during that day of the week or hour of the day. The range is 0 to 1.

+

For JSON content that is timestamped, the percentage of timestamped input data that occurred during that day of the +week or hour of the day. The range is 0 to 1.

@@ -225,7 +224,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/ConsumptionPreferences.html b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/ConsumptionPreferences.html index f7a85a063..568d58084 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/ConsumptionPreferences.html +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/ConsumptionPreferences.html @@ -71,9 +71,6 @@ - @@ -125,7 +122,8 @@

ConsumptionPreferences

-

The unique, non-localized identifier of the consumption preference to which the results pertain. IDs have the form consumption_preferences_{preference}.

+

The unique, non-localized identifier of the consumption preference to which the results pertain. IDs have the form +consumption_preferences_{preference}.

@@ -179,7 +177,15 @@

Declaration

-

The score for the consumption preference: * 0.0: Unlikely * 0.5: Neutral * 1.0: Likely The scores for some preferences are binary and do not allow a neutral value. The score is an indication of preference based on the results inferred from the input text, not a normalized percentile.

+

The score for the consumption preference:

+ +
    +
  • 0.0: Unlikely
  • +
  • 0.5: Neutral
  • +
  • 1.0: Likely +The scores for some preferences are binary and do not allow a neutral value. The score is an indication of +preference based on the results inferred from the input text, not a normalized percentile.
  • +
@@ -198,7 +204,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/ConsumptionPreferencesCategory.html b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/ConsumptionPreferencesCategory.html index 8762333f5..c85603bf1 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/ConsumptionPreferencesCategory.html +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/ConsumptionPreferencesCategory.html @@ -71,9 +71,6 @@ - @@ -125,7 +122,8 @@

ConsumptionPreferencesCategory

-

The unique, non-localized identifier of the consumption preferences category to which the results pertain. IDs have the form consumption_preferences_{category}.

+

The unique, non-localized identifier of the consumption preferences category to which the results pertain. IDs have +the form consumption_preferences_{category}.

@@ -198,7 +196,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Content.html b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Content.html index a5953da99..6f15246b1 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Content.html +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Content.html @@ -71,9 +71,6 @@ - @@ -159,7 +156,9 @@

Declaration

Declaration

Swift

-
public init(contentItems: [ContentItem])
+
public init(
+    contentItems: [ContentItem]
+)
@@ -194,7 +193,7 @@

Return Value

diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/ContentItem.html b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/ContentItem.html index f8d72c2d0..b18eec64a 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/ContentItem.html +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/ContentItem.html @@ -71,9 +71,6 @@ - @@ -125,7 +122,8 @@

ContentItem

-

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is analyzed; plain text is processed as submitted.

+

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is +analyzed; plain text is processed as submitted.

See more
@@ -153,7 +151,12 @@

Declaration

-

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en (English). Regional variants are treated as their parent language; for example, en-US is interpreted as en. A language specified with the Content-Type parameter overrides the value of this parameter; any content items that specify a different language are ignored. Omit the Content-Type parameter to base the language on the most prevalent specification among the content items; again, content items that specify a different language are ignored. You can specify any combination of languages for the input and response content.

+

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en +(English). Regional variants are treated as their parent language; for example, en-US is interpreted as en. A +language specified with the Content-Type parameter overrides the value of this parameter; any content items +that specify a different language are ignored. Omit the Content-Type parameter to base the language on the most +prevalent specification among the content items; again, content items that specify a different language are +ignored. You can specify any combination of languages for the input and response content.

See more
@@ -181,7 +184,8 @@

Declaration

-

The content that is to be analyzed. The service supports up to 20 MB of content for all ContentItem objects combined.

+

The content that is to be analyzed. The service supports up to 20 MB of content for all ContentItem objects +combined.

@@ -235,7 +239,8 @@

Declaration

-

A timestamp that identifies when this content was created. Specify a value in milliseconds since the UNIX Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.

+

A timestamp that identifies when this content was created. Specify a value in milliseconds since the UNIX Epoch +(January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.

@@ -262,7 +267,8 @@

Declaration

-

A timestamp that identifies when this content was last updated. Specify a value in milliseconds since the UNIX Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.

+

A timestamp that identifies when this content was last updated. Specify a value in milliseconds since the UNIX +Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.

@@ -289,7 +295,8 @@

Declaration

-

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is analyzed; plain text is processed as submitted.

+

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is +analyzed; plain text is processed as submitted.

@@ -316,7 +323,12 @@

Declaration

-

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en (English). Regional variants are treated as their parent language; for example, en-US is interpreted as en. A language specified with the Content-Type parameter overrides the value of this parameter; any content items that specify a different language are ignored. Omit the Content-Type parameter to base the language on the most prevalent specification among the content items; again, content items that specify a different language are ignored. You can specify any combination of languages for the input and response content.

+

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en +(English). Regional variants are treated as their parent language; for example, en-US is interpreted as en. A +language specified with the Content-Type parameter overrides the value of this parameter; any content items +that specify a different language are ignored. Omit the Content-Type parameter to base the language on the most +prevalent specification among the content items; again, content items that specify a different language are +ignored. You can specify any combination of languages for the input and response content.

@@ -343,7 +355,8 @@

Declaration

-

The unique ID of the parent content item for this item. Used to identify hierarchical relationships between posts/replies, messages/replies, and so on.

+

The unique ID of the parent content item for this item. Used to identify hierarchical relationships between +posts/replies, messages/replies, and so on.

@@ -431,7 +444,17 @@

Declaration

Declaration

Swift

-
public init(content: String, id: String? = nil, created: Int? = nil, updated: Int? = nil, contenttype: String? = nil, language: String? = nil, parentid: String? = nil, reply: Bool? = nil, forward: Bool? = nil)
+
public init(
+    content: String,
+    id: String? = nil,
+    created: Int? = nil,
+    updated: Int? = nil,
+    contenttype: String? = nil,
+    language: String? = nil,
+    parentid: String? = nil,
+    reply: Bool? = nil,
+    forward: Bool? = nil
+)
@@ -447,7 +470,8 @@

Parameters

-

The content that is to be analyzed. The service supports up to 20 MB of content for all ContentItem objects combined.

+

The content that is to be analyzed. The service supports up to 20 MB of content for all ContentItem objects +combined.

@@ -471,7 +495,8 @@

Parameters

-

A timestamp that identifies when this content was created. Specify a value in milliseconds since the UNIX Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.

+

A timestamp that identifies when this content was created. Specify a value in milliseconds since the UNIX Epoch +(January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.

@@ -483,7 +508,8 @@

Parameters

-

A timestamp that identifies when this content was last updated. Specify a value in milliseconds since the UNIX Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.

+

A timestamp that identifies when this content was last updated. Specify a value in milliseconds since the UNIX +Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.

@@ -495,7 +521,8 @@

Parameters

-

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is analyzed; plain text is processed as submitted.

+

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is +analyzed; plain text is processed as submitted.

@@ -507,7 +534,12 @@

Parameters

-

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en (English). Regional variants are treated as their parent language; for example, en-US is interpreted as en. A language specified with the Content-Type parameter overrides the value of this parameter; any content items that specify a different language are ignored. Omit the Content-Type parameter to base the language on the most prevalent specification among the content items; again, content items that specify a different language are ignored. You can specify any combination of languages for the input and response content.

+

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is +en (English). Regional variants are treated as their parent language; for example, en-US is interpreted as +en. A language specified with the Content-Type parameter overrides the value of this parameter; any content +items that specify a different language are ignored. Omit the Content-Type parameter to base the language on +the most prevalent specification among the content items; again, content items that specify a different language +are ignored. You can specify any combination of languages for the input and response content.

@@ -519,7 +551,8 @@

Parameters

-

The unique ID of the parent content item for this item. Used to identify hierarchical relationships between posts/replies, messages/replies, and so on.

+

The unique ID of the parent content item for this item. Used to identify hierarchical relationships between +posts/replies, messages/replies, and so on.

@@ -562,7 +595,7 @@

Return Value

diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/ContentItem/Contenttype.html b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/ContentItem/Contenttype.html index eee98d7f3..b3fbe7062 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/ContentItem/Contenttype.html +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/ContentItem/Contenttype.html @@ -71,9 +71,6 @@ - @@ -106,7 +103,8 @@

Contenttype

-

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is analyzed; plain text is processed as submitted.

+

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is +analyzed; plain text is processed as submitted.

@@ -171,7 +169,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/ContentItem/Language.html b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/ContentItem/Language.html index 37e9f17de..698aba027 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/ContentItem/Language.html +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/ContentItem/Language.html @@ -71,9 +71,6 @@ - @@ -106,7 +103,12 @@

Language

-

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en (English). Regional variants are treated as their parent language; for example, en-US is interpreted as en. A language specified with the Content-Type parameter overrides the value of this parameter; any content items that specify a different language are ignored. Omit the Content-Type parameter to base the language on the most prevalent specification among the content items; again, content items that specify a different language are ignored. You can specify any combination of languages for the input and response content.

+

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en +(English). Regional variants are treated as their parent language; for example, en-US is interpreted as en. A +language specified with the Content-Type parameter overrides the value of this parameter; any content items +that specify a different language are ignored. Omit the Content-Type parameter to base the language on the most +prevalent specification among the content items; again, content items that specify a different language are +ignored. You can specify any combination of languages for the input and response content.

@@ -252,7 +254,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Profile.html b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Profile.html index 39482d952..8d7268e42 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Profile.html +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Profile.html @@ -71,9 +71,6 @@ - @@ -207,7 +204,8 @@

Declaration

-

When guidance is appropriate, a string that provides a message that indicates the number of words found and where that value falls in the range of required or suggested number of words.

+

When guidance is appropriate, a string that provides a message that indicates the number of words found and where +that value falls in the range of required or suggested number of words.

@@ -234,7 +232,8 @@

Declaration

-

A recursive array of Trait objects that provides detailed results for the Big Five personality characteristics (dimensions and facets) inferred from the input text.

+

A recursive array of Trait objects that provides detailed results for the Big Five personality characteristics +(dimensions and facets) inferred from the input text.

@@ -315,7 +314,9 @@

Declaration

-

For JSON content that is timestamped, detailed results about the social behavior disclosed by the input in terms of temporal characteristics. The results include information about the distribution of the content over the days of the week and the hours of the day.

+

For JSON content that is timestamped, detailed results about the social behavior disclosed by the input in terms of +temporal characteristics. The results include information about the distribution of the content over the days of +the week and the hours of the day.

@@ -342,7 +343,9 @@

Declaration

-

If the consumption_preferences parameter is true, detailed results for each category of consumption preferences. Each element of the array provides information inferred from the input text for the individual preferences of that category.

+

If the consumption_preferences parameter is true, detailed results for each category of consumption +preferences. Each element of the array provides information inferred from the input text for the individual +preferences of that category.

@@ -369,7 +372,8 @@

Declaration

-

Warning messages associated with the input text submitted with the request. The array is empty if the input generated no warnings.

+

Warning messages associated with the input text submitted with the request. The array is empty if the input +generated no warnings.

@@ -388,7 +392,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Profile/ProcessedLanguage.html b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Profile/ProcessedLanguage.html index dedbcee08..df626cad1 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Profile/ProcessedLanguage.html +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Profile/ProcessedLanguage.html @@ -71,9 +71,6 @@ - @@ -252,7 +249,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Trait.html b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Trait.html index a6d91e440..3842a1cfe 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Trait.html +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Trait.html @@ -71,9 +71,6 @@ - @@ -125,7 +122,8 @@

Trait

-

The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and values for Values.

+

The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and +values for Values.

See more
@@ -153,7 +151,14 @@

Declaration

-

The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form * big5_{characteristic} for Big Five personality dimensions * facet_{characteristic} for Big Five personality facets * need_{characteristic} for Needs *value_{characteristic} for Values.

+

The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form

+ +
    +
  • big5_{characteristic} for Big Five personality dimensions
  • +
  • facet_{characteristic} for Big Five personality facets
  • +
  • need_{characteristic} for Needs +*value_{characteristic} for Values.
  • +
@@ -207,7 +212,8 @@

Declaration

-

The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and values for Values.

+

The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and +values for Values.

@@ -234,7 +240,9 @@

Declaration

-

The normalized percentile score for the characteristic. The range is 0 to 1. For example, if the percentage for Openness is 0.60, the author scored in the 60th percentile; the author is more open than 59 percent of the population and less open than 39 percent of the population.

+

The normalized percentile score for the characteristic. The range is 0 to 1. For example, if the percentage for +Openness is 0.60, the author scored in the 60th percentile; the author is more open than 59 percent of the +population and less open than 39 percent of the population.

@@ -261,7 +269,13 @@

Declaration

-

The raw score for the characteristic. The range is 0 to 1. A higher score generally indicates a greater likelihood that the author has that characteristic, but raw scores must be considered in aggregate: The range of values in practice might be much smaller than 0 to 1, so an individual score must be considered in the context of the overall scores and their range. The raw score is computed based on the input and the service model; it is not normalized or compared with a sample population. The raw score enables comparison of the results against a different sampling population and with a custom normalization approach.

+

The raw score for the characteristic. The range is 0 to 1. A higher score generally indicates a greater likelihood +that the author has that characteristic, but raw scores must be considered in aggregate: The range of values in +practice might be much smaller than 0 to 1, so an individual score must be considered in the context of the overall +scores and their range. +The raw score is computed based on the input and the service model; it is not normalized or compared with a sample +population. The raw score enables comparison of the results against a different sampling population and with a +custom normalization approach.

@@ -288,7 +302,10 @@

Declaration

-

2017-10-13: Indicates whether the characteristic is meaningful for the input language. The field is always true for all characteristics of English, Spanish, and Japanese input. The field is false for the subset of characteristics of Arabic and Korean input for which the service’s models are unable to generate meaningful results. **2016-10-19: Not returned.

+

2017-10-13: Indicates whether the characteristic is meaningful for the input language. The field is always +true for all characteristics of English, Spanish, and Japanese input. The field is false for the subset of +characteristics of Arabic and Korean input for which the service’s models are unable to generate meaningful +results. 2016-10-19: Not returned.

@@ -315,7 +332,8 @@

Declaration

-

For personality (Big Five) dimensions, more detailed results for the facets of each dimension as inferred from the input text.

+

For personality (Big Five) dimensions, more detailed results for the facets of each dimension as inferred from +the input text.

@@ -334,7 +352,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Trait/Category.html b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Trait/Category.html index 701fe8128..7533b605d 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Trait/Category.html +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Trait/Category.html @@ -71,9 +71,6 @@ - @@ -106,7 +103,8 @@

Category

-

The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and values for Values.

+

The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and +values for Values.

@@ -198,7 +196,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Warning.html b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Warning.html index d62fc5dd2..6fccaaa73 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Warning.html +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Warning.html @@ -71,9 +71,6 @@ - @@ -180,7 +177,20 @@

Declaration

-

The message associated with the warning_id: * WORD_COUNT_MESSAGE: There were {number} words in the input. We need a minimum of 600, preferably 1,200 or more, to compute statistically significant estimates. * JSON_AS_TEXT: Request input was processed as text/plain as indicated, however detected a JSON input. Did you mean application/json? * CONTENT_TRUNCATED: For maximum accuracy while also optimizing processing time, only the first 250KB of input text (excluding markup) was analyzed. Accuracy levels off at approximately 3,000 words so this did not affect the accuracy of the profile. * PARTIAL_TEXT_USED, The text provided to compute the profile was trimmed for performance reasons. This action does not affect the accuracy of the output, as not all of the input text was required. Applies only when Arabic input text exceeds a threshold at which additional words do not contribute to the accuracy of the profile.

+

The message associated with the warning_id:

+ +
    +
  • WORD_COUNT_MESSAGE: There were {number} words in the input. We need a minimum of 600, preferably 1,200 or +more, to compute statistically significant estimates.
  • +
  • JSON_AS_TEXT: Request input was processed as text/plain as indicated, however detected a JSON input. Did you +mean application/json?
  • +
  • CONTENT_TRUNCATED: For maximum accuracy while also optimizing processing time, only the first 250KB of input +text (excluding markup) was analyzed. Accuracy levels off at approximately 3,000 words so this did not affect the +accuracy of the profile.
  • +
  • PARTIAL_TEXT_USED, The text provided to compute the profile was trimmed for performance reasons. This action +does not affect the accuracy of the output, as not all of the input text was required. Applies only when Arabic +input text exceeds a threshold at which additional words do not contribute to the accuracy of the profile.
  • +
@@ -199,7 +209,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Warning/WarningID.html b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Warning/WarningID.html index a089d81ad..6a32d84ef 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Warning/WarningID.html +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/Structs/Warning/WarningID.html @@ -71,9 +71,6 @@ - @@ -225,7 +222,7 @@

Declaration

diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/index.html b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/index.html index 10b522401..2f05ea7cc 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/index.html +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/index.html @@ -70,9 +70,6 @@ - @@ -139,7 +136,8 @@

Services

  • Assistant
  • Discovery
  • -
  • Language Translator
  • +
  • Language Translator V2
  • +
  • Language Translator V3
  • Natural Language Classifier
  • Natural Language Understanding
  • Personality Insights
  • @@ -184,7 +182,7 @@

    Swift Package Manager

    Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

    dependencies: [
    -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
    +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
     ]
     

    Service Instances

    @@ -227,7 +225,7 @@

    Username and Password

    API Key

    -

    Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

    +

    Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

    let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
     

    Using IAM

    @@ -462,7 +460,12 @@

    Private Data Collections

  • IBM Discovery - Documentation
  • IBM Discovery - Demo
-

Language Translator

+

Language Translator V2

+ +

Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

@@ -473,6 +476,25 @@

Language Translator

let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} + +

Language Translator V3

+ +

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

+ +

The following example demonstrates how to use the Language Translator service:

+
import LanguageTranslatorV3
+
+let username = "your-username-here"
+let password = "your-password-here"
+let version = "yyyy-mm-dd" // use today's date for the most recent version
+let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
+
 let failure = { (error: Error) in print(error) }
 let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
 languageTranslator.translate(request: request, failure: failure) {
@@ -863,7 +885,7 @@ 

Visual Recognition

let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -871,6 +893,10 @@

Visual Recognition

print(classifiedImages) }
+ +

Note: a different initializer is used for authentication with instances created before May 23, 2018:

+
let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
+

Using Core ML

The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

@@ -922,7 +948,7 @@

Bundlin

diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/search.json b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/search.json index 7e6bc442b..7e1c61981 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/search.json +++ b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/Documents/search.json @@ -1 +1 @@ -{"Structs/Warning/WarningID.html#/s:21PersonalityInsightsV37WarningV0D2IDO16wordCountMessageA2EmF":{"name":"wordCountMessage","abstract":"

Undocumented

","parent_name":"WarningID"},"Structs/Warning/WarningID.html#/s:21PersonalityInsightsV37WarningV0D2IDO10jsonAsTextA2EmF":{"name":"jsonAsText","abstract":"

Undocumented

","parent_name":"WarningID"},"Structs/Warning/WarningID.html#/s:21PersonalityInsightsV37WarningV0D2IDO16contentTruncatedA2EmF":{"name":"contentTruncated","abstract":"

Undocumented

","parent_name":"WarningID"},"Structs/Warning/WarningID.html#/s:21PersonalityInsightsV37WarningV0D2IDO15partialTextUsedA2EmF":{"name":"partialTextUsed","abstract":"

Undocumented

","parent_name":"WarningID"},"Structs/Warning/WarningID.html":{"name":"WarningID","abstract":"

The identifier of the warning message.

","parent_name":"Warning"},"Structs/Warning.html#/s:21PersonalityInsightsV37WarningV9warningIDSSvp":{"name":"warningID","abstract":"

The identifier of the warning message.

","parent_name":"Warning"},"Structs/Warning.html#/s:21PersonalityInsightsV37WarningV7messageSSvp":{"name":"message","abstract":"

The message associated with the warning_id: * WORD_COUNT_MESSAGE: There were {number} words in the input. We need a minimum of 600, preferably 1,200 or more, to compute statistically significant estimates. * JSON_AS_TEXT: Request input was processed as text/plain as indicated, however detected a JSON input. Did you mean application/json? * CONTENT_TRUNCATED: For maximum accuracy while also optimizing processing time, only the first 250KB of input text (excluding markup) was analyzed. Accuracy levels off at approximately 3,000 words so this did not affect the accuracy of the profile. * PARTIAL_TEXT_USED, The text provided to compute the profile was trimmed for performance reasons. This action does not affect the accuracy of the output, as not all of the input text was required. Applies only when Arabic input text exceeds a threshold at which additional words do not contribute to the accuracy of the profile.

","parent_name":"Warning"},"Structs/Trait/Category.html#/s:21PersonalityInsightsV35TraitV8CategoryO11personalityA2EmF":{"name":"personality","abstract":"

Undocumented

","parent_name":"Category"},"Structs/Trait/Category.html#/s:21PersonalityInsightsV35TraitV8CategoryO5needsA2EmF":{"name":"needs","abstract":"

Undocumented

","parent_name":"Category"},"Structs/Trait/Category.html#/s:21PersonalityInsightsV35TraitV8CategoryO6valuesA2EmF":{"name":"values","abstract":"

Undocumented

","parent_name":"Category"},"Structs/Trait/Category.html":{"name":"Category","abstract":"

The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and values for Values.

","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV7traitIDSSvp":{"name":"traitID","abstract":"

The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form * big5_{characteristic} for Big Five personality dimensions * facet_{characteristic} for Big Five personality facets * need_{characteristic} for Needs *value_{characteristic} for Values.

","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV4nameSSvp":{"name":"name","abstract":"

The user-visible, localized name of the characteristic.

","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV8categorySSvp":{"name":"category","abstract":"

The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and values for Values.

","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV10percentileSdvp":{"name":"percentile","abstract":"

The normalized percentile score for the characteristic. The range is 0 to 1. For example, if the percentage for Openness is 0.60, the author scored in the 60th percentile; the author is more open than 59 percent of the population and less open than 39 percent of the population.

","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV8rawScoreSdSgvp":{"name":"rawScore","abstract":"

The raw score for the characteristic. The range is 0 to 1. A higher score generally indicates a greater likelihood that the author has that characteristic, but raw scores must be considered in aggregate: The range of values in practice might be much smaller than 0 to 1, so an individual score must be considered in the context of the overall scores and their range. The raw score is computed based on the input and the service model; it is not normalized or compared with a sample population. The raw score enables comparison of the results against a different sampling population and with a custom normalization approach.

","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV11significantSbSgvp":{"name":"significant","abstract":"

2017-10-13: Indicates whether the characteristic is meaningful for the input language. The field is always true for all characteristics of English, Spanish, and Japanese input. The field is false for the subset of characteristics of Arabic and Korean input for which the service’s models are unable to generate meaningful results. **2016-10-19: Not returned.

","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV8childrenSayACGSgvp":{"name":"children","abstract":"

For personality (Big Five) dimensions, more detailed results for the facets of each dimension as inferred from the input text.

","parent_name":"Trait"},"Structs/Profile/ProcessedLanguage.html#/s:21PersonalityInsightsV37ProfileV17ProcessedLanguageO2arA2EmF":{"name":"ar","abstract":"

Undocumented

","parent_name":"ProcessedLanguage"},"Structs/Profile/ProcessedLanguage.html#/s:21PersonalityInsightsV37ProfileV17ProcessedLanguageO2enA2EmF":{"name":"en","abstract":"

Undocumented

","parent_name":"ProcessedLanguage"},"Structs/Profile/ProcessedLanguage.html#/s:21PersonalityInsightsV37ProfileV17ProcessedLanguageO2esA2EmF":{"name":"es","abstract":"

Undocumented

","parent_name":"ProcessedLanguage"},"Structs/Profile/ProcessedLanguage.html#/s:21PersonalityInsightsV37ProfileV17ProcessedLanguageO2jaA2EmF":{"name":"ja","abstract":"

Undocumented

","parent_name":"ProcessedLanguage"},"Structs/Profile/ProcessedLanguage.html#/s:21PersonalityInsightsV37ProfileV17ProcessedLanguageO2koA2EmF":{"name":"ko","abstract":"

Undocumented

","parent_name":"ProcessedLanguage"},"Structs/Profile/ProcessedLanguage.html":{"name":"ProcessedLanguage","abstract":"

The language model that was used to process the input.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV17processedLanguageSSvp":{"name":"processedLanguage","abstract":"

The language model that was used to process the input.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV9wordCountSivp":{"name":"wordCount","abstract":"

The number of words from the input that were used to produce the profile.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV16wordCountMessageSSSgvp":{"name":"wordCountMessage","abstract":"

When guidance is appropriate, a string that provides a message that indicates the number of words found and where that value falls in the range of required or suggested number of words.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV11personalitySayAA5TraitVGvp":{"name":"personality","abstract":"

A recursive array of Trait objects that provides detailed results for the Big Five personality characteristics (dimensions and facets) inferred from the input text.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV5needsSayAA5TraitVGvp":{"name":"needs","abstract":"

Detailed results for the Needs characteristics inferred from the input text.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV6valuesSayAA5TraitVGvp":{"name":"values","abstract":"

Detailed results for the Values characteristics inferred from the input text.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV8behaviorSayAA8BehaviorVGSgvp":{"name":"behavior","abstract":"

For JSON content that is timestamped, detailed results about the social behavior disclosed by the input in terms of temporal characteristics. The results include information about the distribution of the content over the days of the week and the hours of the day.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV22consumptionPreferencesSayAA011ConsumptionF8CategoryVGSgvp":{"name":"consumptionPreferences","abstract":"

If the consumption_preferences parameter is true, detailed results for each category of consumption preferences. Each element of the array provides information inferred from the input text for the individual preferences of that category.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV8warningsSayAA7WarningVGvp":{"name":"warnings","abstract":"

Warning messages associated with the input text submitted with the request. The array is empty if the input generated no warnings.

","parent_name":"Profile"},"Structs/ContentItem/Language.html#/s:21PersonalityInsightsV311ContentItemV8LanguageO2arA2EmF":{"name":"ar","abstract":"

Undocumented

","parent_name":"Language"},"Structs/ContentItem/Language.html#/s:21PersonalityInsightsV311ContentItemV8LanguageO2enA2EmF":{"name":"en","abstract":"

Undocumented

","parent_name":"Language"},"Structs/ContentItem/Language.html#/s:21PersonalityInsightsV311ContentItemV8LanguageO2esA2EmF":{"name":"es","abstract":"

Undocumented

","parent_name":"Language"},"Structs/ContentItem/Language.html#/s:21PersonalityInsightsV311ContentItemV8LanguageO2jaA2EmF":{"name":"ja","abstract":"

Undocumented

","parent_name":"Language"},"Structs/ContentItem/Language.html#/s:21PersonalityInsightsV311ContentItemV8LanguageO2koA2EmF":{"name":"ko","abstract":"

Undocumented

","parent_name":"Language"},"Structs/ContentItem/Contenttype.html#/s:21PersonalityInsightsV311ContentItemV11ContenttypeO5plainA2EmF":{"name":"plain","abstract":"

Undocumented

","parent_name":"Contenttype"},"Structs/ContentItem/Contenttype.html#/s:21PersonalityInsightsV311ContentItemV11ContenttypeO4htmlA2EmF":{"name":"html","abstract":"

Undocumented

","parent_name":"Contenttype"},"Structs/ContentItem/Contenttype.html":{"name":"Contenttype","abstract":"

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is analyzed; plain text is processed as submitted.

","parent_name":"ContentItem"},"Structs/ContentItem/Language.html":{"name":"Language","abstract":"

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en (English). Regional variants are treated as their parent language; for example, en-US is interpreted as en. A language specified with the Content-Type parameter overrides the value of this parameter; any content items that specify a different language are ignored. Omit the Content-Type parameter to base the language on the most prevalent specification among the content items; again, content items that specify a different language are ignored. You can specify any combination of languages for the input and response content.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV7contentSSvp":{"name":"content","abstract":"

The content that is to be analyzed. The service supports up to 20 MB of content for all ContentItem objects combined.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV2idSSSgvp":{"name":"id","abstract":"

A unique identifier for this content item.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV7createdSiSgvp":{"name":"created","abstract":"

A timestamp that identifies when this content was created. Specify a value in milliseconds since the UNIX Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV7updatedSiSgvp":{"name":"updated","abstract":"

A timestamp that identifies when this content was last updated. Specify a value in milliseconds since the UNIX Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV11contenttypeSSSgvp":{"name":"contenttype","abstract":"

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is analyzed; plain text is processed as submitted.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV8languageSSSgvp":{"name":"language","abstract":"

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en (English). Regional variants are treated as their parent language; for example, en-US is interpreted as en. A language specified with the Content-Type parameter overrides the value of this parameter; any content items that specify a different language are ignored. Omit the Content-Type parameter to base the language on the most prevalent specification among the content items; again, content items that specify a different language are ignored. You can specify any combination of languages for the input and response content.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV8parentidSSSgvp":{"name":"parentid","abstract":"

The unique ID of the parent content item for this item. Used to identify hierarchical relationships between posts/replies, messages/replies, and so on.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV5replySbSgvp":{"name":"reply","abstract":"

Indicates whether this content item is a reply to another content item.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV7forwardSbSgvp":{"name":"forward","abstract":"

Indicates whether this content item is a forwarded/copied version of another content item.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemVACSS7content_SSSg2idSiSg7createdAG7updatedAE11contenttypeAE8languageAE8parentidSbSg5replyAM7forwardtcfc":{"name":"init(content:id:created:updated:contenttype:language:parentid:reply:forward:)","abstract":"

Initialize a ContentItem with member variables.

","parent_name":"ContentItem"},"Structs/Content.html#/s:21PersonalityInsightsV37ContentV12contentItemsSayAA0D4ItemVGvp":{"name":"contentItems","abstract":"

An array of ContentItem objects that provides the text that is to be analyzed.

","parent_name":"Content"},"Structs/Content.html#/s:21PersonalityInsightsV37ContentVACSayAA0D4ItemVG12contentItems_tcfc":{"name":"init(contentItems:)","abstract":"

Initialize a Content with member variables.

","parent_name":"Content"},"Structs/ConsumptionPreferencesCategory.html#/s:21PersonalityInsightsV330ConsumptionPreferencesCategoryV021consumptionPreferenceF2IDSSvp":{"name":"consumptionPreferenceCategoryID","abstract":"

The unique, non-localized identifier of the consumption preferences category to which the results pertain. IDs have the form consumption_preferences_{category}.

","parent_name":"ConsumptionPreferencesCategory"},"Structs/ConsumptionPreferencesCategory.html#/s:21PersonalityInsightsV330ConsumptionPreferencesCategoryV4nameSSvp":{"name":"name","abstract":"

The user-visible name of the consumption preferences category.

","parent_name":"ConsumptionPreferencesCategory"},"Structs/ConsumptionPreferencesCategory.html#/s:21PersonalityInsightsV330ConsumptionPreferencesCategoryV011consumptionE0SayAA0dE0VGvp":{"name":"consumptionPreferences","abstract":"

Detailed results inferred from the input text for the individual preferences of the category.

","parent_name":"ConsumptionPreferencesCategory"},"Structs/ConsumptionPreferences.html#/s:21PersonalityInsightsV322ConsumptionPreferencesV23consumptionPreferenceIDSSvp":{"name":"consumptionPreferenceID","abstract":"

The unique, non-localized identifier of the consumption preference to which the results pertain. IDs have the form consumption_preferences_{preference}.

","parent_name":"ConsumptionPreferences"},"Structs/ConsumptionPreferences.html#/s:21PersonalityInsightsV322ConsumptionPreferencesV4nameSSvp":{"name":"name","abstract":"

The user-visible, localized name of the consumption preference.

","parent_name":"ConsumptionPreferences"},"Structs/ConsumptionPreferences.html#/s:21PersonalityInsightsV322ConsumptionPreferencesV5scoreSdvp":{"name":"score","abstract":"

The score for the consumption preference: * 0.0: Unlikely * 0.5: Neutral * 1.0: Likely The scores for some preferences are binary and do not allow a neutral value. The score is an indication of preference based on the results inferred from the input text, not a normalized percentile.

","parent_name":"ConsumptionPreferences"},"Structs/Behavior.html#/s:21PersonalityInsightsV38BehaviorV7traitIDSSvp":{"name":"traitID","abstract":"

The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form behavior_{value}.

","parent_name":"Behavior"},"Structs/Behavior.html#/s:21PersonalityInsightsV38BehaviorV4nameSSvp":{"name":"name","abstract":"

The user-visible, localized name of the characteristic.

","parent_name":"Behavior"},"Structs/Behavior.html#/s:21PersonalityInsightsV38BehaviorV8categorySSvp":{"name":"category","abstract":"

The category of the characteristic: behavior for temporal data.

","parent_name":"Behavior"},"Structs/Behavior.html#/s:21PersonalityInsightsV38BehaviorV10percentageSdvp":{"name":"percentage","abstract":"

For JSON content that is timestamped, the percentage of timestamped input data that occurred during that day of the week or hour of the day. The range is 0 to 1.

","parent_name":"Behavior"},"Structs/Behavior.html":{"name":"Behavior","abstract":"

Behavior.

"},"Structs/ConsumptionPreferences.html":{"name":"ConsumptionPreferences","abstract":"

ConsumptionPreferences.

"},"Structs/ConsumptionPreferencesCategory.html":{"name":"ConsumptionPreferencesCategory","abstract":"

ConsumptionPreferencesCategory.

"},"Structs/Content.html":{"name":"Content","abstract":"

Content.

"},"Structs/ContentItem.html":{"name":"ContentItem","abstract":"

ContentItem.

"},"Structs/Profile.html":{"name":"Profile","abstract":"

Profile.

"},"Structs/Trait.html":{"name":"Trait","abstract":"

Trait.

"},"Structs/Warning.html":{"name":"Warning","abstract":"

Warning.

"},"Structs.html#/s:21PersonalityInsightsV311JSONWrapperV":{"name":"JSONWrapper","abstract":"

Used internally to serialize and deserialize JSON."},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO013serializationE0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO08encodingE0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO011fileManagerE0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

Create a PersonalityInsights object.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a PersonalityInsights object.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a PersonalityInsights object.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C7profileyAA7ContentV7content_SSSg0F8LanguageAH06acceptG0SbSg9rawScoresAK22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA7ProfileVc7successtF":{"name":"profile(content:contentLanguage:acceptLanguage:rawScores:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C7profileySS4text_SSSg15contentLanguageAF06acceptG0SbSg9rawScoresAI22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA7ProfileVc7successtF":{"name":"profile(text:contentLanguage:acceptLanguage:rawScores:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C7profileySS4html_SSSg15contentLanguageAF06acceptG0SbSg9rawScoresAI22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA7ProfileVc7successtF":{"name":"profile(html:contentLanguage:acceptLanguage:rawScores:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C12profileAsCsvyAA7ContentV7content_SSSg0H8LanguageAH06acceptI0SbSg9rawScoresAK10csvHeadersAK22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureySSc7successtF":{"name":"profileAsCsv(content:contentLanguage:acceptLanguage:rawScores:csvHeaders:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile. as csv

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C12profileAsCsvySS4text_SSSg15contentLanguageAF06acceptI0SbSg9rawScoresAI10csvHeadersAI22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureySSc7successtF":{"name":"profileAsCsv(text:contentLanguage:acceptLanguage:rawScores:csvHeaders:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile. as csv

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C12profileAsCsvySS4html_SSSg15contentLanguageAF06acceptI0SbSg9rawScoresAI10csvHeadersAI22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureySSc7successtF":{"name":"profileAsCsv(html:contentLanguage:acceptLanguage:rawScores:csvHeaders:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile. as csv

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html":{"name":"PersonalityInsights","abstract":"

The IBM Watson Personality Insights service enables applications to derive insights from social media, enterprise data,"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file +{"Structs/Warning/WarningID.html#/s:21PersonalityInsightsV37WarningV0D2IDO16wordCountMessageA2EmF":{"name":"wordCountMessage","abstract":"

Undocumented

","parent_name":"WarningID"},"Structs/Warning/WarningID.html#/s:21PersonalityInsightsV37WarningV0D2IDO10jsonAsTextA2EmF":{"name":"jsonAsText","abstract":"

Undocumented

","parent_name":"WarningID"},"Structs/Warning/WarningID.html#/s:21PersonalityInsightsV37WarningV0D2IDO16contentTruncatedA2EmF":{"name":"contentTruncated","abstract":"

Undocumented

","parent_name":"WarningID"},"Structs/Warning/WarningID.html#/s:21PersonalityInsightsV37WarningV0D2IDO15partialTextUsedA2EmF":{"name":"partialTextUsed","abstract":"

Undocumented

","parent_name":"WarningID"},"Structs/Warning/WarningID.html":{"name":"WarningID","abstract":"

The identifier of the warning message.

","parent_name":"Warning"},"Structs/Warning.html#/s:21PersonalityInsightsV37WarningV9warningIDSSvp":{"name":"warningID","abstract":"

The identifier of the warning message.

","parent_name":"Warning"},"Structs/Warning.html#/s:21PersonalityInsightsV37WarningV7messageSSvp":{"name":"message","abstract":"

The message associated with the warning_id:

","parent_name":"Warning"},"Structs/Trait/Category.html#/s:21PersonalityInsightsV35TraitV8CategoryO11personalityA2EmF":{"name":"personality","abstract":"

Undocumented

","parent_name":"Category"},"Structs/Trait/Category.html#/s:21PersonalityInsightsV35TraitV8CategoryO5needsA2EmF":{"name":"needs","abstract":"

Undocumented

","parent_name":"Category"},"Structs/Trait/Category.html#/s:21PersonalityInsightsV35TraitV8CategoryO6valuesA2EmF":{"name":"values","abstract":"

Undocumented

","parent_name":"Category"},"Structs/Trait/Category.html":{"name":"Category","abstract":"

The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV7traitIDSSvp":{"name":"traitID","abstract":"

The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form

","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV4nameSSvp":{"name":"name","abstract":"

The user-visible, localized name of the characteristic.

","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV8categorySSvp":{"name":"category","abstract":"

The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV10percentileSdvp":{"name":"percentile","abstract":"

The normalized percentile score for the characteristic. The range is 0 to 1. For example, if the percentage for","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV8rawScoreSdSgvp":{"name":"rawScore","abstract":"

The raw score for the characteristic. The range is 0 to 1. A higher score generally indicates a greater likelihood","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV11significantSbSgvp":{"name":"significant","abstract":"

2017-10-13: Indicates whether the characteristic is meaningful for the input language. The field is always","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV8childrenSayACGSgvp":{"name":"children","abstract":"

For personality (Big Five) dimensions, more detailed results for the facets of each dimension as inferred from","parent_name":"Trait"},"Structs/Profile/ProcessedLanguage.html#/s:21PersonalityInsightsV37ProfileV17ProcessedLanguageO2arA2EmF":{"name":"ar","abstract":"

Undocumented

","parent_name":"ProcessedLanguage"},"Structs/Profile/ProcessedLanguage.html#/s:21PersonalityInsightsV37ProfileV17ProcessedLanguageO2enA2EmF":{"name":"en","abstract":"

Undocumented

","parent_name":"ProcessedLanguage"},"Structs/Profile/ProcessedLanguage.html#/s:21PersonalityInsightsV37ProfileV17ProcessedLanguageO2esA2EmF":{"name":"es","abstract":"

Undocumented

","parent_name":"ProcessedLanguage"},"Structs/Profile/ProcessedLanguage.html#/s:21PersonalityInsightsV37ProfileV17ProcessedLanguageO2jaA2EmF":{"name":"ja","abstract":"

Undocumented

","parent_name":"ProcessedLanguage"},"Structs/Profile/ProcessedLanguage.html#/s:21PersonalityInsightsV37ProfileV17ProcessedLanguageO2koA2EmF":{"name":"ko","abstract":"

Undocumented

","parent_name":"ProcessedLanguage"},"Structs/Profile/ProcessedLanguage.html":{"name":"ProcessedLanguage","abstract":"

The language model that was used to process the input.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV17processedLanguageSSvp":{"name":"processedLanguage","abstract":"

The language model that was used to process the input.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV9wordCountSivp":{"name":"wordCount","abstract":"

The number of words from the input that were used to produce the profile.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV16wordCountMessageSSSgvp":{"name":"wordCountMessage","abstract":"

When guidance is appropriate, a string that provides a message that indicates the number of words found and where","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV11personalitySayAA5TraitVGvp":{"name":"personality","abstract":"

A recursive array of Trait objects that provides detailed results for the Big Five personality characteristics","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV5needsSayAA5TraitVGvp":{"name":"needs","abstract":"

Detailed results for the Needs characteristics inferred from the input text.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV6valuesSayAA5TraitVGvp":{"name":"values","abstract":"

Detailed results for the Values characteristics inferred from the input text.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV8behaviorSayAA8BehaviorVGSgvp":{"name":"behavior","abstract":"

For JSON content that is timestamped, detailed results about the social behavior disclosed by the input in terms of","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV22consumptionPreferencesSayAA011ConsumptionF8CategoryVGSgvp":{"name":"consumptionPreferences","abstract":"

If the consumption_preferences parameter is true, detailed results for each category of consumption","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV8warningsSayAA7WarningVGvp":{"name":"warnings","abstract":"

Warning messages associated with the input text submitted with the request. The array is empty if the input","parent_name":"Profile"},"Structs/ContentItem/Language.html#/s:21PersonalityInsightsV311ContentItemV8LanguageO2arA2EmF":{"name":"ar","abstract":"

Undocumented

","parent_name":"Language"},"Structs/ContentItem/Language.html#/s:21PersonalityInsightsV311ContentItemV8LanguageO2enA2EmF":{"name":"en","abstract":"

Undocumented

","parent_name":"Language"},"Structs/ContentItem/Language.html#/s:21PersonalityInsightsV311ContentItemV8LanguageO2esA2EmF":{"name":"es","abstract":"

Undocumented

","parent_name":"Language"},"Structs/ContentItem/Language.html#/s:21PersonalityInsightsV311ContentItemV8LanguageO2jaA2EmF":{"name":"ja","abstract":"

Undocumented

","parent_name":"Language"},"Structs/ContentItem/Language.html#/s:21PersonalityInsightsV311ContentItemV8LanguageO2koA2EmF":{"name":"ko","abstract":"

Undocumented

","parent_name":"Language"},"Structs/ContentItem/Contenttype.html#/s:21PersonalityInsightsV311ContentItemV11ContenttypeO5plainA2EmF":{"name":"plain","abstract":"

Undocumented

","parent_name":"Contenttype"},"Structs/ContentItem/Contenttype.html#/s:21PersonalityInsightsV311ContentItemV11ContenttypeO4htmlA2EmF":{"name":"html","abstract":"

Undocumented

","parent_name":"Contenttype"},"Structs/ContentItem/Contenttype.html":{"name":"Contenttype","abstract":"

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is","parent_name":"ContentItem"},"Structs/ContentItem/Language.html":{"name":"Language","abstract":"

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV7contentSSvp":{"name":"content","abstract":"

The content that is to be analyzed. The service supports up to 20 MB of content for all ContentItem objects","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV2idSSSgvp":{"name":"id","abstract":"

A unique identifier for this content item.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV7createdSiSgvp":{"name":"created","abstract":"

A timestamp that identifies when this content was created. Specify a value in milliseconds since the UNIX Epoch","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV7updatedSiSgvp":{"name":"updated","abstract":"

A timestamp that identifies when this content was last updated. Specify a value in milliseconds since the UNIX","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV11contenttypeSSSgvp":{"name":"contenttype","abstract":"

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV8languageSSSgvp":{"name":"language","abstract":"

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV8parentidSSSgvp":{"name":"parentid","abstract":"

The unique ID of the parent content item for this item. Used to identify hierarchical relationships between","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV5replySbSgvp":{"name":"reply","abstract":"

Indicates whether this content item is a reply to another content item.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV7forwardSbSgvp":{"name":"forward","abstract":"

Indicates whether this content item is a forwarded/copied version of another content item.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemVACSS7content_SSSg2idSiSg7createdAG7updatedAE11contenttypeAE8languageAE8parentidSbSg5replyAM7forwardtcfc":{"name":"init(content:id:created:updated:contenttype:language:parentid:reply:forward:)","abstract":"

Initialize a ContentItem with member variables.

","parent_name":"ContentItem"},"Structs/Content.html#/s:21PersonalityInsightsV37ContentV12contentItemsSayAA0D4ItemVGvp":{"name":"contentItems","abstract":"

An array of ContentItem objects that provides the text that is to be analyzed.

","parent_name":"Content"},"Structs/Content.html#/s:21PersonalityInsightsV37ContentVACSayAA0D4ItemVG12contentItems_tcfc":{"name":"init(contentItems:)","abstract":"

Initialize a Content with member variables.

","parent_name":"Content"},"Structs/ConsumptionPreferencesCategory.html#/s:21PersonalityInsightsV330ConsumptionPreferencesCategoryV021consumptionPreferenceF2IDSSvp":{"name":"consumptionPreferenceCategoryID","abstract":"

The unique, non-localized identifier of the consumption preferences category to which the results pertain. IDs have","parent_name":"ConsumptionPreferencesCategory"},"Structs/ConsumptionPreferencesCategory.html#/s:21PersonalityInsightsV330ConsumptionPreferencesCategoryV4nameSSvp":{"name":"name","abstract":"

The user-visible name of the consumption preferences category.

","parent_name":"ConsumptionPreferencesCategory"},"Structs/ConsumptionPreferencesCategory.html#/s:21PersonalityInsightsV330ConsumptionPreferencesCategoryV011consumptionE0SayAA0dE0VGvp":{"name":"consumptionPreferences","abstract":"

Detailed results inferred from the input text for the individual preferences of the category.

","parent_name":"ConsumptionPreferencesCategory"},"Structs/ConsumptionPreferences.html#/s:21PersonalityInsightsV322ConsumptionPreferencesV23consumptionPreferenceIDSSvp":{"name":"consumptionPreferenceID","abstract":"

The unique, non-localized identifier of the consumption preference to which the results pertain. IDs have the form","parent_name":"ConsumptionPreferences"},"Structs/ConsumptionPreferences.html#/s:21PersonalityInsightsV322ConsumptionPreferencesV4nameSSvp":{"name":"name","abstract":"

The user-visible, localized name of the consumption preference.

","parent_name":"ConsumptionPreferences"},"Structs/ConsumptionPreferences.html#/s:21PersonalityInsightsV322ConsumptionPreferencesV5scoreSdvp":{"name":"score","abstract":"

The score for the consumption preference:

","parent_name":"ConsumptionPreferences"},"Structs/Behavior.html#/s:21PersonalityInsightsV38BehaviorV7traitIDSSvp":{"name":"traitID","abstract":"

The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form","parent_name":"Behavior"},"Structs/Behavior.html#/s:21PersonalityInsightsV38BehaviorV4nameSSvp":{"name":"name","abstract":"

The user-visible, localized name of the characteristic.

","parent_name":"Behavior"},"Structs/Behavior.html#/s:21PersonalityInsightsV38BehaviorV8categorySSvp":{"name":"category","abstract":"

The category of the characteristic: behavior for temporal data.

","parent_name":"Behavior"},"Structs/Behavior.html#/s:21PersonalityInsightsV38BehaviorV10percentageSdvp":{"name":"percentage","abstract":"

For JSON content that is timestamped, the percentage of timestamped input data that occurred during that day of the","parent_name":"Behavior"},"Structs/Behavior.html":{"name":"Behavior","abstract":"

Behavior.

"},"Structs/ConsumptionPreferences.html":{"name":"ConsumptionPreferences","abstract":"

ConsumptionPreferences.

"},"Structs/ConsumptionPreferencesCategory.html":{"name":"ConsumptionPreferencesCategory","abstract":"

ConsumptionPreferencesCategory.

"},"Structs/Content.html":{"name":"Content","abstract":"

Content.

"},"Structs/ContentItem.html":{"name":"ContentItem","abstract":"

ContentItem.

"},"Structs/Profile.html":{"name":"Profile","abstract":"

Profile.

"},"Structs/Trait.html":{"name":"Trait","abstract":"

Trait.

"},"Structs/Warning.html":{"name":"Warning","abstract":"

Warning.

"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO013serializationE0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO08encodingE0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO011fileManagerE0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

Create a PersonalityInsights object.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a PersonalityInsights object.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a PersonalityInsights object.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C7profileyAA7ContentV7content_SSSg0F8LanguageAH06acceptG0SbSg9rawScoresAK22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA7ProfileVc7successtF":{"name":"profile(content:contentLanguage:acceptLanguage:rawScores:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C7profileySS4text_SSSg15contentLanguageAF06acceptG0SbSg9rawScoresAI22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA7ProfileVc7successtF":{"name":"profile(text:contentLanguage:acceptLanguage:rawScores:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C7profileySS4html_SSSg15contentLanguageAF06acceptG0SbSg9rawScoresAI22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA7ProfileVc7successtF":{"name":"profile(html:contentLanguage:acceptLanguage:rawScores:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C12profileAsCsvyAA7ContentV7content_SSSg0H8LanguageAH06acceptI0SbSg9rawScoresAK10csvHeadersAK22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureySSc7successtF":{"name":"profileAsCsv(content:contentLanguage:acceptLanguage:rawScores:csvHeaders:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile as csv.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C12profileAsCsvySS4text_SSSg15contentLanguageAF06acceptI0SbSg9rawScoresAI10csvHeadersAI22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureySSc7successtF":{"name":"profileAsCsv(text:contentLanguage:acceptLanguage:rawScores:csvHeaders:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile as csv.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C12profileAsCsvySS4html_SSSg15contentLanguageAF06acceptI0SbSg9rawScoresAI10csvHeadersAI22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureySSc7successtF":{"name":"profileAsCsv(html:contentLanguage:acceptLanguage:rawScores:csvHeaders:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile as csv.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html":{"name":"PersonalityInsights","abstract":"

The IBM Watson™ Personality Insights service enables applications to derive insights from social media,"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/docSet.dsidx b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/docSet.dsidx index e0c7ad054..6b31f6d7b 100644 Binary files a/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/docSet.dsidx and b/docs/swift-api/services/PersonalityInsightsV3/docsets/.docset/Contents/Resources/docSet.dsidx differ diff --git a/docs/swift-api/services/PersonalityInsightsV3/docsets/.tgz b/docs/swift-api/services/PersonalityInsightsV3/docsets/.tgz index 5fb7d56fd..0bcca3370 100644 Binary files a/docs/swift-api/services/PersonalityInsightsV3/docsets/.tgz and b/docs/swift-api/services/PersonalityInsightsV3/docsets/.tgz differ diff --git a/docs/swift-api/services/PersonalityInsightsV3/index.html b/docs/swift-api/services/PersonalityInsightsV3/index.html index 10b522401..2f05ea7cc 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/index.html +++ b/docs/swift-api/services/PersonalityInsightsV3/index.html @@ -70,9 +70,6 @@ - @@ -139,7 +136,8 @@

Services

  • Assistant
  • Discovery
  • -
  • Language Translator
  • +
  • Language Translator V2
  • +
  • Language Translator V3
  • Natural Language Classifier
  • Natural Language Understanding
  • Personality Insights
  • @@ -184,7 +182,7 @@

    Swift Package Manager

    Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

    dependencies: [
    -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
    +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
     ]
     

    Service Instances

    @@ -227,7 +225,7 @@

    Username and Password

    API Key

    -

    Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

    +

    Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

    let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
     

    Using IAM

    @@ -462,7 +460,12 @@

    Private Data Collections

  • IBM Discovery - Documentation
  • IBM Discovery - Demo
-

Language Translator

+

Language Translator V2

+ +

Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

@@ -473,6 +476,25 @@

Language Translator

let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} + +

Language Translator V3

+ +

The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

+ +

The following example demonstrates how to use the Language Translator service:

+
import LanguageTranslatorV3
+
+let username = "your-username-here"
+let password = "your-password-here"
+let version = "yyyy-mm-dd" // use today's date for the most recent version
+let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
+
 let failure = { (error: Error) in print(error) }
 let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
 languageTranslator.translate(request: request, failure: failure) {
@@ -863,7 +885,7 @@ 

Visual Recognition

let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -871,6 +893,10 @@

Visual Recognition

print(classifiedImages) }
+ +

Note: a different initializer is used for authentication with instances created before May 23, 2018:

+
let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
+

Using Core ML

The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

@@ -922,7 +948,7 @@

Bundlin diff --git a/docs/swift-api/services/PersonalityInsightsV3/search.json b/docs/swift-api/services/PersonalityInsightsV3/search.json index 7e6bc442b..7e1c61981 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/search.json +++ b/docs/swift-api/services/PersonalityInsightsV3/search.json @@ -1 +1 @@ -{"Structs/Warning/WarningID.html#/s:21PersonalityInsightsV37WarningV0D2IDO16wordCountMessageA2EmF":{"name":"wordCountMessage","abstract":"

Undocumented

","parent_name":"WarningID"},"Structs/Warning/WarningID.html#/s:21PersonalityInsightsV37WarningV0D2IDO10jsonAsTextA2EmF":{"name":"jsonAsText","abstract":"

Undocumented

","parent_name":"WarningID"},"Structs/Warning/WarningID.html#/s:21PersonalityInsightsV37WarningV0D2IDO16contentTruncatedA2EmF":{"name":"contentTruncated","abstract":"

Undocumented

","parent_name":"WarningID"},"Structs/Warning/WarningID.html#/s:21PersonalityInsightsV37WarningV0D2IDO15partialTextUsedA2EmF":{"name":"partialTextUsed","abstract":"

Undocumented

","parent_name":"WarningID"},"Structs/Warning/WarningID.html":{"name":"WarningID","abstract":"

The identifier of the warning message.

","parent_name":"Warning"},"Structs/Warning.html#/s:21PersonalityInsightsV37WarningV9warningIDSSvp":{"name":"warningID","abstract":"

The identifier of the warning message.

","parent_name":"Warning"},"Structs/Warning.html#/s:21PersonalityInsightsV37WarningV7messageSSvp":{"name":"message","abstract":"

The message associated with the warning_id: * WORD_COUNT_MESSAGE: There were {number} words in the input. We need a minimum of 600, preferably 1,200 or more, to compute statistically significant estimates. * JSON_AS_TEXT: Request input was processed as text/plain as indicated, however detected a JSON input. Did you mean application/json? * CONTENT_TRUNCATED: For maximum accuracy while also optimizing processing time, only the first 250KB of input text (excluding markup) was analyzed. Accuracy levels off at approximately 3,000 words so this did not affect the accuracy of the profile. * PARTIAL_TEXT_USED, The text provided to compute the profile was trimmed for performance reasons. This action does not affect the accuracy of the output, as not all of the input text was required. Applies only when Arabic input text exceeds a threshold at which additional words do not contribute to the accuracy of the profile.

","parent_name":"Warning"},"Structs/Trait/Category.html#/s:21PersonalityInsightsV35TraitV8CategoryO11personalityA2EmF":{"name":"personality","abstract":"

Undocumented

","parent_name":"Category"},"Structs/Trait/Category.html#/s:21PersonalityInsightsV35TraitV8CategoryO5needsA2EmF":{"name":"needs","abstract":"

Undocumented

","parent_name":"Category"},"Structs/Trait/Category.html#/s:21PersonalityInsightsV35TraitV8CategoryO6valuesA2EmF":{"name":"values","abstract":"

Undocumented

","parent_name":"Category"},"Structs/Trait/Category.html":{"name":"Category","abstract":"

The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and values for Values.

","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV7traitIDSSvp":{"name":"traitID","abstract":"

The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form * big5_{characteristic} for Big Five personality dimensions * facet_{characteristic} for Big Five personality facets * need_{characteristic} for Needs *value_{characteristic} for Values.

","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV4nameSSvp":{"name":"name","abstract":"

The user-visible, localized name of the characteristic.

","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV8categorySSvp":{"name":"category","abstract":"

The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and values for Values.

","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV10percentileSdvp":{"name":"percentile","abstract":"

The normalized percentile score for the characteristic. The range is 0 to 1. For example, if the percentage for Openness is 0.60, the author scored in the 60th percentile; the author is more open than 59 percent of the population and less open than 39 percent of the population.

","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV8rawScoreSdSgvp":{"name":"rawScore","abstract":"

The raw score for the characteristic. The range is 0 to 1. A higher score generally indicates a greater likelihood that the author has that characteristic, but raw scores must be considered in aggregate: The range of values in practice might be much smaller than 0 to 1, so an individual score must be considered in the context of the overall scores and their range. The raw score is computed based on the input and the service model; it is not normalized or compared with a sample population. The raw score enables comparison of the results against a different sampling population and with a custom normalization approach.

","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV11significantSbSgvp":{"name":"significant","abstract":"

2017-10-13: Indicates whether the characteristic is meaningful for the input language. The field is always true for all characteristics of English, Spanish, and Japanese input. The field is false for the subset of characteristics of Arabic and Korean input for which the service’s models are unable to generate meaningful results. **2016-10-19: Not returned.

","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV8childrenSayACGSgvp":{"name":"children","abstract":"

For personality (Big Five) dimensions, more detailed results for the facets of each dimension as inferred from the input text.

","parent_name":"Trait"},"Structs/Profile/ProcessedLanguage.html#/s:21PersonalityInsightsV37ProfileV17ProcessedLanguageO2arA2EmF":{"name":"ar","abstract":"

Undocumented

","parent_name":"ProcessedLanguage"},"Structs/Profile/ProcessedLanguage.html#/s:21PersonalityInsightsV37ProfileV17ProcessedLanguageO2enA2EmF":{"name":"en","abstract":"

Undocumented

","parent_name":"ProcessedLanguage"},"Structs/Profile/ProcessedLanguage.html#/s:21PersonalityInsightsV37ProfileV17ProcessedLanguageO2esA2EmF":{"name":"es","abstract":"

Undocumented

","parent_name":"ProcessedLanguage"},"Structs/Profile/ProcessedLanguage.html#/s:21PersonalityInsightsV37ProfileV17ProcessedLanguageO2jaA2EmF":{"name":"ja","abstract":"

Undocumented

","parent_name":"ProcessedLanguage"},"Structs/Profile/ProcessedLanguage.html#/s:21PersonalityInsightsV37ProfileV17ProcessedLanguageO2koA2EmF":{"name":"ko","abstract":"

Undocumented

","parent_name":"ProcessedLanguage"},"Structs/Profile/ProcessedLanguage.html":{"name":"ProcessedLanguage","abstract":"

The language model that was used to process the input.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV17processedLanguageSSvp":{"name":"processedLanguage","abstract":"

The language model that was used to process the input.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV9wordCountSivp":{"name":"wordCount","abstract":"

The number of words from the input that were used to produce the profile.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV16wordCountMessageSSSgvp":{"name":"wordCountMessage","abstract":"

When guidance is appropriate, a string that provides a message that indicates the number of words found and where that value falls in the range of required or suggested number of words.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV11personalitySayAA5TraitVGvp":{"name":"personality","abstract":"

A recursive array of Trait objects that provides detailed results for the Big Five personality characteristics (dimensions and facets) inferred from the input text.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV5needsSayAA5TraitVGvp":{"name":"needs","abstract":"

Detailed results for the Needs characteristics inferred from the input text.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV6valuesSayAA5TraitVGvp":{"name":"values","abstract":"

Detailed results for the Values characteristics inferred from the input text.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV8behaviorSayAA8BehaviorVGSgvp":{"name":"behavior","abstract":"

For JSON content that is timestamped, detailed results about the social behavior disclosed by the input in terms of temporal characteristics. The results include information about the distribution of the content over the days of the week and the hours of the day.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV22consumptionPreferencesSayAA011ConsumptionF8CategoryVGSgvp":{"name":"consumptionPreferences","abstract":"

If the consumption_preferences parameter is true, detailed results for each category of consumption preferences. Each element of the array provides information inferred from the input text for the individual preferences of that category.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV8warningsSayAA7WarningVGvp":{"name":"warnings","abstract":"

Warning messages associated with the input text submitted with the request. The array is empty if the input generated no warnings.

","parent_name":"Profile"},"Structs/ContentItem/Language.html#/s:21PersonalityInsightsV311ContentItemV8LanguageO2arA2EmF":{"name":"ar","abstract":"

Undocumented

","parent_name":"Language"},"Structs/ContentItem/Language.html#/s:21PersonalityInsightsV311ContentItemV8LanguageO2enA2EmF":{"name":"en","abstract":"

Undocumented

","parent_name":"Language"},"Structs/ContentItem/Language.html#/s:21PersonalityInsightsV311ContentItemV8LanguageO2esA2EmF":{"name":"es","abstract":"

Undocumented

","parent_name":"Language"},"Structs/ContentItem/Language.html#/s:21PersonalityInsightsV311ContentItemV8LanguageO2jaA2EmF":{"name":"ja","abstract":"

Undocumented

","parent_name":"Language"},"Structs/ContentItem/Language.html#/s:21PersonalityInsightsV311ContentItemV8LanguageO2koA2EmF":{"name":"ko","abstract":"

Undocumented

","parent_name":"Language"},"Structs/ContentItem/Contenttype.html#/s:21PersonalityInsightsV311ContentItemV11ContenttypeO5plainA2EmF":{"name":"plain","abstract":"

Undocumented

","parent_name":"Contenttype"},"Structs/ContentItem/Contenttype.html#/s:21PersonalityInsightsV311ContentItemV11ContenttypeO4htmlA2EmF":{"name":"html","abstract":"

Undocumented

","parent_name":"Contenttype"},"Structs/ContentItem/Contenttype.html":{"name":"Contenttype","abstract":"

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is analyzed; plain text is processed as submitted.

","parent_name":"ContentItem"},"Structs/ContentItem/Language.html":{"name":"Language","abstract":"

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en (English). Regional variants are treated as their parent language; for example, en-US is interpreted as en. A language specified with the Content-Type parameter overrides the value of this parameter; any content items that specify a different language are ignored. Omit the Content-Type parameter to base the language on the most prevalent specification among the content items; again, content items that specify a different language are ignored. You can specify any combination of languages for the input and response content.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV7contentSSvp":{"name":"content","abstract":"

The content that is to be analyzed. The service supports up to 20 MB of content for all ContentItem objects combined.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV2idSSSgvp":{"name":"id","abstract":"

A unique identifier for this content item.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV7createdSiSgvp":{"name":"created","abstract":"

A timestamp that identifies when this content was created. Specify a value in milliseconds since the UNIX Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV7updatedSiSgvp":{"name":"updated","abstract":"

A timestamp that identifies when this content was last updated. Specify a value in milliseconds since the UNIX Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV11contenttypeSSSgvp":{"name":"contenttype","abstract":"

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is analyzed; plain text is processed as submitted.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV8languageSSSgvp":{"name":"language","abstract":"

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en (English). Regional variants are treated as their parent language; for example, en-US is interpreted as en. A language specified with the Content-Type parameter overrides the value of this parameter; any content items that specify a different language are ignored. Omit the Content-Type parameter to base the language on the most prevalent specification among the content items; again, content items that specify a different language are ignored. You can specify any combination of languages for the input and response content.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV8parentidSSSgvp":{"name":"parentid","abstract":"

The unique ID of the parent content item for this item. Used to identify hierarchical relationships between posts/replies, messages/replies, and so on.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV5replySbSgvp":{"name":"reply","abstract":"

Indicates whether this content item is a reply to another content item.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV7forwardSbSgvp":{"name":"forward","abstract":"

Indicates whether this content item is a forwarded/copied version of another content item.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemVACSS7content_SSSg2idSiSg7createdAG7updatedAE11contenttypeAE8languageAE8parentidSbSg5replyAM7forwardtcfc":{"name":"init(content:id:created:updated:contenttype:language:parentid:reply:forward:)","abstract":"

Initialize a ContentItem with member variables.

","parent_name":"ContentItem"},"Structs/Content.html#/s:21PersonalityInsightsV37ContentV12contentItemsSayAA0D4ItemVGvp":{"name":"contentItems","abstract":"

An array of ContentItem objects that provides the text that is to be analyzed.

","parent_name":"Content"},"Structs/Content.html#/s:21PersonalityInsightsV37ContentVACSayAA0D4ItemVG12contentItems_tcfc":{"name":"init(contentItems:)","abstract":"

Initialize a Content with member variables.

","parent_name":"Content"},"Structs/ConsumptionPreferencesCategory.html#/s:21PersonalityInsightsV330ConsumptionPreferencesCategoryV021consumptionPreferenceF2IDSSvp":{"name":"consumptionPreferenceCategoryID","abstract":"

The unique, non-localized identifier of the consumption preferences category to which the results pertain. IDs have the form consumption_preferences_{category}.

","parent_name":"ConsumptionPreferencesCategory"},"Structs/ConsumptionPreferencesCategory.html#/s:21PersonalityInsightsV330ConsumptionPreferencesCategoryV4nameSSvp":{"name":"name","abstract":"

The user-visible name of the consumption preferences category.

","parent_name":"ConsumptionPreferencesCategory"},"Structs/ConsumptionPreferencesCategory.html#/s:21PersonalityInsightsV330ConsumptionPreferencesCategoryV011consumptionE0SayAA0dE0VGvp":{"name":"consumptionPreferences","abstract":"

Detailed results inferred from the input text for the individual preferences of the category.

","parent_name":"ConsumptionPreferencesCategory"},"Structs/ConsumptionPreferences.html#/s:21PersonalityInsightsV322ConsumptionPreferencesV23consumptionPreferenceIDSSvp":{"name":"consumptionPreferenceID","abstract":"

The unique, non-localized identifier of the consumption preference to which the results pertain. IDs have the form consumption_preferences_{preference}.

","parent_name":"ConsumptionPreferences"},"Structs/ConsumptionPreferences.html#/s:21PersonalityInsightsV322ConsumptionPreferencesV4nameSSvp":{"name":"name","abstract":"

The user-visible, localized name of the consumption preference.

","parent_name":"ConsumptionPreferences"},"Structs/ConsumptionPreferences.html#/s:21PersonalityInsightsV322ConsumptionPreferencesV5scoreSdvp":{"name":"score","abstract":"

The score for the consumption preference: * 0.0: Unlikely * 0.5: Neutral * 1.0: Likely The scores for some preferences are binary and do not allow a neutral value. The score is an indication of preference based on the results inferred from the input text, not a normalized percentile.

","parent_name":"ConsumptionPreferences"},"Structs/Behavior.html#/s:21PersonalityInsightsV38BehaviorV7traitIDSSvp":{"name":"traitID","abstract":"

The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form behavior_{value}.

","parent_name":"Behavior"},"Structs/Behavior.html#/s:21PersonalityInsightsV38BehaviorV4nameSSvp":{"name":"name","abstract":"

The user-visible, localized name of the characteristic.

","parent_name":"Behavior"},"Structs/Behavior.html#/s:21PersonalityInsightsV38BehaviorV8categorySSvp":{"name":"category","abstract":"

The category of the characteristic: behavior for temporal data.

","parent_name":"Behavior"},"Structs/Behavior.html#/s:21PersonalityInsightsV38BehaviorV10percentageSdvp":{"name":"percentage","abstract":"

For JSON content that is timestamped, the percentage of timestamped input data that occurred during that day of the week or hour of the day. The range is 0 to 1.

","parent_name":"Behavior"},"Structs/Behavior.html":{"name":"Behavior","abstract":"

Behavior.

"},"Structs/ConsumptionPreferences.html":{"name":"ConsumptionPreferences","abstract":"

ConsumptionPreferences.

"},"Structs/ConsumptionPreferencesCategory.html":{"name":"ConsumptionPreferencesCategory","abstract":"

ConsumptionPreferencesCategory.

"},"Structs/Content.html":{"name":"Content","abstract":"

Content.

"},"Structs/ContentItem.html":{"name":"ContentItem","abstract":"

ContentItem.

"},"Structs/Profile.html":{"name":"Profile","abstract":"

Profile.

"},"Structs/Trait.html":{"name":"Trait","abstract":"

Trait.

"},"Structs/Warning.html":{"name":"Warning","abstract":"

Warning.

"},"Structs.html#/s:21PersonalityInsightsV311JSONWrapperV":{"name":"JSONWrapper","abstract":"

Used internally to serialize and deserialize JSON."},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO013serializationE0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO08encodingE0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO011fileManagerE0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

Create a PersonalityInsights object.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a PersonalityInsights object.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a PersonalityInsights object.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C7profileyAA7ContentV7content_SSSg0F8LanguageAH06acceptG0SbSg9rawScoresAK22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA7ProfileVc7successtF":{"name":"profile(content:contentLanguage:acceptLanguage:rawScores:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C7profileySS4text_SSSg15contentLanguageAF06acceptG0SbSg9rawScoresAI22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA7ProfileVc7successtF":{"name":"profile(text:contentLanguage:acceptLanguage:rawScores:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C7profileySS4html_SSSg15contentLanguageAF06acceptG0SbSg9rawScoresAI22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA7ProfileVc7successtF":{"name":"profile(html:contentLanguage:acceptLanguage:rawScores:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C12profileAsCsvyAA7ContentV7content_SSSg0H8LanguageAH06acceptI0SbSg9rawScoresAK10csvHeadersAK22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureySSc7successtF":{"name":"profileAsCsv(content:contentLanguage:acceptLanguage:rawScores:csvHeaders:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile. as csv

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C12profileAsCsvySS4text_SSSg15contentLanguageAF06acceptI0SbSg9rawScoresAI10csvHeadersAI22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureySSc7successtF":{"name":"profileAsCsv(text:contentLanguage:acceptLanguage:rawScores:csvHeaders:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile. as csv

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C12profileAsCsvySS4html_SSSg15contentLanguageAF06acceptI0SbSg9rawScoresAI10csvHeadersAI22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureySSc7successtF":{"name":"profileAsCsv(html:contentLanguage:acceptLanguage:rawScores:csvHeaders:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile. as csv

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html":{"name":"PersonalityInsights","abstract":"

The IBM Watson Personality Insights service enables applications to derive insights from social media, enterprise data,"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file +{"Structs/Warning/WarningID.html#/s:21PersonalityInsightsV37WarningV0D2IDO16wordCountMessageA2EmF":{"name":"wordCountMessage","abstract":"

Undocumented

","parent_name":"WarningID"},"Structs/Warning/WarningID.html#/s:21PersonalityInsightsV37WarningV0D2IDO10jsonAsTextA2EmF":{"name":"jsonAsText","abstract":"

Undocumented

","parent_name":"WarningID"},"Structs/Warning/WarningID.html#/s:21PersonalityInsightsV37WarningV0D2IDO16contentTruncatedA2EmF":{"name":"contentTruncated","abstract":"

Undocumented

","parent_name":"WarningID"},"Structs/Warning/WarningID.html#/s:21PersonalityInsightsV37WarningV0D2IDO15partialTextUsedA2EmF":{"name":"partialTextUsed","abstract":"

Undocumented

","parent_name":"WarningID"},"Structs/Warning/WarningID.html":{"name":"WarningID","abstract":"

The identifier of the warning message.

","parent_name":"Warning"},"Structs/Warning.html#/s:21PersonalityInsightsV37WarningV9warningIDSSvp":{"name":"warningID","abstract":"

The identifier of the warning message.

","parent_name":"Warning"},"Structs/Warning.html#/s:21PersonalityInsightsV37WarningV7messageSSvp":{"name":"message","abstract":"

The message associated with the warning_id:

","parent_name":"Warning"},"Structs/Trait/Category.html#/s:21PersonalityInsightsV35TraitV8CategoryO11personalityA2EmF":{"name":"personality","abstract":"

Undocumented

","parent_name":"Category"},"Structs/Trait/Category.html#/s:21PersonalityInsightsV35TraitV8CategoryO5needsA2EmF":{"name":"needs","abstract":"

Undocumented

","parent_name":"Category"},"Structs/Trait/Category.html#/s:21PersonalityInsightsV35TraitV8CategoryO6valuesA2EmF":{"name":"values","abstract":"

Undocumented

","parent_name":"Category"},"Structs/Trait/Category.html":{"name":"Category","abstract":"

The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV7traitIDSSvp":{"name":"traitID","abstract":"

The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form

","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV4nameSSvp":{"name":"name","abstract":"

The user-visible, localized name of the characteristic.

","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV8categorySSvp":{"name":"category","abstract":"

The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV10percentileSdvp":{"name":"percentile","abstract":"

The normalized percentile score for the characteristic. The range is 0 to 1. For example, if the percentage for","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV8rawScoreSdSgvp":{"name":"rawScore","abstract":"

The raw score for the characteristic. The range is 0 to 1. A higher score generally indicates a greater likelihood","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV11significantSbSgvp":{"name":"significant","abstract":"

2017-10-13: Indicates whether the characteristic is meaningful for the input language. The field is always","parent_name":"Trait"},"Structs/Trait.html#/s:21PersonalityInsightsV35TraitV8childrenSayACGSgvp":{"name":"children","abstract":"

For personality (Big Five) dimensions, more detailed results for the facets of each dimension as inferred from","parent_name":"Trait"},"Structs/Profile/ProcessedLanguage.html#/s:21PersonalityInsightsV37ProfileV17ProcessedLanguageO2arA2EmF":{"name":"ar","abstract":"

Undocumented

","parent_name":"ProcessedLanguage"},"Structs/Profile/ProcessedLanguage.html#/s:21PersonalityInsightsV37ProfileV17ProcessedLanguageO2enA2EmF":{"name":"en","abstract":"

Undocumented

","parent_name":"ProcessedLanguage"},"Structs/Profile/ProcessedLanguage.html#/s:21PersonalityInsightsV37ProfileV17ProcessedLanguageO2esA2EmF":{"name":"es","abstract":"

Undocumented

","parent_name":"ProcessedLanguage"},"Structs/Profile/ProcessedLanguage.html#/s:21PersonalityInsightsV37ProfileV17ProcessedLanguageO2jaA2EmF":{"name":"ja","abstract":"

Undocumented

","parent_name":"ProcessedLanguage"},"Structs/Profile/ProcessedLanguage.html#/s:21PersonalityInsightsV37ProfileV17ProcessedLanguageO2koA2EmF":{"name":"ko","abstract":"

Undocumented

","parent_name":"ProcessedLanguage"},"Structs/Profile/ProcessedLanguage.html":{"name":"ProcessedLanguage","abstract":"

The language model that was used to process the input.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV17processedLanguageSSvp":{"name":"processedLanguage","abstract":"

The language model that was used to process the input.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV9wordCountSivp":{"name":"wordCount","abstract":"

The number of words from the input that were used to produce the profile.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV16wordCountMessageSSSgvp":{"name":"wordCountMessage","abstract":"

When guidance is appropriate, a string that provides a message that indicates the number of words found and where","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV11personalitySayAA5TraitVGvp":{"name":"personality","abstract":"

A recursive array of Trait objects that provides detailed results for the Big Five personality characteristics","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV5needsSayAA5TraitVGvp":{"name":"needs","abstract":"

Detailed results for the Needs characteristics inferred from the input text.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV6valuesSayAA5TraitVGvp":{"name":"values","abstract":"

Detailed results for the Values characteristics inferred from the input text.

","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV8behaviorSayAA8BehaviorVGSgvp":{"name":"behavior","abstract":"

For JSON content that is timestamped, detailed results about the social behavior disclosed by the input in terms of","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV22consumptionPreferencesSayAA011ConsumptionF8CategoryVGSgvp":{"name":"consumptionPreferences","abstract":"

If the consumption_preferences parameter is true, detailed results for each category of consumption","parent_name":"Profile"},"Structs/Profile.html#/s:21PersonalityInsightsV37ProfileV8warningsSayAA7WarningVGvp":{"name":"warnings","abstract":"

Warning messages associated with the input text submitted with the request. The array is empty if the input","parent_name":"Profile"},"Structs/ContentItem/Language.html#/s:21PersonalityInsightsV311ContentItemV8LanguageO2arA2EmF":{"name":"ar","abstract":"

Undocumented

","parent_name":"Language"},"Structs/ContentItem/Language.html#/s:21PersonalityInsightsV311ContentItemV8LanguageO2enA2EmF":{"name":"en","abstract":"

Undocumented

","parent_name":"Language"},"Structs/ContentItem/Language.html#/s:21PersonalityInsightsV311ContentItemV8LanguageO2esA2EmF":{"name":"es","abstract":"

Undocumented

","parent_name":"Language"},"Structs/ContentItem/Language.html#/s:21PersonalityInsightsV311ContentItemV8LanguageO2jaA2EmF":{"name":"ja","abstract":"

Undocumented

","parent_name":"Language"},"Structs/ContentItem/Language.html#/s:21PersonalityInsightsV311ContentItemV8LanguageO2koA2EmF":{"name":"ko","abstract":"

Undocumented

","parent_name":"Language"},"Structs/ContentItem/Contenttype.html#/s:21PersonalityInsightsV311ContentItemV11ContenttypeO5plainA2EmF":{"name":"plain","abstract":"

Undocumented

","parent_name":"Contenttype"},"Structs/ContentItem/Contenttype.html#/s:21PersonalityInsightsV311ContentItemV11ContenttypeO4htmlA2EmF":{"name":"html","abstract":"

Undocumented

","parent_name":"Contenttype"},"Structs/ContentItem/Contenttype.html":{"name":"Contenttype","abstract":"

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is","parent_name":"ContentItem"},"Structs/ContentItem/Language.html":{"name":"Language","abstract":"

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV7contentSSvp":{"name":"content","abstract":"

The content that is to be analyzed. The service supports up to 20 MB of content for all ContentItem objects","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV2idSSSgvp":{"name":"id","abstract":"

A unique identifier for this content item.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV7createdSiSgvp":{"name":"created","abstract":"

A timestamp that identifies when this content was created. Specify a value in milliseconds since the UNIX Epoch","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV7updatedSiSgvp":{"name":"updated","abstract":"

A timestamp that identifies when this content was last updated. Specify a value in milliseconds since the UNIX","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV11contenttypeSSSgvp":{"name":"contenttype","abstract":"

The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV8languageSSSgvp":{"name":"language","abstract":"

The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is en","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV8parentidSSSgvp":{"name":"parentid","abstract":"

The unique ID of the parent content item for this item. Used to identify hierarchical relationships between","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV5replySbSgvp":{"name":"reply","abstract":"

Indicates whether this content item is a reply to another content item.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemV7forwardSbSgvp":{"name":"forward","abstract":"

Indicates whether this content item is a forwarded/copied version of another content item.

","parent_name":"ContentItem"},"Structs/ContentItem.html#/s:21PersonalityInsightsV311ContentItemVACSS7content_SSSg2idSiSg7createdAG7updatedAE11contenttypeAE8languageAE8parentidSbSg5replyAM7forwardtcfc":{"name":"init(content:id:created:updated:contenttype:language:parentid:reply:forward:)","abstract":"

Initialize a ContentItem with member variables.

","parent_name":"ContentItem"},"Structs/Content.html#/s:21PersonalityInsightsV37ContentV12contentItemsSayAA0D4ItemVGvp":{"name":"contentItems","abstract":"

An array of ContentItem objects that provides the text that is to be analyzed.

","parent_name":"Content"},"Structs/Content.html#/s:21PersonalityInsightsV37ContentVACSayAA0D4ItemVG12contentItems_tcfc":{"name":"init(contentItems:)","abstract":"

Initialize a Content with member variables.

","parent_name":"Content"},"Structs/ConsumptionPreferencesCategory.html#/s:21PersonalityInsightsV330ConsumptionPreferencesCategoryV021consumptionPreferenceF2IDSSvp":{"name":"consumptionPreferenceCategoryID","abstract":"

The unique, non-localized identifier of the consumption preferences category to which the results pertain. IDs have","parent_name":"ConsumptionPreferencesCategory"},"Structs/ConsumptionPreferencesCategory.html#/s:21PersonalityInsightsV330ConsumptionPreferencesCategoryV4nameSSvp":{"name":"name","abstract":"

The user-visible name of the consumption preferences category.

","parent_name":"ConsumptionPreferencesCategory"},"Structs/ConsumptionPreferencesCategory.html#/s:21PersonalityInsightsV330ConsumptionPreferencesCategoryV011consumptionE0SayAA0dE0VGvp":{"name":"consumptionPreferences","abstract":"

Detailed results inferred from the input text for the individual preferences of the category.

","parent_name":"ConsumptionPreferencesCategory"},"Structs/ConsumptionPreferences.html#/s:21PersonalityInsightsV322ConsumptionPreferencesV23consumptionPreferenceIDSSvp":{"name":"consumptionPreferenceID","abstract":"

The unique, non-localized identifier of the consumption preference to which the results pertain. IDs have the form","parent_name":"ConsumptionPreferences"},"Structs/ConsumptionPreferences.html#/s:21PersonalityInsightsV322ConsumptionPreferencesV4nameSSvp":{"name":"name","abstract":"

The user-visible, localized name of the consumption preference.

","parent_name":"ConsumptionPreferences"},"Structs/ConsumptionPreferences.html#/s:21PersonalityInsightsV322ConsumptionPreferencesV5scoreSdvp":{"name":"score","abstract":"

The score for the consumption preference:

","parent_name":"ConsumptionPreferences"},"Structs/Behavior.html#/s:21PersonalityInsightsV38BehaviorV7traitIDSSvp":{"name":"traitID","abstract":"

The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form","parent_name":"Behavior"},"Structs/Behavior.html#/s:21PersonalityInsightsV38BehaviorV4nameSSvp":{"name":"name","abstract":"

The user-visible, localized name of the characteristic.

","parent_name":"Behavior"},"Structs/Behavior.html#/s:21PersonalityInsightsV38BehaviorV8categorySSvp":{"name":"category","abstract":"

The category of the characteristic: behavior for temporal data.

","parent_name":"Behavior"},"Structs/Behavior.html#/s:21PersonalityInsightsV38BehaviorV10percentageSdvp":{"name":"percentage","abstract":"

For JSON content that is timestamped, the percentage of timestamped input data that occurred during that day of the","parent_name":"Behavior"},"Structs/Behavior.html":{"name":"Behavior","abstract":"

Behavior.

"},"Structs/ConsumptionPreferences.html":{"name":"ConsumptionPreferences","abstract":"

ConsumptionPreferences.

"},"Structs/ConsumptionPreferencesCategory.html":{"name":"ConsumptionPreferencesCategory","abstract":"

ConsumptionPreferencesCategory.

"},"Structs/Content.html":{"name":"Content","abstract":"

Content.

"},"Structs/ContentItem.html":{"name":"ContentItem","abstract":"

ContentItem.

"},"Structs/Profile.html":{"name":"Profile","abstract":"

Profile.

"},"Structs/Trait.html":{"name":"Trait","abstract":"

Trait.

"},"Structs/Warning.html":{"name":"Warning","abstract":"

Warning.

"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

No response was received from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

No data was returned from the server.

","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO013serializationE0A2CmF":{"name":"serializationError","abstract":"

Failed to serialize value(s) to data.

","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO08encodingE0A2CmF":{"name":"encodingError","abstract":"

Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO011fileManagerE0A2CmF":{"name":"fileManagerError","abstract":"

FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

Failed to load the given file.

","parent_name":"RestError"},"Enums/RestError.html#/s:21PersonalityInsightsV39RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

An HTTP error with a status code and description.

","parent_name":"RestError"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO4nullA2CmF":{"name":"null","abstract":"

A null value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

A boolean value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO6stringACSScACmF":{"name":"string","abstract":"

A string value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO3intACSicACmF":{"name":"int","abstract":"

A number value, represented as an integer.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO6doubleACSdcACmF":{"name":"double","abstract":"

A number value, represented as a double.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

An array value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

An object value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

Decode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

Initialize a JSON value from an encodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

Convert this JSON value to a decodable type.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

Encode a JSON value.

","parent_name":"JSON"},"Enums/JSON.html#/s:21PersonalityInsightsV34JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Compare two JSON values for equality.

","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

A JSON value (one of string, number, object, array, true, false, or null).

"},"Enums/RestError.html":{"name":"RestError","abstract":"

An error from processing a network request or response.

"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

The base URL to use when contacting the service.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

The default HTTP headers for all requests to the service.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

Create a PersonalityInsights object.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

Create a PersonalityInsights object.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

Create a PersonalityInsights object.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

Undocumented

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C7profileyAA7ContentV7content_SSSg0F8LanguageAH06acceptG0SbSg9rawScoresAK22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA7ProfileVc7successtF":{"name":"profile(content:contentLanguage:acceptLanguage:rawScores:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C7profileySS4text_SSSg15contentLanguageAF06acceptG0SbSg9rawScoresAI22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA7ProfileVc7successtF":{"name":"profile(text:contentLanguage:acceptLanguage:rawScores:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C7profileySS4html_SSSg15contentLanguageAF06acceptG0SbSg9rawScoresAI22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA7ProfileVc7successtF":{"name":"profile(html:contentLanguage:acceptLanguage:rawScores:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C12profileAsCsvyAA7ContentV7content_SSSg0H8LanguageAH06acceptI0SbSg9rawScoresAK10csvHeadersAK22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureySSc7successtF":{"name":"profileAsCsv(content:contentLanguage:acceptLanguage:rawScores:csvHeaders:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile as csv.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C12profileAsCsvySS4text_SSSg15contentLanguageAF06acceptI0SbSg9rawScoresAI10csvHeadersAI22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureySSc7successtF":{"name":"profileAsCsv(text:contentLanguage:acceptLanguage:rawScores:csvHeaders:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile as csv.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html#/s:21PersonalityInsightsV30aB0C12profileAsCsvySS4html_SSSg15contentLanguageAF06acceptI0SbSg9rawScoresAI10csvHeadersAI22consumptionPreferencess10DictionaryVyS2SGSg7headersys5Error_pcSg7failureySSc7successtF":{"name":"profileAsCsv(html:contentLanguage:acceptLanguage:rawScores:csvHeaders:consumptionPreferences:headers:failure:success:)","abstract":"

Get profile as csv.

","parent_name":"PersonalityInsights"},"Classes/PersonalityInsights.html":{"name":"PersonalityInsights","abstract":"

The IBM Watson™ Personality Insights service enables applications to derive insights from social media,"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"}} \ No newline at end of file diff --git a/docs/swift-api/services/PersonalityInsightsV3/undocumented.json b/docs/swift-api/services/PersonalityInsightsV3/undocumented.json index 2c42f3adb..e5fa39989 100644 --- a/docs/swift-api/services/PersonalityInsightsV3/undocumented.json +++ b/docs/swift-api/services/PersonalityInsightsV3/undocumented.json @@ -2,133 +2,133 @@ "warnings": [ { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/ContentItem.swift", - "line": 24, + "line": 27, "symbol": "ContentItem.Contenttype.plain", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/ContentItem.swift", - "line": 25, + "line": 28, "symbol": "ContentItem.Contenttype.html", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/ContentItem.swift", - "line": 30, + "line": 40, "symbol": "ContentItem.Language.ar", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/ContentItem.swift", - "line": 31, + "line": 41, "symbol": "ContentItem.Language.en", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/ContentItem.swift", - "line": 32, + "line": 42, "symbol": "ContentItem.Language.es", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/ContentItem.swift", - "line": 33, + "line": 43, "symbol": "ContentItem.Language.ja", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/ContentItem.swift", - "line": 34, + "line": 44, "symbol": "ContentItem.Language.ko", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Profile.swift", - "line": 24, + "line": 26, "symbol": "Profile.ProcessedLanguage.ar", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Profile.swift", - "line": 25, + "line": 27, "symbol": "Profile.ProcessedLanguage.en", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Profile.swift", - "line": 26, + "line": 28, "symbol": "Profile.ProcessedLanguage.es", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Profile.swift", - "line": 27, + "line": 29, "symbol": "Profile.ProcessedLanguage.ja", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Profile.swift", - "line": 28, + "line": 30, "symbol": "Profile.ProcessedLanguage.ko", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Trait.swift", - "line": 24, + "line": 27, "symbol": "Trait.Category.personality", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Trait.swift", - "line": 25, + "line": 28, "symbol": "Trait.Category.needs", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Trait.swift", - "line": 26, + "line": 29, "symbol": "Trait.Category.values", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Warning.swift", - "line": 24, + "line": 26, "symbol": "Warning.WarningID.wordCountMessage", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Warning.swift", - "line": 25, + "line": 27, "symbol": "Warning.WarningID.jsonAsText", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Warning.swift", - "line": 26, + "line": 28, "symbol": "Warning.WarningID.contentTruncated", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Warning.swift", - "line": 27, + "line": 29, "symbol": "Warning.WarningID.partialTextUsed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" diff --git a/docs/swift-api/services/SpeechToTextV1/Classes.html b/docs/swift-api/services/SpeechToTextV1/Classes.html index c78ec0b8a..7a4471d40 100644 --- a/docs/swift-api/services/SpeechToTextV1/Classes.html +++ b/docs/swift-api/services/SpeechToTextV1/Classes.html @@ -113,9 +113,6 @@ - @@ -317,7 +314,7 @@

Declaration

diff --git a/docs/swift-api/services/SpeechToTextV1/Classes/SpeechToText.html b/docs/swift-api/services/SpeechToTextV1/Classes/SpeechToText.html index 52b04d62f..fceddefa0 100644 --- a/docs/swift-api/services/SpeechToTextV1/Classes/SpeechToText.html +++ b/docs/swift-api/services/SpeechToTextV1/Classes/SpeechToText.html @@ -113,9 +113,6 @@ - @@ -561,10 +558,10 @@

Declaration

-

Get models.

+

List models.

-

Retrieves a list of all language models that are available for use with the service. The information includes the -name of the model and its minimum sampling rate in Hertz, among other things.

+

Lists all language models that are available for use with the service. The information includes the name of the +model and its minimum sampling rate in Hertz, among other things.

@@ -639,8 +636,8 @@

Parameters

Get a model.

-

Retrieves information about a single specified language model that is available for use with the service. The -information includes the name of the model and its minimum sampling rate in Hertz, among other things.

+

Gets information for a single specified language model that is available for use with the service. The information +includes the name of the model and its minimum sampling rate in Hertz, among other things.

@@ -726,34 +723,54 @@

Parameters

-

Sends audio for speech recognition in sessionless mode.

+

Recognize audio.

Sends audio and returns transcription results for a sessionless recognition request. Returns only the final results; to enable interim results, use session-based requests or the WebSocket API. The service imposes a data size limit of 100 MB. It automatically detects the endianness of the incoming audio and, for audio that includes multiple channels, downmixes the audio to one-channel mono during transcoding. (For the audio/l16 format, you can -specify the endianness.) ### Streaming mode For requests to transcribe live audio as it becomes available, you -must set the Transfer-Encoding header to chunked to use streaming mode. In streaming mode, the server closes -the connection (status code 408) if the service receives no data chunk for 30 seconds and the service has no audio -to transcribe for 30 seconds. The server also closes the connection (status code 400) if no speech is detected for -inactivity_timeout seconds of audio (not processing time); use the inactivity_timeout parameter to change the -default of 30 seconds. ### Audio formats (content types) Use the Content-Type header to specify the audio -format (MIME type) of the audio. The service accepts the following formats: * audio/basic (Use only with -narrowband models.) * audio/flac * audio/l16 (Specify the sampling rate (rate) and optionally the number of -channels (channels) and endianness (endianness) of the audio.) * audio/mp3 * audio/mpeg * audio/mulaw -(Specify the sampling rate (rate) of the audio.) * audio/ogg (The service automatically detects the codec of -the input audio.) * audio/ogg;codecs=opus * audio/ogg;codecs=vorbis * audio/wav (Provide audio with a maximum -of nine channels.) * audio/webm (The service automatically detects the codec of the input audio.) * -audio/webm;codecs=opus * audio/webm;codecs=vorbis For information about the supported audio formats, -including specifying the sampling rate, channels, and endianness for the indicated formats, see Audio -formats. ### Multipart speech -recognition The method also supports multipart recognition requests. With multipart requests, you pass all audio -data as multipart form data. You specify some parameters as request headers and query parameters, but you pass JSON -metadata as form data to control most aspects of the transcription. The multipart approach is intended for use -with browsers for which JavaScript is disabled or when the parameters used with the request are greater than the 8 -KB limit imposed by most HTTP servers and proxies. You can encounter this limit, for example, if you want to spot a -very large number of keywords. For information about submitting a multipart request, see Submitting multipart -requests as form data.

+specify the endianness.)

+

Streaming mode

+ +

For requests to transcribe live audio as it becomes available, you must set the Transfer-Encoding header to +chunked to use streaming mode. In streaming mode, the server closes the connection (status code 408) if the +service receives no data chunk for 30 seconds and the service has no audio to transcribe for 30 seconds. The server +also closes the connection (status code 400) if no speech is detected for inactivity_timeout seconds of audio +(not processing time); use the inactivity_timeout parameter to change the default of 30 seconds.

+

Audio formats (content types)

+ +

Use the Content-Type header to specify the audio format (MIME type) of the audio. The service accepts the +following formats:

+ +
    +
  • audio/basic (Use only with narrowband models.)
  • +
  • audio/flac
  • +
  • audio/l16 (Specify the sampling rate (rate) and optionally the number of channels (channels) and endianness +(endianness) of the audio.)
  • +
  • audio/mp3
  • +
  • audio/mpeg
  • +
  • audio/mulaw (Specify the sampling rate (rate) of the audio.)
  • +
  • audio/ogg (The service automatically detects the codec of the input audio.)
  • +
  • audio/ogg;codecs=opus
  • +
  • audio/ogg;codecs=vorbis
  • +
  • audio/wav (Provide audio with a maximum of nine channels.)
  • +
  • audio/webm (The service automatically detects the codec of the input audio.)
  • +
  • audio/webm;codecs=opus
  • +
  • audio/webm;codecs=vorbis +For information about the supported audio formats, including specifying the sampling rate, channels, and endianness +for the indicated formats, see Audio +formats.

    +

    Multipart speech recognition

    + +

    The method also supports multipart recognition requests. With multipart requests, you pass all audio data as +multipart form data. You specify some parameters as request headers and query parameters, but you pass JSON +metadata as form data to control most aspects of the transcription. +The multipart approach is intended for use with browsers for which JavaScript is disabled or when the parameters +used with the request are greater than the 8 KB limit imposed by most HTTP servers and proxies. You can encounter +this limit, for example, if you want to spot a very large number of keywords. +For information about submitting a multipart request, see Submitting multipart requests as form +data.

  • +
@@ -822,8 +839,8 @@

Parameters

-

The identifier of the model that is to be used for the recognition request or, for the Create a session method, -with the new session.

+

The identifier of the model that is to be used for the recognition request or, for the Create a session +method, with the new session.

@@ -835,10 +852,10 @@

Parameters

-

The customization ID (GUID) of a custom language model that is to be used with the recognition request or, for the -Create a session method, with the new session. The base model of the specified custom language model must match -the model specified with the model parameter. You must make the request with service credentials created for the -instance of the service that owns the custom model. By default, no custom language model is used.

+

The customization ID (GUID) of a custom language model that is to be used with the recognition request or, for +the Create a session method, with the new session. The base model of the specified custom language model must +match the model specified with the model parameter. You must make the request with service credentials created +for the instance of the service that owns the custom model. By default, no custom language model is used.

@@ -850,10 +867,10 @@

Parameters

-

The customization ID (GUID) of a custom acoustic model that is to be used with the recognition request or, for the -Create a session method, with the new session. The base model of the specified custom acoustic model must match -the model specified with the model parameter. You must make the request with service credentials created for the -instance of the service that owns the custom model. By default, no custom acoustic model is used.

+

The customization ID (GUID) of a custom acoustic model that is to be used with the recognition request or, for +the Create a session method, with the new session. The base model of the specified custom acoustic model must +match the model specified with the model parameter. You must make the request with service credentials created +for the instance of the service that owns the custom model. By default, no custom acoustic model is used.

@@ -867,9 +884,10 @@

Parameters

The version of the specified base model that is to be used with recognition request or, for the Create a session method, with the new session. Multiple versions of a base model can exist when a model is updated for -internal improvements. The parameter is intended primarily for use with custom models that have been upgraded for a -new base model. The default value depends on whether the parameter is used with or without a custom model. For more -information, see Base model version.

+internal improvements. The parameter is intended primarily for use with custom models that have been upgraded for +a new base model. The default value depends on whether the parameter is used with or without a custom model. For +more information, see Base model +version.

@@ -882,14 +900,14 @@

Parameters

If you specify the customization ID (GUID) of a custom language model with the recognition request or, for -sessions, with the Create a session method, the customization weight tells the service how much weight to give -to words from the custom language model compared to those from the base model for the current request. Specify a -value between 0.0 and 1.0. Unless a different customization weight was specified for the custom model when it was -trained, the default value is 0.3. A customization weight that you specify overrides a weight that was specified -when the custom model was trained. The default value yields the best performance in general. Assign a higher -value if your audio makes frequent use of OOV words from the custom model. Use caution when setting the weight: a -higher value can improve the accuracy of phrases from the custom model’s domain, but it can negatively affect -performance on non-domain phrases.

+sessions, with the Create a session method, the customization weight tells the service how much weight to +give to words from the custom language model compared to those from the base model for the current request. +Specify a value between 0.0 and 1.0. Unless a different customization weight was specified for the custom model +when it was trained, the default value is 0.3. A customization weight that you specify overrides a weight that +was specified when the custom model was trained. +The default value yields the best performance in general. Assign a higher value if your audio makes frequent use +of OOV words from the custom model. Use caution when setting the weight: a higher value can improve the accuracy +of phrases from the custom model’s domain, but it can negatively affect performance on non-domain phrases.

@@ -902,8 +920,8 @@

Parameters

The time in seconds after which, if only silence (no speech) is detected in submitted audio, the connection is -closed with a 400 error. Useful for stopping audio submission from a live microphone when a user simply walks away. -Use -1 for infinity.

+closed with a 400 error. The parameter is useful for stopping audio submission from a live microphone when a user +simply walks away. Use -1 for infinity.

@@ -915,10 +933,10 @@

Parameters

-

An array of keyword strings to spot in the audio. Each keyword string can include one or more tokens. Keywords are -spotted only in the final hypothesis, not in interim results. If you specify any keywords, you must also specify a -keywords threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify an empty array if you do -not need to spot keywords.

+

An array of keyword strings to spot in the audio. Each keyword string can include one or more tokens. Keywords +are spotted only in the final results, not in interim hypotheses. If you specify any keywords, you must also +specify a keywords threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify an empty +array if you do not need to spot keywords.

@@ -957,9 +975,9 @@

Parameters

-

A confidence value that is the lower bound for identifying a hypothesis as a possible word alternative (also known -as \Confusion Networks\). An alternative word is considered if its confidence is greater than or equal to the -threshold. Specify a probability between 0 and 1 inclusive. No alternative words are computed if you omit the +

A confidence value that is the lower bound for identifying a hypothesis as a possible word alternative (also +known as \Confusion Networks\). An alternative word is considered if its confidence is greater than or equal to +the threshold. Specify a probability between 0 and 1 inclusive. No alternative words are computed if you omit the parameter.

@@ -1012,8 +1030,8 @@

Parameters

If true, converts dates, times, series of digits and numbers, phone numbers, currency values, and internet -addresses into more readable, conventional representations in the final transcript of a recognition request. For US -English, also converts certain keyword strings to punctuation symbols. By default, no smart formatting is +addresses into more readable, conventional representations in the final transcript of a recognition request. For +US English, also converts certain keyword strings to punctuation symbols. By default, no smart formatting is performed. Applies to US English and Spanish transcription only.

@@ -1028,9 +1046,9 @@

Parameters

If true, the response includes labels that identify which words were spoken by which participants in a multi-person exchange. By default, no speaker labels are returned. Setting speaker_labels to true forces the -timestamps parameter to be true, regardless of whether you specify false for the parameter. To determine -whether a language model supports speaker labels, use the Get models method and check that the attribute -speaker_labels is set to true. You can also refer to Speaker +timestamps parameter to be true, regardless of whether you specify false for the parameter. +To determine whether a language model supports speaker labels, use the Get models method and check that the +attribute speaker_labels is set to true. You can also refer to Speaker labels.

@@ -1099,18 +1117,20 @@

Parameters

To be registered successfully, the callback URL must respond to the GET request from the service. The response must send status code 200 and must include the challenge string in its body. Set the Content-Type response header to text/plain. Upon receiving this response, the service responds to the original registration request with -response code 201. The service sends only a single GET request to the callback URL. If the service does not -receive a reply with a response code of 200 and a body that echoes the challenge string sent by the service within -five seconds, it does not white-list the URL; it instead sends status code 400 in response to the Register a -callback request. If the requested callback URL is already white-listed, the service responds to the initial -registration request with response code 200. If you specify a user secret with the request, the service uses it -as a key to calculate an HMAC-SHA1 signature of the challenge string in its response to the POST request. It -sends this signature in the X-Callback-Signature header of its GET request to the URL during registration. It -also uses the secret to calculate a signature over the payload of every callback notification that uses the URL. -The signature provides authentication and data integrity for HTTP communications. After you successfully register -a callback URL, you can use it with an indefinite number of recognition requests. You can register a maximum of 20 -callback URLS in a one-hour span of time. For more information, see Registering a callback -URL.

+response code 201. +The service sends only a single GET request to the callback URL. If the service does not receive a reply with a +response code of 200 and a body that echoes the challenge string sent by the service within five seconds, it does +not white-list the URL; it instead sends status code 400 in response to the Register a callback request. If the +requested callback URL is already white-listed, the service responds to the initial registration request with +response code 200. +If you specify a user secret with the request, the service uses it as a key to calculate an HMAC-SHA1 signature of +the challenge string in its response to the POST request. It sends this signature in the X-Callback-Signature +header of its GET request to the URL during registration. It also uses the secret to calculate a signature over +the payload of every callback notification that uses the URL. The signature provides authentication and data +integrity for HTTP communications. +After you successfully register a callback URL, you can use it with an indefinite number of recognition requests. +You can register a maximum of 20 callback URLS in a one-hour span of time. For more information, see Registering a +callback URL.

@@ -1138,9 +1158,9 @@

Parameters

-

An HTTP or HTTPS URL to which callback notifications are to be sent. To be white-listed, the URL must successfully -echo the challenge string during URL verification. During verification, the client can also check the signature -that the service sends in the X-Callback-Signature header to verify the origin of the request.

+

An HTTP or HTTPS URL to which callback notifications are to be sent. To be white-listed, the URL must +successfully echo the challenge string during URL verification. During verification, the client can also check +the signature that the service sends in the X-Callback-Signature header to verify the origin of the request.

@@ -1153,9 +1173,9 @@

Parameters

A user-specified string that the service uses to generate the HMAC-SHA1 signature that it sends via the -X-Callback-Signature header. The service includes the header during URL verification and with every notification -sent to the callback URL. It calculates the signature over the payload of the notification. If you omit the -parameter, the service does not send the header.

+X-Callback-Signature header. The service includes the header during URL verification and with every +notification sent to the callback URL. It calculates the signature over the payload of the notification. If you +omit the parameter, the service does not send the header.

@@ -1307,32 +1327,52 @@

Parameters

Creates a job for a new asynchronous recognition request. The job is owned by the user whose service credentials are used to create it. How you learn the status and results of a job depends on the parameters you include with the -job creation request: * By callback notification: Include the callback_url parameter to specify a URL to which -the service is to send callback notifications when the status of the job changes. Optionally, you can also include -the events and user_token parameters to subscribe to specific events and to specify a string that is to be -included with each notification for the job. * By polling the service: Omit the callback_url, events, and -user_token parameters. You must then use the Check jobs or Check a job methods to check the status of the -job, using the latter to retrieve the results when the job is complete. The two approaches are not mutually -exclusive. You can poll the service for job status or obtain results from the service manually even if you include -a callback URL. In both cases, you can include the results_ttl parameter to specify how long the results are to -remain available after the job is complete. For detailed usage information about the two approaches, including -callback notifications, see Creating a +job creation request:

+ +
@@ -1405,8 +1445,8 @@

Parameters

-

The identifier of the model that is to be used for the recognition request or, for the Create a session method, -with the new session.

+

The identifier of the model that is to be used for the recognition request or, for the Create a session +method, with the new session.

@@ -1419,9 +1459,10 @@

Parameters

A URL to which callback notifications are to be sent. The URL must already be successfully white-listed by using -the Register a callback method. Omit the parameter to poll the service for job completion and results. You can -include the same callback URL with any number of job creation requests. Use the user_token parameter to specify a -unique user-specified string with each job to differentiate the callback notifications for the jobs.

+the Register a callback method. You can include the same callback URL with any number of job creation +requests. Omit the parameter to poll the service for job completion and results. +Use the user_token parameter to specify a unique user-specified string with each job to differentiate the +callback notifications for the jobs.

@@ -1434,15 +1475,21 @@

Parameters

If the job includes a callback URL, a comma-separated list of notification events to which to subscribe. Valid -events are: recognitions.started generates a callback notification when the service begins to process the job. -recognitions.completed generates a callback notification when the job is complete; you must use the Check a -job method to retrieve the results before they time out or are deleted. recognitions.completed_with_results -generates a callback notification when the job is complete; the notification includes the results of the request. -recognitions.failed generates a callback notification if the service experiences an error while processing the -job. Omit the parameter to subscribe to the default events: recognitions.started, recognitions.completed, and +events are

+ +
    +
  • recognitions.started generates a callback notification when the service begins to process the job.
  • +
  • recognitions.completed generates a callback notification when the job is complete. You must use the Check a +job method to retrieve the results before they time out or are deleted.
  • +
  • recognitions.completed_with_results generates a callback notification when the job is complete. The +notification includes the results of the request.
  • +
  • recognitions.failed generates a callback notification if the service experiences an error while processing +the job. +Omit the parameter to subscribe to the default events: recognitions.started, recognitions.completed, and recognitions.failed. The recognitions.completed and recognitions.completed_with_results events are incompatible; you can specify only of the two events. If the job does not include a callback URL, omit the -parameter.

    +parameter.
  • +
@@ -1468,9 +1515,9 @@

Parameters

-

The number of minutes for which the results are to be available after the job has finished. If not delivered via a -callback, the results must be retrieved within this time. Omit the parameter to use a time to live of one week. The -parameter is valid with or without a callback URL.

+

The number of minutes for which the results are to be available after the job has finished. If not delivered via +a callback, the results must be retrieved within this time. Omit the parameter to use a time to live of one week. +The parameter is valid with or without a callback URL.

@@ -1482,10 +1529,10 @@

Parameters

-

The customization ID (GUID) of a custom language model that is to be used with the recognition request or, for the -Create a session method, with the new session. The base model of the specified custom language model must match -the model specified with the model parameter. You must make the request with service credentials created for the -instance of the service that owns the custom model. By default, no custom language model is used.

+

The customization ID (GUID) of a custom language model that is to be used with the recognition request or, for +the Create a session method, with the new session. The base model of the specified custom language model must +match the model specified with the model parameter. You must make the request with service credentials created +for the instance of the service that owns the custom model. By default, no custom language model is used.

@@ -1497,10 +1544,10 @@

Parameters

-

The customization ID (GUID) of a custom acoustic model that is to be used with the recognition request or, for the -Create a session method, with the new session. The base model of the specified custom acoustic model must match -the model specified with the model parameter. You must make the request with service credentials created for the -instance of the service that owns the custom model. By default, no custom acoustic model is used.

+

The customization ID (GUID) of a custom acoustic model that is to be used with the recognition request or, for +the Create a session method, with the new session. The base model of the specified custom acoustic model must +match the model specified with the model parameter. You must make the request with service credentials created +for the instance of the service that owns the custom model. By default, no custom acoustic model is used.

@@ -1514,9 +1561,10 @@

Parameters

The version of the specified base model that is to be used with recognition request or, for the Create a session method, with the new session. Multiple versions of a base model can exist when a model is updated for -internal improvements. The parameter is intended primarily for use with custom models that have been upgraded for a -new base model. The default value depends on whether the parameter is used with or without a custom model. For more -information, see Base model version.

+internal improvements. The parameter is intended primarily for use with custom models that have been upgraded for +a new base model. The default value depends on whether the parameter is used with or without a custom model. For +more information, see Base model +version.

@@ -1529,14 +1577,14 @@

Parameters

If you specify the customization ID (GUID) of a custom language model with the recognition request or, for -sessions, with the Create a session method, the customization weight tells the service how much weight to give -to words from the custom language model compared to those from the base model for the current request. Specify a -value between 0.0 and 1.0. Unless a different customization weight was specified for the custom model when it was -trained, the default value is 0.3. A customization weight that you specify overrides a weight that was specified -when the custom model was trained. The default value yields the best performance in general. Assign a higher -value if your audio makes frequent use of OOV words from the custom model. Use caution when setting the weight: a -higher value can improve the accuracy of phrases from the custom model’s domain, but it can negatively affect -performance on non-domain phrases.

+sessions, with the Create a session method, the customization weight tells the service how much weight to +give to words from the custom language model compared to those from the base model for the current request. +Specify a value between 0.0 and 1.0. Unless a different customization weight was specified for the custom model +when it was trained, the default value is 0.3. A customization weight that you specify overrides a weight that +was specified when the custom model was trained. +The default value yields the best performance in general. Assign a higher value if your audio makes frequent use +of OOV words from the custom model. Use caution when setting the weight: a higher value can improve the accuracy +of phrases from the custom model’s domain, but it can negatively affect performance on non-domain phrases.

@@ -1549,8 +1597,8 @@

Parameters

The time in seconds after which, if only silence (no speech) is detected in submitted audio, the connection is -closed with a 400 error. Useful for stopping audio submission from a live microphone when a user simply walks away. -Use -1 for infinity.

+closed with a 400 error. The parameter is useful for stopping audio submission from a live microphone when a user +simply walks away. Use -1 for infinity.

@@ -1562,10 +1610,10 @@

Parameters

-

An array of keyword strings to spot in the audio. Each keyword string can include one or more tokens. Keywords are -spotted only in the final hypothesis, not in interim results. If you specify any keywords, you must also specify a -keywords threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify an empty array if you do -not need to spot keywords.

+

An array of keyword strings to spot in the audio. Each keyword string can include one or more tokens. Keywords +are spotted only in the final results, not in interim hypotheses. If you specify any keywords, you must also +specify a keywords threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify an empty +array if you do not need to spot keywords.

@@ -1604,9 +1652,9 @@

Parameters

-

A confidence value that is the lower bound for identifying a hypothesis as a possible word alternative (also known -as \Confusion Networks\). An alternative word is considered if its confidence is greater than or equal to the -threshold. Specify a probability between 0 and 1 inclusive. No alternative words are computed if you omit the +

A confidence value that is the lower bound for identifying a hypothesis as a possible word alternative (also +known as \Confusion Networks\). An alternative word is considered if its confidence is greater than or equal to +the threshold. Specify a probability between 0 and 1 inclusive. No alternative words are computed if you omit the parameter.

@@ -1659,8 +1707,8 @@

Parameters

If true, converts dates, times, series of digits and numbers, phone numbers, currency values, and internet -addresses into more readable, conventional representations in the final transcript of a recognition request. For US -English, also converts certain keyword strings to punctuation symbols. By default, no smart formatting is +addresses into more readable, conventional representations in the final transcript of a recognition request. For +US English, also converts certain keyword strings to punctuation symbols. By default, no smart formatting is performed. Applies to US English and Spanish transcription only.

@@ -1675,9 +1723,9 @@

Parameters

If true, the response includes labels that identify which words were spoken by which participants in a multi-person exchange. By default, no speaker labels are returned. Setting speaker_labels to true forces the -timestamps parameter to be true, regardless of whether you specify false for the parameter. To determine -whether a language model supports speaker labels, use the Get models method and check that the attribute -speaker_labels is set to true. You can also refer to Speaker +timestamps parameter to be true, regardless of whether you specify false for the parameter. +To determine whether a language model supports speaker labels, use the Get models method and check that the +attribute speaker_labels is set to true. You can also refer to Speaker labels.

@@ -1821,11 +1869,11 @@

Parameters

Returns information about the specified job. The response always includes the status of the job and its creation and update times. If the status is completed, the response includes the results of the recognition request. You -must submit the request with the service credentials of the user who created the job. You can use the method to -retrieve the results of any job, regardless of whether it was submitted with a callback URL and the -recognitions.completed_with_results event, and you can retrieve the results multiple times for as long as they -remain available. Use the Check jobs method to request information about the most recent jobs associated with -the calling user.

+must submit the request with the service credentials of the user who created the job. +You can use the method to retrieve the results of any job, regardless of whether it was submitted with a callback +URL and the recognitions.completed_with_results event, and you can retrieve the results multiple times for as +long as they remain available. Use the Check jobs method to request information about the most recent jobs +associated with the calling user.

@@ -2005,7 +2053,7 @@

Parameters

Creates a new custom language model for a specified base model. The custom language model can be used only with the base model for which it is created. The model is owned by the instance of the service whose credentials are used to -create it. You must pass a value of application/json with the Content-Type header.

+create it.

@@ -2094,7 +2142,7 @@

Parameters

List custom language models.

Lists information about all custom language models that are owned by an instance of the service. Use the language -parameter to see all custom language models for the specified language; omit the parameter to see all custom +parameter to see all custom language models for the specified language. Omit the parameter to see all custom language models for all languages. You must use credentials for the instance of the service that owns a model to list information about it.

@@ -2123,9 +2171,9 @@

Parameters

-

The identifier of the language for which custom language or custom acoustic models are to be returned (for example, -en-US). Omit the parameter to see all custom language or custom acoustic models owned by the requesting service -credentials.

+

The identifier of the language for which custom language or custom acoustic models are to be returned (for +example, en-US). Omit the parameter to see all custom language or custom acoustic models owned by the +requesting service credentials.

@@ -2184,9 +2232,9 @@

Parameters

-

List a custom language model.

+

Get a custom language model.

-

Lists information about a specified custom language model. You must use credentials for the instance of the service +

Gets information about a specified custom language model. You must use credentials for the instance of the service that owns a model to list information about it.

@@ -2371,17 +2419,23 @@

Parameters

or deleting corpora or words for a custom language model, use this method to begin the actual training of the model on the latest data. You can specify whether the custom language model is to be trained with all words from its words resource or only with words that were added or modified by the user. You must use credentials for the -instance of the service that owns a model to train it. The training method is asynchronous. It can take on the -order of minutes to complete depending on the amount of data on which the service is being trained and the current -load on the service. The method returns an HTTP 200 response code to indicate that the training process has begun. - You can monitor the status of the training by using the List a custom language model method to poll the -model’s status. Use a loop to check the status every 10 seconds. The method returns a Customization object that -includes status and progress fields. A status of available means that the custom model is trained and ready -to use. The service cannot accept subsequent training requests, or requests to add new corpora or words, until the -existing request completes. Training can fail to start for the following reasons: * The service is currently -handling another request for the custom model, such as another training request or a request to add a corpus or -words to the model. * No training data (corpora or words) have been added to the custom model. * One or more words -that were added to the custom model have invalid sounds-like pronunciations that you must fix.

+instance of the service that owns a model to train it. +The training method is asynchronous. It can take on the order of minutes to complete depending on the amount of +data on which the service is being trained and the current load on the service. The method returns an HTTP 200 +response code to indicate that the training process has begun. +You can monitor the status of the training by using the Get a custom language model method to poll the model’s +status. Use a loop to check the status every 10 seconds. The method returns a LanguageModel object that includes +status and progress fields. A status of available means that the custom model is trained and ready to use. +The service cannot accept subsequent training requests, or requests to add new corpora or words, until the existing +request completes. +Training can fail to start for the following reasons:

+ +
    +
  • The service is currently handling another request for the custom model, such as another training request or a +request to add a corpus or words to the model.
  • +
  • No training data (corpora or words) have been added to the custom model.
  • +
  • One or more words that were added to the custom model have invalid sounds-like pronunciations that you must fix.

  • +
@@ -2423,10 +2477,14 @@

Parameters

-

The type of words from the custom language model’s words resource on which to train the model: * all (the -default) trains the model on all new words, regardless of whether they were extracted from corpora or were added or -modified by the user. * user trains the model only on new words that were added or modified by the user; the -model is not trained on new words extracted from corpora.

+

The type of words from the custom language model’s words resource on which to train the model:

+ +
    +
  • all (the default) trains the model on all new words, regardless of whether they were extracted from corpora +or were added or modified by the user.
  • +
  • user trains the model only on new words that were added or modified by the user; the model is not trained on +new words extracted from corpora.
  • +
@@ -2438,14 +2496,14 @@

Parameters

-

Specifies a customization weight for the custom language model. The customization weight tells the service how much -weight to give to words from the custom language model compared to those from the base model for speech -recognition. Specify a value between 0.0 and 1.0; the default is 0.3. The default value yields the best -performance in general. Assign a higher value if your audio makes frequent use of OOV words from the custom model. -Use caution when setting the weight: a higher value can improve the accuracy of phrases from the custom model’s -domain, but it can negatively affect performance on non-domain phrases. The value that you assign is used for all -recognition requests that use the model. You can override it for any recognition request by specifying a -customization weight for that request.

+

Specifies a customization weight for the custom language model. The customization weight tells the service how +much weight to give to words from the custom language model compared to those from the base model for speech +recognition. Specify a value between 0.0 and 1.0; the default is 0.3. +The default value yields the best performance in general. Assign a higher value if your audio makes frequent use +of OOV words from the custom model. Use caution when setting the weight: a higher value can improve the accuracy +of phrases from the custom model’s domain, but it can negatively affect performance on non-domain phrases. +The value that you assign is used for all recognition requests that use the model. You can override it for any +recognition request by specifying a customization weight for that request.

@@ -2601,12 +2659,14 @@

Parameters

Initiates the upgrade of a custom language model to the latest version of its base language model. The upgrade method is asynchronous. It can take on the order of minutes to complete depending on the amount of data in the custom model and the current load on the service. A custom model must be in the ready or available state to be -upgraded. You must use credentials for the instance of the service that owns a model to upgrade it. The method -returns an HTTP 200 response code to indicate that the upgrade process has begun successfully. You can monitor the -status of the upgrade by using the List a custom language model method to poll the model’s status. Use a loop -to check the status every 10 seconds. While it is being upgraded, the custom model has the status upgrading. When -the upgrade is complete, the model resumes the status that it had prior to upgrade. The service cannot accept -subsequent requests for the model until the upgrade completes. For more information, see Upgrading custom +upgraded. You must use credentials for the instance of the service that owns a model to upgrade it. +The method returns an HTTP 200 response code to indicate that the upgrade process has begun successfully. You can +monitor the status of the upgrade by using the Get a custom language model method to poll the model’s status. +The method returns a LanguageModel object that includes status and progress fields. Use a loop to check the +status every 10 seconds. While it is being upgraded, the custom model has the status upgrading. When the upgrade +is complete, the model resumes the status that it had prior to upgrade. The service cannot accept subsequent +requests for the model until the upgrade completes. +For more information, see Upgrading custom models.

@@ -2790,28 +2850,29 @@

Parameters

Adds a single corpus text file of new training data to a custom language model. Use multiple requests to submit multiple corpus text files. You must use credentials for the instance of the service that owns a model to add a corpus to it. Adding a corpus does not affect the custom language model until you train the model for the new data -by using the Train a custom language model method. Submit a plain text file that contains sample sentences -from the domain of interest to enable the service to extract words in context. The more sentences you add that -represent the context in which speakers use words from the domain, the better the service’s recognition accuracy. -For guidelines about adding a corpus text file and for information about how the service parses a corpus file, see -Preparing a corpus text -file. The call -returns an HTTP 201 response code if the corpus is valid. The service then asynchronously processes the contents of -the corpus and automatically extracts new words that it finds. This can take on the order of a minute or two to -complete depending on the total number of words and the number of new words in the corpus, as well as the current -load on the service. You cannot submit requests to add additional corpora or words to the custom model, or to train -the model, until the service’s analysis of the corpus for the current request completes. Use the List a corpus -method to check the status of the analysis. The service auto-populates the model’s words resource with any word -that is not found in its base vocabulary; these are referred to as out-of-vocabulary (OOV) words. You can use the -List custom words method to examine the words resource, using other words method to eliminate typos and modify -how words are pronounced as needed. To add a corpus file that has the same name as an existing corpus, set the -allow_overwrite parameter to true; otherwise, the request fails. Overwriting an existing corpus causes the -service to process the corpus text file and extract OOV words anew. Before doing so, it removes any OOV words -associated with the existing corpus from the model’s words resource unless they were also added by another corpus -or they have been modified in some way with the Add custom words or Add a custom word method. The service -limits the overall amount of data that you can add to a custom model to a maximum of 10 million total words from -all corpora combined. Also, you can add no more than 30 thousand custom (OOV) words to a model; this includes words -that the service extracts from corpora and words that you add directly.

+by using the Train a custom language model method. +Submit a plain text file that contains sample sentences from the domain of interest to enable the service to +extract words in context. The more sentences you add that represent the context in which speakers use words from +the domain, the better the service’s recognition accuracy. For guidelines about adding a corpus text file and for +information about how the service parses a corpus file, see Preparing a corpus text +file. +The call returns an HTTP 201 response code if the corpus is valid. The service then asynchronously processes the +contents of the corpus and automatically extracts new words that it finds. This can take on the order of a minute +or two to complete depending on the total number of words and the number of new words in the corpus, as well as the +current load on the service. You cannot submit requests to add additional corpora or words to the custom model, or +to train the model, until the service’s analysis of the corpus for the current request completes. Use the List a +corpus method to check the status of the analysis. +The service auto-populates the model’s words resource with any word that is not found in its base vocabulary; these +are referred to as out-of-vocabulary (OOV) words. You can use the List custom words method to examine the words +resource, using other words method to eliminate typos and modify how words are pronounced as needed. +To add a corpus file that has the same name as an existing corpus, set the allow_overwrite parameter to true; +otherwise, the request fails. Overwriting an existing corpus causes the service to process the corpus text file and +extract OOV words anew. Before doing so, it removes any OOV words associated with the existing corpus from the +model’s words resource unless they were also added by another corpus or they have been modified in some way with +the Add custom words or Add a custom word method. +The service limits the overall amount of data that you can add to a custom model to a maximum of 10 million total +words from all corpora combined. Also, you can add no more than 30 thousand custom (OOV) words to a model; this +includes words that the service extracts from corpora and words that you add directly.

@@ -2855,9 +2916,9 @@

Parameters

-

The name of the corpus for the custom language model. When adding a corpus, do not include spaces in the name; use -a localized name that matches the language of the custom model; and do not use the name user, which is reserved -by the service to denote custom words added or modified by the user.

+

The name of the corpus for the custom language model. When adding a corpus, do not include spaces in the name; +use a localized name that matches the language of the custom model; and do not use the name user, which is +reserved by the service to denote custom words added or modified by the user.

@@ -2869,9 +2930,9 @@

Parameters

-

A plain text file that contains the training data for the corpus. Encode the file in UTF-8 if it contains non-ASCII -characters; the service assumes UTF-8 encoding if it encounters non-ASCII characters. With cURL, use the ---data-binary option to upload the file for the request.

+

A plain text file that contains the training data for the corpus. Encode the file in UTF-8 if it contains +non-ASCII characters; the service assumes UTF-8 encoding if it encounters non-ASCII characters. With cURL, use +the --data-binary option to upload the file for the request.

@@ -2884,8 +2945,8 @@

Parameters

If true, the specified corpus or audio resource overwrites an existing corpus or audio resource with the same -name. If false (the default), the request fails if a corpus or audio resource with the same name already exists. -The parameter has no effect if a corpus or audio resource with the same name does not already exist.

+name. If false (the default), the request fails if a corpus or audio resource with the same name already +exists. The parameter has no effect if a corpus or audio resource with the same name does not already exist.

@@ -2956,9 +3017,9 @@

Parameters

-

List a corpus.

+

Get a corpus.

-

Lists information about a corpus from a custom language model. The information includes the total number of words +

Gets information about a corpus from a custom language model. The information includes the total number of words and out-of-vocabulary (OOV) words, name, and status of the corpus. You must use credentials for the instance of the service that owns a model to list its corpora.

@@ -3001,9 +3062,9 @@

Parameters

-

The name of the corpus for the custom language model. When adding a corpus, do not include spaces in the name; use -a localized name that matches the language of the custom model; and do not use the name user, which is reserved -by the service to denote custom words added or modified by the user.

+

The name of the corpus for the custom language model. When adding a corpus, do not include spaces in the name; +use a localized name that matches the language of the custom model; and do not use the name user, which is +reserved by the service to denote custom words added or modified by the user.

@@ -3109,9 +3170,9 @@

Parameters

-

The name of the corpus for the custom language model. When adding a corpus, do not include spaces in the name; use -a localized name that matches the language of the custom model; and do not use the name user, which is reserved -by the service to denote custom words added or modified by the user.

+

The name of the corpus for the custom language model. When adding a corpus, do not include spaces in the name; +use a localized name that matches the language of the custom model; and do not use the name user, which is +reserved by the service to denote custom words added or modified by the user.

@@ -3218,9 +3279,13 @@

Parameters

-

The type of words to be listed from the custom language model’s words resource: * all (the default) shows all -words. * user shows only custom words that were added or modified by the user. * corpora shows only OOV that -were extracted from corpora.

+

The type of words to be listed from the custom language model’s words resource: + +

    +
  • all (the default) shows all words.
  • +
  • user shows only custom words that were added or modified by the user.
  • +
  • corpora shows only OOV that were extracted from corpora.
  • +

@@ -3232,11 +3297,11 @@

Parameters

-

Indicates the order in which the words are to be listed, alphabetical or by count. You can prepend an optional -+ or - to an argument to indicate whether the results are to be sorted in ascending or descending order. By -default, words are sorted in ascending alphabetical order. For alphabetical ordering, the lexicographical -precedence is numeric values, uppercase letters, and lowercase letters. For count ordering, values with the same -count are ordered alphabetically. With cURL, URL encode the + symbol as %2B.

+

Indicates the order in which the words are to be listed, alphabetical or by count. You can prepend an +optional + or - to an argument to indicate whether the results are to be sorted in ascending or descending +order. By default, words are sorted in ascending alphabetical order. For alphabetical ordering, the +lexicographical precedence is numeric values, uppercase letters, and lowercase letters. For count ordering, +values with the same count are ordered alphabetically. With cURL, URL encode the + symbol as %2B.

@@ -3301,36 +3366,40 @@

Parameters

model with out-of-vocabulary (OOV) words found in each corpus added to the model. You can use this method to add additional words or to modify existing words in the words resource. The words resource for a model can contain a maximum of 30 thousand custom (OOV) words, including words that the service extracts from corpora and words that -you add directly. You must use credentials for the instance of the service that owns a model to add or modify -custom words for the model. You must pass a value of application/json with the Content-Type header. Adding or -modifying custom words does not affect the custom model until you train the model for the new data by using the -Train a custom language model method. You add custom words by providing a Words object, which is an array -of Word objects, one per word. You must use the object’s word parameter to identify the word that is to be added. -You can also provide one or both of the optional sounds_like and display_as fields for each word. * The -sounds_like field provides an array of one or more pronunciations for the word. Use the parameter to specify how -the word can be pronounced by users. Use the parameter for words that are difficult to pronounce, foreign words, -acronyms, and so on. For example, you might specify that the word IEEE can sound like i triple e. You can -specify a maximum of five sounds-like pronunciations for a word. For information about pronunciation rules, see -Using the sounds_like -field. * The -display_as field provides a different way of spelling the word in a transcript. Use the parameter when you want -the word to appear different from its usual representation or from its spelling in corpora training data. For -example, you might indicate that the word IBM(trademark) is to be displayed as IBM. For more information, see -Using the display_as -field. If you add a -custom word that already exists in the words resource for the custom model, the new definition overwrites the -existing data for the word. If the service encounters an error with the input data, it returns a failure code and -does not add any of the words to the words resource. The call returns an HTTP 201 response code if the input data -is valid. It then asynchronously processes the words to add them to the model’s words resource. The time that it -takes for the analysis to complete depends on the number of new words that you add but is generally faster than -adding a corpus or training a model. You can monitor the status of the request by using the List a custom -language model method to poll the model’s status. Use a loop to check the status every 10 seconds. The method -returns a Customization object that includes a status field. A status of ready means that the words have been -added to the custom model. The service cannot accept requests to add new corpora or words or to train the model -until the existing request completes. You can use the List custom words or List a custom word method to -review the words that you add. Words with an invalid sounds_like field include an error field that describes -the problem. You can use other words-related methods to correct errors, eliminate typos, and modify how words are -pronounced as needed.

+you add directly. +You must use credentials for the instance of the service that owns a model to add or modify custom words for the +model. Adding or modifying custom words does not affect the custom model until you train the model for the new data +by using the Train a custom language model method. +You add custom words by providing a CustomWords object, which is an array of CustomWord objects, one per word. +You must use the object’s word parameter to identify the word that is to be added. You can also provide one or +both of the optional sounds_like and display_as fields for each word.

+ +
    +
  • The sounds_like field provides an array of one or more pronunciations for the word. Use the parameter to +specify how the word can be pronounced by users. Use the parameter for words that are difficult to pronounce, +foreign words, acronyms, and so on. For example, you might specify that the word IEEE can sound like i triple +e. You can specify a maximum of five sounds-like pronunciations for a word. For information about pronunciation +rules, see Using the sounds_like +field.
  • +
  • The display_as field provides a different way of spelling the word in a transcript. Use the parameter when you +want the word to appear different from its usual representation or from its spelling in corpora training data. For +example, you might indicate that the word IBM(trademark) is to be displayed as IBM&trade;. For more +information, see Using the display_as +field. +If you add a custom word that already exists in the words resource for the custom model, the new definition +overwrites the existing data for the word. If the service encounters an error with the input data, it returns a +failure code and does not add any of the words to the words resource. +The call returns an HTTP 201 response code if the input data is valid. It then asynchronously processes the words +to add them to the model’s words resource. The time that it takes for the analysis to complete depends on the +number of new words that you add but is generally faster than adding a corpus or training a model. +You can monitor the status of the request by using the List a custom language model method to poll the model’s +status. Use a loop to check the status every 10 seconds. The method returns a Customization object that includes +a status field. A status of ready means that the words have been added to the custom model. The service cannot +accept requests to add new corpora or words or to train the model until the existing request completes. +You can use the List custom words or List a custom word method to review the words that you add. Words with +an invalid sounds_like field include an error field that describes the problem. You can use other words-related +methods to correct errors, eliminate typos, and modify how words are pronounced as needed.

  • +
@@ -3436,26 +3505,29 @@

Parameters

Adds a custom word to a custom language model. The service populates the words resource for a custom model with out-of-vocabulary (OOV) words found in each corpus added to the model. You can use this method to add a word or to modify an existing word in the words resource. The words resource for a model can contain a maximum of 30 thousand -custom (OOV) words, including words that the service extracts from corpora and words that you add directly. You -must use credentials for the instance of the service that owns a model to add or modify a custom word for the -model. You must pass a value of application/json with the Content-Type header. Adding or modifying a custom -word does not affect the custom model until you train the model for the new data by using the Train a custom -language model method. Use the word_name parameter to specify the custom word that is to be added or -modified. Use the CustomWord object to provide one or both of the optional sounds_like and display_as fields -for the word. * The sounds_like field provides an array of one or more pronunciations for the word. Use the -parameter to specify how the word can be pronounced by users. Use the parameter for words that are difficult to -pronounce, foreign words, acronyms, and so on. For example, you might specify that the word IEEE can sound like -i triple e. You can specify a maximum of five sounds-like pronunciations for a word. For information about -pronunciation rules, see Using the sounds_like -field. * The -display_as field provides a different way of spelling the word in a transcript. Use the parameter when you want -the word to appear different from its usual representation or from its spelling in corpora training data. For -example, you might indicate that the word IBM(trademark) is to be displayed as IBM. For more information, see -Using the display_as -field. If you add a -custom word that already exists in the words resource for the custom model, the new definition overwrites the -existing data for the word. If the service encounters an error, it does not add the word to the words resource. Use -the List a custom word method to review the word that you add.

+custom (OOV) words, including words that the service extracts from corpora and words that you add directly. +You must use credentials for the instance of the service that owns a model to add or modify a custom word for the +model. Adding or modifying a custom word does not affect the custom model until you train the model for the new +data by using the Train a custom language model method. +Use the word_name parameter to specify the custom word that is to be added or modified. Use the CustomWord +object to provide one or both of the optional sounds_like and display_as fields for the word.

+ +
    +
  • The sounds_like field provides an array of one or more pronunciations for the word. Use the parameter to +specify how the word can be pronounced by users. Use the parameter for words that are difficult to pronounce, +foreign words, acronyms, and so on. For example, you might specify that the word IEEE can sound like i triple +e. You can specify a maximum of five sounds-like pronunciations for a word. For information about pronunciation +rules, see Using the sounds_like +field.
  • +
  • The display_as field provides a different way of spelling the word in a transcript. Use the parameter when you +want the word to appear different from its usual representation or from its spelling in corpora training data. For +example, you might indicate that the word IBM(trademark) is to be displayed as IBM&trade;. For more +information, see Using the display_as +field. +If you add a custom word that already exists in the words resource for the custom model, the new definition +overwrites the existing data for the word. If the service encounters an error, it does not add the word to the +words resource. Use the List a custom word method to review the word that you add.

  • +
@@ -3499,9 +3571,9 @@

Parameters

-

The custom word for the custom language model. When you add or update a custom word with the Add a custom word -method, do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of compound -words.

+

The custom word for the custom language model. When you add or update a custom word with the Add a custom +word method, do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of +compound words.

@@ -3515,7 +3587,8 @@

Parameters

For the Add custom words method, you must specify the custom word that is to be added to or updated in the custom model. Do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of -compound words. Omit this field for the Add a custom word method.

+compound words. +Omit this field for the Add a custom word method.

@@ -3529,11 +3602,11 @@

Parameters

An array of sounds-like pronunciations for the custom word. Specify how words that are difficult to pronounce, foreign words, acronyms, and so on can be pronounced by users. For a word that is not in the service’s base -vocabulary, omit the parameter to have the service automatically generate a sounds-like pronunciation for the word. -For a word that is in the service’s base vocabulary, use the parameter to specify additional pronunciations for the -word. You cannot override the default pronunciation of a word; pronunciations you add augment the pronunciation -from the base vocabulary. A word can have at most five sounds-like pronunciations, and a pronunciation can include -at most 40 characters not including spaces.

+vocabulary, omit the parameter to have the service automatically generate a sounds-like pronunciation for the +word. For a word that is in the service’s base vocabulary, use the parameter to specify additional pronunciations +for the word. You cannot override the default pronunciation of a word; pronunciations you add augment the +pronunciation from the base vocabulary. A word can have at most five sounds-like pronunciations, and a +pronunciation can include at most 40 characters not including spaces.

@@ -3606,10 +3679,10 @@

Parameters

-

List a custom word.

+

Get a custom word.

-

Lists information about a custom word from a custom language model. You must use credentials for the instance of -the service that owns a model to query information about its words.

+

Gets information about a custom word from a custom language model. You must use credentials for the instance of the +service that owns a model to query information about its words.

@@ -3650,9 +3723,9 @@

Parameters

-

The custom word for the custom language model. When you add or update a custom word with the Add a custom word -method, do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of compound -words.

+

The custom word for the custom language model. When you add or update a custom word with the Add a custom +word method, do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of +compound words.

@@ -3758,9 +3831,9 @@

Parameters

-

The custom word for the custom language model. When you add or update a custom word with the Add a custom word -method, do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of compound -words.

+

The custom word for the custom language model. When you add or update a custom word with the Add a custom +word method, do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of +compound words.

@@ -3823,7 +3896,7 @@

Parameters

Creates a new custom acoustic model for a specified base model. The custom acoustic model can be used only with the base model for which it is created. The model is owned by the instance of the service whose credentials are used to -create it. You must pass a value of application/json with the Content-Type header.

+create it.

@@ -3866,9 +3939,9 @@

Parameters

-

The name of the base language model that is to be customized by the new custom acoustic model. The new custom model -can be used only with the base model that it customizes. To determine whether a base model supports acoustic model -customization, refer to Language support for +

The name of the base language model that is to be customized by the new custom acoustic model. The new custom +model can be used only with the base model that it customizes. To determine whether a base model supports +acoustic model customization, refer to Language support for customization.

@@ -3881,8 +3954,8 @@

Parameters

-

A description of the new custom acoustic model. Use a localized description that matches the language of the custom -model.

+

A description of the new custom acoustic model. Use a localized description that matches the language of the +custom model.

@@ -3944,7 +4017,7 @@

Parameters

List custom acoustic models.

Lists information about all custom acoustic models that are owned by an instance of the service. Use the language -parameter to see all custom acoustic models for the specified language; omit the parameter to see all custom +parameter to see all custom acoustic models for the specified language. Omit the parameter to see all custom acoustic models for all languages. You must use credentials for the instance of the service that owns a model to list information about it.

@@ -3973,9 +4046,9 @@

Parameters

-

The identifier of the language for which custom language or custom acoustic models are to be returned (for example, -en-US). Omit the parameter to see all custom language or custom acoustic models owned by the requesting service -credentials.

+

The identifier of the language for which custom language or custom acoustic models are to be returned (for +example, en-US). Omit the parameter to see all custom language or custom acoustic models owned by the +requesting service credentials.

@@ -4034,9 +4107,9 @@

Parameters

-

List a custom acoustic model.

+

Get a custom acoustic model.

-

Lists information about a specified custom acoustic model. You must use credentials for the instance of the service +

Gets information about a specified custom acoustic model. You must use credentials for the instance of the service that owns a model to list information about it.

@@ -4220,25 +4293,31 @@

Parameters

Initiates the training of a custom acoustic model with new or changed audio resources. After adding or deleting audio resources for a custom acoustic model, use this method to begin the actual training of the model on the latest audio data. The custom acoustic model does not reflect its changed data until you train it. You must use -credentials for the instance of the service that owns a model to train it. The training method is asynchronous. -It can take on the order of minutes or hours to complete depending on the total amount of audio data on which the -custom acoustic model is being trained and the current load on the service. Typically, training a custom acoustic -model takes approximately two to four times the length of its audio data. The range of time depends on the model -being trained and the nature of the audio, such as whether the audio is clean or noisy. The method returns an HTTP -200 response code to indicate that the training process has begun. You can monitor the status of the training by -using the List a custom acoustic model method to poll the model’s status. Use a loop to check the status once a -minute. The method returns an Customization object that includes status and progress fields. A status of -available indicates that the custom model is trained and ready to use. The service cannot accept subsequent -training requests, or requests to add new audio resources, until the existing request completes. You can use the -optional custom_language_model_id parameter to specify the GUID of a separately created custom language model -that is to be used during training. Specify a custom language model if you have verbatim transcriptions of the -audio files that you have added to the custom model or you have either corpora (text files) or a list of words that -are relevant to the contents of the audio files. For information about creating a separate custom language model, -see Creating a custom language -model. Training can fail to start -for the following reasons: * The service is currently handling another request for the custom model, such as -another training request or a request to add audio resources to the model. * The custom model contains less than 10 -minutes or more than 50 hours of audio data. * One or more of the custom model’s audio resources is invalid.

+credentials for the instance of the service that owns a model to train it. +The training method is asynchronous. It can take on the order of minutes or hours to complete depending on the +total amount of audio data on which the custom acoustic model is being trained and the current load on the service. +Typically, training a custom acoustic model takes approximately two to four times the length of its audio data. The +range of time depends on the model being trained and the nature of the audio, such as whether the audio is clean or +noisy. The method returns an HTTP 200 response code to indicate that the training process has begun. +You can monitor the status of the training by using the Get a custom acoustic model method to poll the model’s +status. Use a loop to check the status once a minute. The method returns an AcousticModel object that includes +status and progress fields. A status of available indicates that the custom model is trained and ready to +use. The service cannot accept subsequent training requests, or requests to add new audio resources, until the +existing request completes. +You can use the optional custom_language_model_id parameter to specify the GUID of a separately created custom +language model that is to be used during training. Specify a custom language model if you have verbatim +transcriptions of the audio files that you have added to the custom model or you have either corpora (text files) +or a list of words that are relevant to the contents of the audio files. For information about creating a separate +custom language model, see Creating a custom language +model. +Training can fail to start for the following reasons:

+ +
    +
  • The service is currently handling another request for the custom model, such as another training request or a +request to add audio resources to the model.
  • +
  • The custom model contains less than 10 minutes or more than 50 hours of audio data.
  • +
  • One or more of the custom model’s audio resources is invalid.

  • +
@@ -4280,8 +4359,8 @@

Parameters

The customization ID (GUID) of a custom language model that is to be used during training of the custom acoustic -model. Specify a custom language model that has been trained with verbatim transcriptions of the audio resources or -that contains words that are relevant to the contents of the audio resources.

+model. Specify a custom language model that has been trained with verbatim transcriptions of the audio resources +or that contains words that are relevant to the contents of the audio resources.

@@ -4438,16 +4517,18 @@

Parameters

method is asynchronous. It can take on the order of minutes or hours to complete depending on the amount of data in the custom model and the current load on the service; typically, upgrade takes approximately twice the length of the total audio contained in the custom model. A custom model must be in the ready or available state to be -upgraded. You must use credentials for the instance of the service that owns a model to upgrade it. The method -returns an HTTP 200 response code to indicate that the upgrade process has begun successfully. You can monitor the -status of the upgrade by using the List a custom acoustic model method to poll the model’s status. Use a loop -to check the status once a minute. While it is being upgraded, the custom model has the status upgrading. When -the upgrade is complete, the model resumes the status that it had prior to upgrade. The service cannot accept -subsequent requests for the model until the upgrade completes. If the custom acoustic model was trained with a -separately created custom language model, you must use the custom_language_model_id parameter to specify the GUID -of that custom language model. The custom language model must be upgraded before the custom acoustic model can be -upgraded. Omit the parameter if the custom acoustic model was not trained with a custom language model. For more -information, see Upgrading custom +upgraded. You must use credentials for the instance of the service that owns a model to upgrade it. +The method returns an HTTP 200 response code to indicate that the upgrade process has begun successfully. You can +monitor the status of the upgrade by using the Get a custom acoustic model method to poll the model’s status. +The method returns an AcousticModel object that includes status and progress fields. Use a loop to check the +status once a minute. While it is being upgraded, the custom model has the status upgrading. When the upgrade is +complete, the model resumes the status that it had prior to upgrade. The service cannot accept subsequent requests +for the model until the upgrade completes. +If the custom acoustic model was trained with a separately created custom language model, you must use the +custom_language_model_id parameter to specify the GUID of that custom language model. The custom language model +must be upgraded before the custom acoustic model can be upgraded. Omit the parameter if the custom acoustic model +was not trained with a custom language model. +For more information, see Upgrading custom models.

@@ -4647,46 +4728,64 @@

Parameters

Adds an audio resource to a custom acoustic model. Add audio content that reflects the acoustic characteristics of the audio that you plan to transcribe. You must use credentials for the instance of the service that owns a model to add an audio resource to it. Adding audio data does not affect the custom acoustic model until you train the -model for the new data by using the Train a custom acoustic model method. You can add individual audio files -or an archive file that contains multiple audio files. Adding multiple audio files via a single archive file is -significantly more efficient than adding each file individually. You can add audio resources in any format that the -service supports for speech recognition. You can use this method to add any number of audio resources to a custom -model by calling the method once for each audio or archive file. But the addition of one audio resource must be -fully complete before you can add another. You must add a minimum of 10 minutes and a maximum of 50 hours of audio -that includes speech, not just silence, to a custom acoustic model before you can train it. No audio resource, -audio- or archive-type, can be larger than 100 MB. To add an audio resource that has the same name as an existing -audio resource, set the allow_overwrite parameter to true; otherwise, the request fails. The method is -asynchronous. It can take several seconds to complete depending on the duration of the audio and, in the case of an -archive file, the total number of audio files being processed. The service returns a 201 response code if the audio -is valid. It then asynchronously analyzes the contents of the audio file or files and automatically extracts -information about the audio such as its length, sampling rate, and encoding. You cannot submit requests to add -additional audio resources to a custom acoustic model, or to train the model, until the service’s analysis of all -audio files for the current request completes. To determine the status of the service’s analysis of the audio, -use the List an audio resource method to poll the status of the audio. The method accepts the GUID of the -custom model and the name of the audio resource, and it returns the status of the resource. Use a loop to check the -status of the audio every few seconds until it becomes ok. ### Content types for audio-type resources You can -add an individual audio file in any format that the service supports for speech recognition. For an audio-type -resource, use the Content-Type parameter to specify the audio format (MIME type) of the audio file: * -audio/basic (Use only with narrowband models.) * audio/flac * audio/l16 (Specify the sampling rate (rate) -and optionally the number of channels (channels) and endianness (endianness) of the audio.) * audio/mp3 * -audio/mpeg * audio/mulaw (Specify the sampling rate (rate) of the audio.) * audio/ogg (The service -automatically detects the codec of the input audio.) * audio/ogg;codecs=opus * audio/ogg;codecs=vorbis * -audio/wav (Provide audio with a maximum of nine channels.) * audio/webm (The service automatically detects the -codec of the input audio.) * audio/webm;codecs=opus * audio/webm;codecs=vorbis For information about the -supported audio formats, including specifying the sampling rate, channels, and endianness for the indicated -formats, see Audio formats. +model for the new data by using the Train a custom acoustic model method. +You can add individual audio files or an archive file that contains multiple audio files. Adding multiple audio +files via a single archive file is significantly more efficient than adding each file individually. You can add +audio resources in any format that the service supports for speech recognition. +You can use this method to add any number of audio resources to a custom model by calling the method once for each +audio or archive file. But the addition of one audio resource must be fully complete before you can add another. +You must add a minimum of 10 minutes and a maximum of 50 hours of audio that includes speech, not just silence, to +a custom acoustic model before you can train it. No audio resource, audio- or archive-type, can be larger than 100 +MB. To add an audio resource that has the same name as an existing audio resource, set the allow_overwrite +parameter to true; otherwise, the request fails. +The method is asynchronous. It can take several seconds to complete depending on the duration of the audio and, in +the case of an archive file, the total number of audio files being processed. The service returns a 201 response +code if the audio is valid. It then asynchronously analyzes the contents of the audio file or files and +automatically extracts information about the audio such as its length, sampling rate, and encoding. You cannot +submit requests to add additional audio resources to a custom acoustic model, or to train the model, until the +service’s analysis of all audio files for the current request completes. +To determine the status of the service’s analysis of the audio, use the Get an audio resource method to poll +the status of the audio. The method accepts the customization ID of the custom model and the name of the audio +resource, and it returns the status of the resource. Use a loop to check the status of the audio every few seconds +until it becomes ok.

+

Content types for audio-type resources

+ +

You can add an individual audio file in any format that the service supports for speech recognition. For an +audio-type resource, use the Content-Type parameter to specify the audio format (MIME type) of the audio file:

+ +
    +
  • audio/basic (Use only with narrowband models.)
  • +
  • audio/flac
  • +
  • audio/l16 (Specify the sampling rate (rate) and optionally the number of channels (channels) and endianness +(endianness) of the audio.)
  • +
  • audio/mp3
  • +
  • audio/mpeg
  • +
  • audio/mulaw (Specify the sampling rate (rate) of the audio.)
  • +
  • audio/ogg (The service automatically detects the codec of the input audio.)
  • +
  • audio/ogg;codecs=opus
  • +
  • audio/ogg;codecs=vorbis
  • +
  • audio/wav (Provide audio with a maximum of nine channels.)
  • +
  • audio/webm (The service automatically detects the codec of the input audio.)
  • +
  • audio/webm;codecs=opus
  • +
  • audio/webm;codecs=vorbis +For information about the supported audio formats, including specifying the sampling rate, channels, and endianness +for the indicated formats, see Audio +formats. Note: The sampling rate of an audio file must match the sampling rate of the base model for the custom model: for broadband models, at least 16 kHz; for narrowband models, at least 8 kHz. If the sampling rate of the audio is higher than the minimum required rate, the service down-samples the audio to the appropriate rate. If the sampling -rate of the audio is lower than the minimum required rate, the service labels the audio file as invalid. ### -Content types for archive-type resources You can add an archive file (.zip or .tar.gz file) that contains -audio files in any format that the service supports for speech recognition. For an archive-type resource, use the -Content-Type parameter to specify the media type of the archive file: * application/zip for a .zip file * -application/gzip for a .tar.gz file. All audio files contained in the archive must have the same audio -format. Use the Contained-Content-Type parameter to specify the format of the contained audio files. The -parameter accepts all of the audio formats supported for use with speech recognition and with the Content-Type -header, including the rate, channels, and endianness parameters that are used with some formats. The default -contained audio format is audio/wav.

    +rate of the audio is lower than the minimum required rate, the service labels the audio file as invalid. +### Content types for archive-type resources +You can add an archive file (.zip or .tar.gz file) that contains audio files in any format that the +service supports for speech recognition. For an archive-type resource, use the Content-Type parameter to specify +the media type of the archive file:
  • +
  • application/zip for a .zip file
  • +
  • application/gzip for a .tar.gz file. +All audio files contained in the archive must have the same audio format. Use the Contained-Content-Type +parameter to specify the format of the contained audio files. The parameter accepts all of the audio formats +supported for use with speech recognition and with the Content-Type header, including the rate, channels, and +endianness parameters that are used with some formats. The default contained audio format is audio/wav.

  • +
@@ -4731,8 +4830,8 @@

Parameters

-

The name of the audio resource for the custom acoustic model. When adding an audio resource, do not include spaces -in the name; use a localized name that matches the language of the custom model.

+

The name of the audio resource for the custom acoustic model. When adding an audio resource, do not include +spaces in the name; use a localized name that matches the language of the custom model.

@@ -4770,10 +4869,10 @@

Parameters

-

For an archive-type resource, specifies the format of the audio files contained in the archive file. The parameter -accepts all of the audio formats supported for use with speech recognition, including the rate, channels, and -endianness parameters that are used with some formats. For a complete list of supported audio formats, see Audio -formats.

+

For an archive-type resource, specifies the format of the audio files contained in the archive file. The +parameter accepts all of the audio formats supported for use with speech recognition, including the rate, +channels, and endianness parameters that are used with some formats. For a complete list of supported audio +formats, see Audio formats.

@@ -4786,8 +4885,8 @@

Parameters

If true, the specified corpus or audio resource overwrites an existing corpus or audio resource with the same -name. If false (the default), the request fails if a corpus or audio resource with the same name already exists. -The parameter has no effect if a corpus or audio resource with the same name does not already exist.

+name. If false (the default), the request fails if a corpus or audio resource with the same name already +exists. The parameter has no effect if a corpus or audio resource with the same name does not already exist.

@@ -4846,17 +4945,24 @@

Parameters

-

List an audio resource.

+

Get an audio resource.

+ +

Gets information about an audio resource from a custom acoustic model. The method returns an AudioListing object +whose fields depend on the type of audio resource that you specify with the method’s audio_name parameter:

-

Lists information about an audio resource from a custom acoustic model. The method returns an AudioListing object -whose fields depend on the type of audio resource you specify with the method’s audio_name parameter: * For an -audio-type resource, the object’s fields match those of an AudioResource object: duration, name, details, -and status. * For an archive-type resource, the object includes a container field whose fields match those -of an AudioResource object. It also includes an audio field, which contains an array of AudioResource objects -that provides information about the audio files that are contained in the archive. The information includes the -status of the specified audio resource, which is important for checking the service’s analysis of the resource in -response to a request to add it to the custom model. You must use credentials for the instance of the service that -owns a model to list its audio resources.

+
    +
  • For an audio-type resource, the object’s fields match those of an AudioResource object: duration, name, +details, and status.
  • +
  • For an archive-type resource, the object includes a container field whose fields match those of an +AudioResource object. It also includes an audio field, which contains an array of AudioResource objects that +provides information about the audio files that are contained in the archive. +The information includes the status of the specified audio resource. The status is important for checking the +service’s analysis of a resource that you add to the custom model.
  • +
  • For an audio-type resource, the status field is located in the AudioListing object.
  • +
  • For an archive-type resource, the status field is located in the AudioResource object that is returned in the +container field. +You must use credentials for the instance of the service that owns a model to list its audio resources.

  • +
@@ -4897,8 +5003,8 @@

Parameters

-

The name of the audio resource for the custom acoustic model. When adding an audio resource, do not include spaces -in the name; use a localized name that matches the language of the custom model.

+

The name of the audio resource for the custom acoustic model. When adding an audio resource, do not include +spaces in the name; use a localized name that matches the language of the custom model.

@@ -5004,8 +5110,8 @@

Parameters

-

The name of the audio resource for the custom acoustic model. When adding an audio resource, do not include spaces -in the name; use a localized name that matches the language of the custom model.

+

The name of the audio resource for the custom acoustic model. When adding an audio resource, do not include +spaces in the name; use a localized name that matches the language of the custom model.

@@ -5069,9 +5175,10 @@

Parameters

Deletes all data that is associated with a specified customer ID. The method deletes all data for the customer ID, regardless of the method by which the information was added. The method has no effect if no data is associated with the customer ID. You must issue the request with credentials for the same instance of the service that was used to -associate the customer ID with the data. You associate a customer ID with data by passing the X-Watson-Metadata -header with a request that passes the data. For more information about customer IDs and about using this method, -see Information security.

+associate the customer ID with the data. +You associate a customer ID with data by passing the X-Watson-Metadata header with a request that passes the +data. For more information about customer IDs and about using this method, see Information +security.

@@ -5586,7 +5693,7 @@

Declaration

diff --git a/docs/swift-api/services/SpeechToTextV1/Classes/SpeechToTextSession.html b/docs/swift-api/services/SpeechToTextV1/Classes/SpeechToTextSession.html index 3a92a3a72..352e760cc 100644 --- a/docs/swift-api/services/SpeechToTextV1/Classes/SpeechToTextSession.html +++ b/docs/swift-api/services/SpeechToTextV1/Classes/SpeechToTextSession.html @@ -113,9 +113,6 @@ - @@ -925,7 +922,7 @@

Declaration

diff --git a/docs/swift-api/services/SpeechToTextV1/Enums.html b/docs/swift-api/services/SpeechToTextV1/Enums.html index f175f4d3a..d7ec99978 100644 --- a/docs/swift-api/services/SpeechToTextV1/Enums.html +++ b/docs/swift-api/services/SpeechToTextV1/Enums.html @@ -113,9 +113,6 @@ - @@ -270,7 +267,7 @@

Declaration

diff --git a/docs/swift-api/services/SpeechToTextV1/Enums/JSON.html b/docs/swift-api/services/SpeechToTextV1/Enums/JSON.html index 8d9e8c8a7..1b7a66ecf 100644 --- a/docs/swift-api/services/SpeechToTextV1/Enums/JSON.html +++ b/docs/swift-api/services/SpeechToTextV1/Enums/JSON.html @@ -113,9 +113,6 @@ - @@ -540,7 +537,7 @@

Declaration

diff --git a/docs/swift-api/services/SpeechToTextV1/Enums/RestError.html b/docs/swift-api/services/SpeechToTextV1/Enums/RestError.html index 13815e6a5..7e31ac228 100644 --- a/docs/swift-api/services/SpeechToTextV1/Enums/RestError.html +++ b/docs/swift-api/services/SpeechToTextV1/Enums/RestError.html @@ -113,9 +113,6 @@ - @@ -407,7 +404,7 @@

Declaration

diff --git a/docs/swift-api/services/SpeechToTextV1/Structs.html b/docs/swift-api/services/SpeechToTextV1/Structs.html index 0003300cb..a9998b92c 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs.html @@ -113,9 +113,6 @@ - @@ -203,45 +200,6 @@

Structures

-
-
- - - -

JSON

-
-
-
    -
  • -
    - - - - JSONWrapper - -
    -
    -
    -
    -
    -
    -

    Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct JSONWrapper
    - -
    -
    -
    -
    -
  • -
-
  • @@ -1337,7 +1295,7 @@

    Declaration

diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/AcousticModel.html b/docs/swift-api/services/SpeechToTextV1/Structs/AcousticModel.html index 6fcc4a7a3..63a4f4907 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/AcousticModel.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/AcousticModel.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,17 @@

AcousticModel

-

The current status of the custom acoustic model: * pending indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * ready indicates that the model contains data and is ready to be trained. * training indicates that the model is currently being trained. * available indicates that the model is trained and ready to use. * upgrading indicates that the model is currently being upgraded. * failed indicates that training of the model failed.

+

The current status of the custom acoustic model:

+ +
    +
  • pending indicates that the model was created but is waiting either for training data to be added or for the +service to finish analyzing added data.
  • +
  • ready indicates that the model contains data and is ready to be trained.
  • +
  • training indicates that the model is currently being trained.
  • +
  • available indicates that the model is trained and ready to use.
  • +
  • upgrading indicates that the model is currently being upgraded.
  • +
  • failed indicates that training of the model failed.
  • +
See more
@@ -252,7 +259,8 @@

Declaration

-

The customization ID (GUID) of the custom acoustic model. The Create a custom acoustic model method returns only this field of the object; it does not return the other fields.

+

The customization ID (GUID) of the custom acoustic model. The Create a custom acoustic model method returns +only this field of the object; it does not return the other fields.

@@ -279,7 +287,8 @@

Declaration

-

The date and time in Coordinated Universal Time (UTC) at which the custom acoustic model was created. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

+

The date and time in Coordinated Universal Time (UTC) at which the custom acoustic model was created. The value is +provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

@@ -333,7 +342,9 @@

Declaration

-

A list of the available versions of the custom acoustic model. Each element of the array indicates a version of the base model with which the custom model can be used. Multiple versions exist only if the custom model has been upgraded; otherwise, only a single version is shown.

+

A list of the available versions of the custom acoustic model. Each element of the array indicates a version of the +base model with which the custom model can be used. Multiple versions exist only if the custom model has been +upgraded; otherwise, only a single version is shown.

@@ -468,7 +479,17 @@

Declaration

-

The current status of the custom acoustic model: * pending indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * ready indicates that the model contains data and is ready to be trained. * training indicates that the model is currently being trained. * available indicates that the model is trained and ready to use. * upgrading indicates that the model is currently being upgraded. * failed indicates that training of the model failed.

+

The current status of the custom acoustic model:

+ +
    +
  • pending indicates that the model was created but is waiting either for training data to be added or for the +service to finish analyzing added data.
  • +
  • ready indicates that the model contains data and is ready to be trained.
  • +
  • training indicates that the model is currently being trained.
  • +
  • available indicates that the model is trained and ready to use.
  • +
  • upgrading indicates that the model is currently being upgraded.
  • +
  • failed indicates that training of the model failed.
  • +
@@ -495,7 +516,9 @@

Declaration

-

A percentage that indicates the progress of the custom acoustic model’s current training. A value of 100 means that the model is fully trained. Note: The progress field does not currently reflect the progress of the training. The field changes from 0 to 100 when training is complete.

+

A percentage that indicates the progress of the custom acoustic model’s current training. A value of 100 means +that the model is fully trained. Note: The progress field does not currently reflect the progress of the +training. The field changes from 0 to 100 when training is complete.

@@ -522,7 +545,8 @@

Declaration

-

If the request included unknown parameters, the following message: Unexpected query parameter(s) ['parameters'] detected, where parameters is a list that includes a quoted string for each unknown parameter.

+

If the request included unknown parameters, the following message: Unexpected query parameter(s) ['parameters'] +detected, where parameters is a list that includes a quoted string for each unknown parameter.

@@ -541,7 +565,7 @@

Declaration

diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/AcousticModel/Status.html b/docs/swift-api/services/SpeechToTextV1/Structs/AcousticModel/Status.html index a155fd62c..f1debd38f 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/AcousticModel/Status.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/AcousticModel/Status.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,17 @@

Status

-

The current status of the custom acoustic model: * pending indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * ready indicates that the model contains data and is ready to be trained. * training indicates that the model is currently being trained. * available indicates that the model is trained and ready to use. * upgrading indicates that the model is currently being upgraded. * failed indicates that training of the model failed.

+

The current status of the custom acoustic model:

+ +
    +
  • pending indicates that the model was created but is waiting either for training data to be added or for the +service to finish analyzing added data.
  • +
  • ready indicates that the model contains data and is ready to be trained.
  • +
  • training indicates that the model is currently being trained.
  • +
  • available indicates that the model is trained and ready to use.
  • +
  • upgrading indicates that the model is currently being upgraded.
  • +
  • failed indicates that training of the model failed.
  • +
@@ -378,7 +385,7 @@

Declaration

diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/AcousticModels.html b/docs/swift-api/services/SpeechToTextV1/Structs/AcousticModels.html index c965c7271..4d6363f60 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/AcousticModels.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/AcousticModels.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,9 @@

AcousticModels

-

An array of objects that provides information about each available custom acoustic model. The array is empty if the requesting service credentials own no custom acoustic models (if no language is specified) or own no custom acoustic models for the specified language.

+

An array of objects that provides information about each available custom acoustic model. The array is empty if the +requesting service credentials own no custom acoustic models (if no language is specified) or own no custom +acoustic models for the specified language.

@@ -243,7 +242,7 @@

Declaration

diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/AudioDetails.html b/docs/swift-api/services/SpeechToTextV1/Structs/AudioDetails.html index 9f7331ee9..78ba372c3 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/AudioDetails.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/AudioDetails.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,14 @@

AudioDetails

-

The type of the audio resource: * audio for an individual audio file * archive for an archive (.zip or .tar.gz) file that contains audio files.

+

The type of the audio resource:

+ +
    +
  • audio for an individual audio file
  • +
  • archive for an archive (.zip or .tar.gz) file that contains audio files
  • +
  • undetermined for a resource that the service cannot validate (for example, if the user mistakenly passes a file +that does not contain audio, such as a JPEG file).
  • +
See more
@@ -252,7 +256,13 @@

Declaration

-

For an archive-type resource,** the format of the compressed archive: * zip for a .zip file * gzip for a .tar.gz file Omitted for an audio-type resource.

+

For an archive-type resource, the format of the compressed archive:

+ +
    +
  • zip for a .zip file
  • +
  • gzip for a .tar.gz file +Omitted for an audio-type resource.
  • +
See more
@@ -280,7 +290,14 @@

Declaration

-

The type of the audio resource: * audio for an individual audio file * archive for an archive (.zip or .tar.gz) file that contains audio files.

+

The type of the audio resource:

+ +
    +
  • audio for an individual audio file
  • +
  • archive for an archive (.zip or .tar.gz) file that contains audio files
  • +
  • undetermined for a resource that the service cannot validate (for example, if the user mistakenly passes a file +that does not contain audio, such as a JPEG file).
  • +
@@ -334,7 +351,8 @@

Declaration

-

For an audio-type resource,** the sampling rate of the audio in Hertz (samples per second). Omitted for an archive-type resource.

+

For an audio-type resource, the sampling rate of the audio in Hertz (samples per second). Omitted for an +archive-type resource.

@@ -361,7 +379,13 @@

Declaration

-

For an archive-type resource,** the format of the compressed archive: * zip for a .zip file * gzip for a .tar.gz file Omitted for an audio-type resource.

+

For an archive-type resource, the format of the compressed archive:

+ +
    +
  • zip for a .zip file
  • +
  • gzip for a .tar.gz file +Omitted for an audio-type resource.
  • +
@@ -380,7 +404,7 @@

Declaration

diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/AudioDetails/Compression.html b/docs/swift-api/services/SpeechToTextV1/Structs/AudioDetails/Compression.html index 6ba4031a3..17ee9d515 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/AudioDetails/Compression.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/AudioDetails/Compression.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,13 @@

Compression

-

For an archive-type resource,** the format of the compressed archive: * zip for a .zip file * gzip for a .tar.gz file Omitted for an audio-type resource.

+

For an archive-type resource, the format of the compressed archive:

+ +
    +
  • zip for a .zip file
  • +
  • gzip for a .tar.gz file +Omitted for an audio-type resource.
  • +
@@ -270,7 +273,7 @@

Declaration

diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/AudioDetails/ModelType.html b/docs/swift-api/services/SpeechToTextV1/Structs/AudioDetails/ModelType.html index 585d1870c..265d4bd83 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/AudioDetails/ModelType.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/AudioDetails/ModelType.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,14 @@

ModelType

-

The type of the audio resource: * audio for an individual audio file * archive for an archive (.zip or .tar.gz) file that contains audio files.

+

The type of the audio resource:

+ +
    +
  • audio for an individual audio file
  • +
  • archive for an archive (.zip or .tar.gz) file that contains audio files
  • +
  • undetermined for a resource that the service cannot validate (for example, if the user mistakenly passes a file +that does not contain audio, such as a JPEG file).
  • +
@@ -265,12 +269,39 @@

Declaration

+
  • +
    + + + + undetermined + +
    +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case undetermined = "undetermined"
    + +
    +
    +
    +
    +
  • diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/AudioListing.html b/docs/swift-api/services/SpeechToTextV1/Structs/AudioListing.html index ce0aa3d95..2c6b1c40a 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/AudioListing.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/AudioListing.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,17 @@

    AudioListing

    -

    For an audio-type resource,** the status of the resource: * ok indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * being_processed indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * invalid indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). Omitted for an archive-type resource.

    +

    For an audio-type resource, the status of the resource:

    + +
      +
    • ok indicates that the service has successfully analyzed the audio data. The data can be used to train the +custom model.
    • +
    • being_processed indicates that the service is still analyzing the audio data. The service cannot accept +requests to add new audio resources or to train the custom model until its analysis is complete.
    • +
    • invalid indicates that the audio data is not valid for training the custom model (possibly because it has the +wrong format or sampling rate, or because it is corrupted). +Omitted for an archive-type resource.
    • +
    See more
    @@ -252,7 +259,8 @@

    Declaration

    -

    For an audio-type resource,** the total seconds of audio in the resource. Omitted for an archive-type resource.

    +

    For an audio-type resource, the total seconds of audio in the resource. The value is always a whole number. +Omitted for an archive-type resource.

    @@ -279,7 +287,7 @@

    Declaration

    -

    For an audio-type resource,** the name of the resource. Omitted for an archive-type resource.

    +

    For an audio-type resource,** the user-specified name of the resource. Omitted for an archive-type resource.

    @@ -306,7 +314,8 @@

    Declaration

    -

    For an audio-type resource,** an AudioDetails object that provides detailed information about the resource. The object is empty until the service finishes processing the audio. Omitted for an archive-type resource.

    +

    For an audio-type resource, an AudioDetails object that provides detailed information about the resource. The +object is empty until the service finishes processing the audio. Omitted for an archive-type resource.

    @@ -333,7 +342,17 @@

    Declaration

    -

    For an audio-type resource,** the status of the resource: * ok indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * being_processed indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * invalid indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). Omitted for an archive-type resource.

    +

    For an audio-type resource, the status of the resource:

    + +
      +
    • ok indicates that the service has successfully analyzed the audio data. The data can be used to train the +custom model.
    • +
    • being_processed indicates that the service is still analyzing the audio data. The service cannot accept +requests to add new audio resources or to train the custom model until its analysis is complete.
    • +
    • invalid indicates that the audio data is not valid for training the custom model (possibly because it has the +wrong format or sampling rate, or because it is corrupted). +Omitted for an archive-type resource.
    • +
    @@ -360,7 +379,8 @@

    Declaration

    -

    For an archive-type resource,** an object of type AudioResource that provides information about the resource. Omitted for an audio-type resource.

    +

    For an archive-type resource, an object of type AudioResource that provides information about the resource. +Omitted for an audio-type resource.

    @@ -387,7 +407,8 @@

    Declaration

    -

    For an archive-type resource,** an array of AudioResource objects that provides information about the audio-type resources that are contained in the resource. Omitted for an audio-type resource.

    +

    For an archive-type resource, an array of AudioResource objects that provides information about the +audio-type resources that are contained in the resource. Omitted for an audio-type resource.

    @@ -406,7 +427,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/AudioListing/Status.html b/docs/swift-api/services/SpeechToTextV1/Structs/AudioListing/Status.html index ad7350dda..90aad912e 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/AudioListing/Status.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/AudioListing/Status.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,17 @@

    Status

    -

    For an audio-type resource,** the status of the resource: * ok indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * being_processed indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * invalid indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). Omitted for an archive-type resource.

    +

    For an audio-type resource, the status of the resource:

    + +
      +
    • ok indicates that the service has successfully analyzed the audio data. The data can be used to train the +custom model.
    • +
    • being_processed indicates that the service is still analyzing the audio data. The service cannot accept +requests to add new audio resources or to train the custom model until its analysis is complete.
    • +
    • invalid indicates that the audio data is not valid for training the custom model (possibly because it has the +wrong format or sampling rate, or because it is corrupted). +Omitted for an archive-type resource.
    • +
    @@ -297,7 +304,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/AudioResource.html b/docs/swift-api/services/SpeechToTextV1/Structs/AudioResource.html index 9d964b86f..6dca4baf4 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/AudioResource.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/AudioResource.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,17 @@

    AudioResource

    -

    The status of the audio resource: * ok indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * being_processed indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * invalid indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if any of its audio files are invalid.

    +

    The status of the audio resource:

    + +
      +
    • ok indicates that the service has successfully analyzed the audio data. The data can be used to train the +custom model.
    • +
    • being_processed indicates that the service is still analyzing the audio data. The service cannot accept +requests to add new audio resources or to train the custom model until its analysis is complete.
    • +
    • invalid indicates that the audio data is not valid for training the custom model (possibly because it has the +wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if +any of its audio files are invalid.
    • +
    See more
    @@ -252,7 +259,7 @@

    Declaration

    -

    The total seconds of audio in the audio resource.

    +

    The total seconds of audio in the audio resource. The value is always a whole number.

    @@ -279,7 +286,9 @@

    Declaration

    -

    The name of the audio resource.

    +

    For an archive-type resource, the user-specified name of the resource. +For an audio-type resource, the user-specified name of the resource or the name of the audio file that the user +added for the resource. The value depends on the method that is called.

    @@ -306,7 +315,8 @@

    Declaration

    -

    An AudioDetails object that provides detailed information about the audio resource. The object is empty until the service finishes processing the audio.

    +

    An AudioDetails object that provides detailed information about the audio resource. The object is empty until the +service finishes processing the audio.

    @@ -333,7 +343,17 @@

    Declaration

    -

    The status of the audio resource: * ok indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * being_processed indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * invalid indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if any of its audio files are invalid.

    +

    The status of the audio resource:

    + +
      +
    • ok indicates that the service has successfully analyzed the audio data. The data can be used to train the +custom model.
    • +
    • being_processed indicates that the service is still analyzing the audio data. The service cannot accept +requests to add new audio resources or to train the custom model until its analysis is complete.
    • +
    • invalid indicates that the audio data is not valid for training the custom model (possibly because it has the +wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if +any of its audio files are invalid.
    • +
    @@ -352,7 +372,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/AudioResource/Status.html b/docs/swift-api/services/SpeechToTextV1/Structs/AudioResource/Status.html index 760f5dbcf..342b53ff9 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/AudioResource/Status.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/AudioResource/Status.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,17 @@

    Status

    -

    The status of the audio resource: * ok indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * being_processed indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * invalid indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if any of its audio files are invalid.

    +

    The status of the audio resource:

    + +
      +
    • ok indicates that the service has successfully analyzed the audio data. The data can be used to train the +custom model.
    • +
    • being_processed indicates that the service is still analyzing the audio data. The service cannot accept +requests to add new audio resources or to train the custom model until its analysis is complete.
    • +
    • invalid indicates that the audio data is not valid for training the custom model (possibly because it has the +wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if +any of its audio files are invalid.
    • +
    @@ -297,7 +304,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/AudioResources.html b/docs/swift-api/services/SpeechToTextV1/Structs/AudioResources.html index 6311f77c8..fda91cded 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/AudioResources.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/AudioResources.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,8 @@

    AudioResources

    -

    The total minutes of accumulated audio summed over all of the valid audio resources for the custom acoustic model. You can use this value to determine whether the custom model has too little or too much audio to begin training.

    +

    The total minutes of accumulated audio summed over all of the valid audio resources for the custom acoustic model. +You can use this value to determine whether the custom model has too little or too much audio to begin training.

    @@ -251,7 +249,8 @@

    Declaration

    -

    An array of AudioResource objects that provides information about the audio resources of the custom acoustic model. The array is empty if the custom model has no audio resources.

    +

    An array of objects that provides information about the audio resources of the custom acoustic model. The array is +empty if the custom model has no audio resources.

    @@ -270,7 +269,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/Corpora.html b/docs/swift-api/services/SpeechToTextV1/Structs/Corpora.html index cddd43c6e..f17f169a6 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/Corpora.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/Corpora.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,8 @@

    Corpora

    -

    Information about corpora of the custom model. The array is empty if the custom model has no corpora.

    +

    An array of objects that provides information about the corpora for the custom model. The array is empty if the +custom model has no corpora.

    @@ -243,7 +241,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/Corpus.html b/docs/swift-api/services/SpeechToTextV1/Structs/Corpus.html index f596ba2cd..52bfa1b80 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/Corpus.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/Corpus.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,15 @@

    Corpus

    -

    The status of the corpus: * analyzed indicates that the service has successfully analyzed the corpus; the custom model can be trained with data from the corpus. * being_processed indicates that the service is still analyzing the corpus; the service cannot accept requests to add new corpora or words, or to train the custom model. * undetermined indicates that the service encountered an error while processing the corpus.

    +

    The status of the corpus:

    + +
      +
    • analyzed indicates that the service has successfully analyzed the corpus; the custom model can be trained with +data from the corpus.
    • +
    • being_processed indicates that the service is still analyzing the corpus; the service cannot accept requests to +add new corpora or words, or to train the custom model.
    • +
    • undetermined indicates that the service encountered an error while processing the corpus.
    • +
    See more
    @@ -333,7 +338,15 @@

    Declaration

    -

    The status of the corpus: * analyzed indicates that the service has successfully analyzed the corpus; the custom model can be trained with data from the corpus. * being_processed indicates that the service is still analyzing the corpus; the service cannot accept requests to add new corpora or words, or to train the custom model. * undetermined indicates that the service encountered an error while processing the corpus.

    +

    The status of the corpus:

    + +
      +
    • analyzed indicates that the service has successfully analyzed the corpus; the custom model can be trained with +data from the corpus.
    • +
    • being_processed indicates that the service is still analyzing the corpus; the service cannot accept requests to +add new corpora or words, or to train the custom model.
    • +
    • undetermined indicates that the service encountered an error while processing the corpus.
    • +
    @@ -360,7 +373,8 @@

    Declaration

    -

    If the status of the corpus is undetermined, the following message: Analysis of corpus 'name' failed. Please try adding the corpus again by setting the 'allow_overwrite' flag to 'true'.

    +

    If the status of the corpus is undetermined, the following message: Analysis of corpus 'name' failed. Please try +adding the corpus again by setting the 'allow_overwrite' flag to 'true'.

    @@ -379,7 +393,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/Corpus/Status.html b/docs/swift-api/services/SpeechToTextV1/Structs/Corpus/Status.html index 63a9d8c98..92d5fd88c 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/Corpus/Status.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/Corpus/Status.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,15 @@

    Status

    -

    The status of the corpus: * analyzed indicates that the service has successfully analyzed the corpus; the custom model can be trained with data from the corpus. * being_processed indicates that the service is still analyzing the corpus; the service cannot accept requests to add new corpora or words, or to train the custom model. * undetermined indicates that the service encountered an error while processing the corpus.

    +

    The status of the corpus:

    + +
      +
    • analyzed indicates that the service has successfully analyzed the corpus; the custom model can be trained with +data from the corpus.
    • +
    • being_processed indicates that the service is still analyzing the corpus; the service cannot accept requests to +add new corpora or words, or to train the custom model.
    • +
    • undetermined indicates that the service encountered an error while processing the corpus.
    • +
    @@ -297,7 +302,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/CreateAcousticModel.html b/docs/swift-api/services/SpeechToTextV1/Structs/CreateAcousticModel.html index 62a7decc0..57621fd01 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/CreateAcousticModel.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/CreateAcousticModel.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,10 @@

    CreateAcousticModel

    -

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports acoustic model customization, refer to Language support for customization.

    +

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model +can be used only with the base model that it customizes. To determine whether a base model supports acoustic model +customization, refer to Language support for +customization.

    See more
    @@ -252,7 +252,9 @@

    Declaration

    -

    A user-defined name for the new custom acoustic model. Use a name that is unique among all custom acoustic models that you own. Use a localized name that matches the language of the custom model. Use a name that describes the acoustic environment of the custom model, such as Mobile custom model or Noisy car custom model.

    +

    A user-defined name for the new custom acoustic model. Use a name that is unique among all custom acoustic models +that you own. Use a localized name that matches the language of the custom model. Use a name that describes the +acoustic environment of the custom model, such as Mobile custom model or Noisy car custom model.

    @@ -279,7 +281,10 @@

    Declaration

    -

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports acoustic model customization, refer to Language support for customization.

    +

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model +can be used only with the base model that it customizes. To determine whether a base model supports acoustic model +customization, refer to Language support for +customization.

    @@ -306,7 +311,8 @@

    Declaration

    -

    A description of the new custom acoustic model. Use a localized description that matches the language of the custom model.

    +

    A description of the new custom acoustic model. Use a localized description that matches the language of the custom +model.

    @@ -340,7 +346,11 @@

    Declaration

    Declaration

    Swift

    -
    public init(name: String, baseModelName: String, description: String? = nil)
    +
    public init(
    +    name: String,
    +    baseModelName: String,
    +    description: String? = nil
    +)
    @@ -356,7 +366,9 @@

    Parameters

    -

    A user-defined name for the new custom acoustic model. Use a name that is unique among all custom acoustic models that you own. Use a localized name that matches the language of the custom model. Use a name that describes the acoustic environment of the custom model, such as Mobile custom model or Noisy car custom model.

    +

    A user-defined name for the new custom acoustic model. Use a name that is unique among all custom acoustic models +that you own. Use a localized name that matches the language of the custom model. Use a name that describes the +acoustic environment of the custom model, such as Mobile custom model or Noisy car custom model.

    @@ -368,7 +380,10 @@

    Parameters

    -

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports acoustic model customization, refer to Language support for customization.

    +

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom +model can be used only with the base model that it customizes. To determine whether a base model supports +acoustic model customization, refer to Language support for +customization.

    @@ -380,7 +395,8 @@

    Parameters

    -

    A description of the new custom acoustic model. Use a localized description that matches the language of the custom model.

    +

    A description of the new custom acoustic model. Use a localized description that matches the language of the +custom model.

    @@ -399,7 +415,7 @@

    Return Value

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/CreateAcousticModel/BaseModelName.html b/docs/swift-api/services/SpeechToTextV1/Structs/CreateAcousticModel/BaseModelName.html index 95bdbc7f8..afd49ad9c 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/CreateAcousticModel/BaseModelName.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/CreateAcousticModel/BaseModelName.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,10 @@

    BaseModelName

    -

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports acoustic model customization, refer to Language support for customization.

    +

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model +can be used only with the base model that it customizes. To determine whether a base model supports acoustic model +customization, refer to Language support for +customization.

    @@ -648,7 +648,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/CreateLanguageModel.html b/docs/swift-api/services/SpeechToTextV1/Structs/CreateLanguageModel.html index 44bbb3e7e..4f79d7eee 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/CreateLanguageModel.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/CreateLanguageModel.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,11 @@

    CreateLanguageModel

    -

    The name of the base language model that is to be customized by the new custom language model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports language model customization, request information about the base model and check that the attribute custom_language_model is set to true, or refer to Language support for customization.

    +

    The name of the base language model that is to be customized by the new custom language model. The new custom model +can be used only with the base model that it customizes. To determine whether a base model supports language model +customization, request information about the base model and check that the attribute custom_language_model is set +to true, or refer to Language support for +customization.

    See more
    @@ -252,7 +253,9 @@

    Declaration

    -

    A user-defined name for the new custom language model. Use a name that is unique among all custom language models that you own. Use a localized name that matches the language of the custom model. Use a name that describes the domain of the custom model, such as Medical custom model or Legal custom model.

    +

    A user-defined name for the new custom language model. Use a name that is unique among all custom language models +that you own. Use a localized name that matches the language of the custom model. Use a name that describes the +domain of the custom model, such as Medical custom model or Legal custom model.

    @@ -279,7 +282,11 @@

    Declaration

    -

    The name of the base language model that is to be customized by the new custom language model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports language model customization, request information about the base model and check that the attribute custom_language_model is set to true, or refer to Language support for customization.

    +

    The name of the base language model that is to be customized by the new custom language model. The new custom model +can be used only with the base model that it customizes. To determine whether a base model supports language model +customization, request information about the base model and check that the attribute custom_language_model is set +to true, or refer to Language support for +customization.

    @@ -306,7 +313,17 @@

    Declaration

    -

    The dialect of the specified language that is to be used with the custom language model. The parameter is meaningful only for Spanish models, for which the service creates a custom language model that is suited for speech in one of the following dialects: * es-ES for Castilian Spanish (the default) * es-LA for Latin American Spanish * es-US for North American (Mexican) Spanish A specified dialect must be valid for the base model. By default, the dialect matches the language of the base model; for example, en-US for either of the US English language models.

    +

    The dialect of the specified language that is to be used with the custom language model. The parameter is +meaningful only for Spanish models, for which the service creates a custom language model that is suited for speech +in one of the following dialects:

    + +
      +
    • es-ES for Castilian Spanish (the default)
    • +
    • es-LA for Latin American Spanish
    • +
    • es-US for North American (Mexican) Spanish +A specified dialect must be valid for the base model. By default, the dialect matches the language of the base +model; for example, en-US for either of the US English language models.
    • +
    @@ -333,7 +350,8 @@

    Declaration

    -

    A description of the new custom language model. Use a localized description that matches the language of the custom model.

    +

    A description of the new custom language model. Use a localized description that matches the language of the custom +model.

    @@ -367,7 +385,12 @@

    Declaration

    Declaration

    Swift

    -
    public init(name: String, baseModelName: String, dialect: String? = nil, description: String? = nil)
    +
    public init(
    +    name: String,
    +    baseModelName: String,
    +    dialect: String? = nil,
    +    description: String? = nil
    +)
    @@ -383,7 +406,9 @@

    Parameters

    -

    A user-defined name for the new custom language model. Use a name that is unique among all custom language models that you own. Use a localized name that matches the language of the custom model. Use a name that describes the domain of the custom model, such as Medical custom model or Legal custom model.

    +

    A user-defined name for the new custom language model. Use a name that is unique among all custom language models +that you own. Use a localized name that matches the language of the custom model. Use a name that describes the +domain of the custom model, such as Medical custom model or Legal custom model.

    @@ -395,7 +420,11 @@

    Parameters

    -

    The name of the base language model that is to be customized by the new custom language model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports language model customization, request information about the base model and check that the attribute custom_language_model is set to true, or refer to Language support for customization.

    +

    The name of the base language model that is to be customized by the new custom language model. The new custom +model can be used only with the base model that it customizes. To determine whether a base model supports +language model customization, request information about the base model and check that the attribute +custom_language_model is set to true, or refer to Language support for +customization.

    @@ -407,7 +436,17 @@

    Parameters

    -

    The dialect of the specified language that is to be used with the custom language model. The parameter is meaningful only for Spanish models, for which the service creates a custom language model that is suited for speech in one of the following dialects: * es-ES for Castilian Spanish (the default) * es-LA for Latin American Spanish * es-US for North American (Mexican) Spanish A specified dialect must be valid for the base model. By default, the dialect matches the language of the base model; for example, en-US for either of the US English language models.

    +

    The dialect of the specified language that is to be used with the custom language model. The parameter is +meaningful only for Spanish models, for which the service creates a custom language model that is suited for +speech in one of the following dialects: + +

      +
    • es-ES for Castilian Spanish (the default)
    • +
    • es-LA for Latin American Spanish
    • +
    • es-US for North American (Mexican) Spanish +A specified dialect must be valid for the base model. By default, the dialect matches the language of the base +model; for example, en-US for either of the US English language models.
    • +

    @@ -419,7 +458,8 @@

    Parameters

    -

    A description of the new custom language model. Use a localized description that matches the language of the custom model.

    +

    A description of the new custom language model. Use a localized description that matches the language of the +custom model.

    @@ -438,7 +478,7 @@

    Return Value

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/CreateLanguageModel/BaseModelName.html b/docs/swift-api/services/SpeechToTextV1/Structs/CreateLanguageModel/BaseModelName.html index 4c00b86f8..c362e6e8e 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/CreateLanguageModel/BaseModelName.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/CreateLanguageModel/BaseModelName.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,11 @@

    BaseModelName

    -

    The name of the base language model that is to be customized by the new custom language model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports language model customization, request information about the base model and check that the attribute custom_language_model is set to true, or refer to Language support for customization.

    +

    The name of the base language model that is to be customized by the new custom language model. The new custom model +can be used only with the base model that it customizes. To determine whether a base model supports language model +customization, request information about the base model and check that the attribute custom_language_model is set +to true, or refer to Language support for +customization.

    @@ -513,7 +514,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/CustomWord.html b/docs/swift-api/services/SpeechToTextV1/Structs/CustomWord.html index 11b1fea40..032e804a8 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/CustomWord.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/CustomWord.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,10 @@

    CustomWord

    -

    For the Add custom words method, you must specify the custom word that is to be added to or updated in the custom model. Do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of compound words. Omit this field for the Add a custom word method.

    +

    For the Add custom words method, you must specify the custom word that is to be added to or updated in the +custom model. Do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of +compound words. +Omit this field for the Add a custom word method.

    @@ -251,7 +251,13 @@

    Declaration

    -

    An array of sounds-like pronunciations for the custom word. Specify how words that are difficult to pronounce, foreign words, acronyms, and so on can be pronounced by users. For a word that is not in the service’s base vocabulary, omit the parameter to have the service automatically generate a sounds-like pronunciation for the word. For a word that is in the service’s base vocabulary, use the parameter to specify additional pronunciations for the word. You cannot override the default pronunciation of a word; pronunciations you add augment the pronunciation from the base vocabulary. A word can have at most five sounds-like pronunciations, and a pronunciation can include at most 40 characters not including spaces.

    +

    An array of sounds-like pronunciations for the custom word. Specify how words that are difficult to pronounce, +foreign words, acronyms, and so on can be pronounced by users. For a word that is not in the service’s base +vocabulary, omit the parameter to have the service automatically generate a sounds-like pronunciation for the word. +For a word that is in the service’s base vocabulary, use the parameter to specify additional pronunciations for the +word. You cannot override the default pronunciation of a word; pronunciations you add augment the pronunciation +from the base vocabulary. A word can have at most five sounds-like pronunciations, and a pronunciation can include +at most 40 characters not including spaces.

    @@ -278,7 +284,9 @@

    Declaration

    -

    An alternative spelling for the custom word when it appears in a transcript. Use the parameter when you want the word to have a spelling that is different from its usual representation or from its spelling in corpora training data.

    +

    An alternative spelling for the custom word when it appears in a transcript. Use the parameter when you want the +word to have a spelling that is different from its usual representation or from its spelling in corpora training +data.

    @@ -312,7 +320,11 @@

    Declaration

    Declaration

    Swift

    -
    public init(word: String? = nil, soundsLike: [String]? = nil, displayAs: String? = nil)
    +
    public init(
    +    word: String? = nil,
    +    soundsLike: [String]? = nil,
    +    displayAs: String? = nil
    +)
    @@ -328,7 +340,10 @@

    Parameters

    -

    For the Add custom words method, you must specify the custom word that is to be added to or updated in the custom model. Do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of compound words. Omit this field for the Add a custom word method.

    +

    For the Add custom words method, you must specify the custom word that is to be added to or updated in the +custom model. Do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of +compound words. +Omit this field for the Add a custom word method.

    @@ -340,7 +355,13 @@

    Parameters

    -

    An array of sounds-like pronunciations for the custom word. Specify how words that are difficult to pronounce, foreign words, acronyms, and so on can be pronounced by users. For a word that is not in the service’s base vocabulary, omit the parameter to have the service automatically generate a sounds-like pronunciation for the word. For a word that is in the service’s base vocabulary, use the parameter to specify additional pronunciations for the word. You cannot override the default pronunciation of a word; pronunciations you add augment the pronunciation from the base vocabulary. A word can have at most five sounds-like pronunciations, and a pronunciation can include at most 40 characters not including spaces.

    +

    An array of sounds-like pronunciations for the custom word. Specify how words that are difficult to pronounce, +foreign words, acronyms, and so on can be pronounced by users. For a word that is not in the service’s base +vocabulary, omit the parameter to have the service automatically generate a sounds-like pronunciation for the +word. For a word that is in the service’s base vocabulary, use the parameter to specify additional pronunciations +for the word. You cannot override the default pronunciation of a word; pronunciations you add augment the +pronunciation from the base vocabulary. A word can have at most five sounds-like pronunciations, and a +pronunciation can include at most 40 characters not including spaces.

    @@ -352,7 +373,9 @@

    Parameters

    -

    An alternative spelling for the custom word when it appears in a transcript. Use the parameter when you want the word to have a spelling that is different from its usual representation or from its spelling in corpora training data.

    +

    An alternative spelling for the custom word when it appears in a transcript. Use the parameter when you want the +word to have a spelling that is different from its usual representation or from its spelling in corpora training +data.

    @@ -371,7 +394,7 @@

    Return Value

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/CustomWords.html b/docs/swift-api/services/SpeechToTextV1/Structs/CustomWords.html index dc16de9ac..616b305d6 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/CustomWords.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/CustomWords.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,8 @@

    CustomWords

    -

    An array of objects that provides information about each custom word that is to be added to or updated in the custom language model.

    +

    An array of objects that provides information about each custom word that is to be added to or updated in the +custom language model.

    @@ -258,7 +256,9 @@

    Declaration

    Declaration

    Swift

    -
    public init(words: [CustomWord])
    +
    public init(
    +    words: [CustomWord]
    +)
    @@ -274,7 +274,8 @@

    Parameters

    -

    An array of objects that provides information about each custom word that is to be added to or updated in the custom language model.

    +

    An array of objects that provides information about each custom word that is to be added to or updated in the +custom language model.

    @@ -293,7 +294,7 @@

    Return Value

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/KeywordResult.html b/docs/swift-api/services/SpeechToTextV1/Structs/KeywordResult.html index 71269df0b..f1f6d51d7 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/KeywordResult.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/KeywordResult.html @@ -113,9 +113,6 @@ - @@ -324,7 +321,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/LanguageModel.html b/docs/swift-api/services/SpeechToTextV1/Structs/LanguageModel.html index d53530ba1..6d078b5e0 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/LanguageModel.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/LanguageModel.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,17 @@

    LanguageModel

    -

    The current status of the custom language model: * pending indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * ready indicates that the model contains data and is ready to be trained. * training indicates that the model is currently being trained. * available indicates that the model is trained and ready to use. * upgrading indicates that the model is currently being upgraded. * failed indicates that training of the model failed.

    +

    The current status of the custom language model:

    + +
      +
    • pending indicates that the model was created but is waiting either for training data to be added or for the +service to finish analyzing added data.
    • +
    • ready indicates that the model contains data and is ready to be trained.
    • +
    • training indicates that the model is currently being trained.
    • +
    • available indicates that the model is trained and ready to use.
    • +
    • upgrading indicates that the model is currently being upgraded.
    • +
    • failed indicates that training of the model failed.
    • +
    See more
    @@ -252,7 +259,8 @@

    Declaration

    -

    The customization ID (GUID) of the custom language model. The Create a custom language model method returns only this field of the object; it does not return the other fields.

    +

    The customization ID (GUID) of the custom language model. The Create a custom language model method returns +only this field of the object; it does not return the other fields.

    @@ -279,7 +287,8 @@

    Declaration

    -

    The date and time in Coordinated Universal Time (UTC) at which the custom language model was created. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    +

    The date and time in Coordinated Universal Time (UTC) at which the custom language model was created. The value is +provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    @@ -333,7 +342,15 @@

    Declaration

    -

    The dialect of the language for the custom language model. By default, the dialect matches the language of the base model; for example, en-US for either of the US English language models. For Spanish models, the field indicates the dialect for which the model was created: * es-ES for Castilian Spanish (the default) * es-LA for Latin American Spanish * es-US for North American (Mexican) Spanish.

    +

    The dialect of the language for the custom language model. By default, the dialect matches the language of the base +model; for example, en-US for either of the US English language models. For Spanish models, the field indicates +the dialect for which the model was created:

    + +
      +
    • es-ES for Castilian Spanish (the default)
    • +
    • es-LA for Latin American Spanish
    • +
    • es-US for North American (Mexican) Spanish.
    • +
    @@ -360,7 +377,9 @@

    Declaration

    -

    A list of the available versions of the custom language model. Each element of the array indicates a version of the base model with which the custom model can be used. Multiple versions exist only if the custom model has been upgraded; otherwise, only a single version is shown.

    +

    A list of the available versions of the custom language model. Each element of the array indicates a version of the +base model with which the custom model can be used. Multiple versions exist only if the custom model has been +upgraded; otherwise, only a single version is shown.

    @@ -495,7 +514,17 @@

    Declaration

    -

    The current status of the custom language model: * pending indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * ready indicates that the model contains data and is ready to be trained. * training indicates that the model is currently being trained. * available indicates that the model is trained and ready to use. * upgrading indicates that the model is currently being upgraded. * failed indicates that training of the model failed.

    +

    The current status of the custom language model:

    + +
      +
    • pending indicates that the model was created but is waiting either for training data to be added or for the +service to finish analyzing added data.
    • +
    • ready indicates that the model contains data and is ready to be trained.
    • +
    • training indicates that the model is currently being trained.
    • +
    • available indicates that the model is trained and ready to use.
    • +
    • upgrading indicates that the model is currently being upgraded.
    • +
    • failed indicates that training of the model failed.
    • +
    @@ -522,7 +551,9 @@

    Declaration

    -

    A percentage that indicates the progress of the custom language model’s current training. A value of 100 means that the model is fully trained. Note: The progress field does not currently reflect the progress of the training. The field changes from 0 to 100 when training is complete.

    +

    A percentage that indicates the progress of the custom language model’s current training. A value of 100 means +that the model is fully trained. Note: The progress field does not currently reflect the progress of the +training. The field changes from 0 to 100 when training is complete.

    @@ -549,7 +580,8 @@

    Declaration

    -

    If the request included unknown parameters, the following message: Unexpected query parameter(s) ['parameters'] detected, where parameters is a list that includes a quoted string for each unknown parameter.

    +

    If the request included unknown parameters, the following message: Unexpected query parameter(s) ['parameters'] +detected, where parameters is a list that includes a quoted string for each unknown parameter.

    @@ -568,7 +600,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/LanguageModel/Status.html b/docs/swift-api/services/SpeechToTextV1/Structs/LanguageModel/Status.html index bdd8eda7b..bf1e89400 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/LanguageModel/Status.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/LanguageModel/Status.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,17 @@

    Status

    -

    The current status of the custom language model: * pending indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * ready indicates that the model contains data and is ready to be trained. * training indicates that the model is currently being trained. * available indicates that the model is trained and ready to use. * upgrading indicates that the model is currently being upgraded. * failed indicates that training of the model failed.

    +

    The current status of the custom language model:

    + +
      +
    • pending indicates that the model was created but is waiting either for training data to be added or for the +service to finish analyzing added data.
    • +
    • ready indicates that the model contains data and is ready to be trained.
    • +
    • training indicates that the model is currently being trained.
    • +
    • available indicates that the model is trained and ready to use.
    • +
    • upgrading indicates that the model is currently being upgraded.
    • +
    • failed indicates that training of the model failed.
    • +
    @@ -378,7 +385,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/LanguageModels.html b/docs/swift-api/services/SpeechToTextV1/Structs/LanguageModels.html index c41fa63db..c718ee05c 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/LanguageModels.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/LanguageModels.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,9 @@

    LanguageModels

    -

    An array of objects that provides information about each available custom language model. The array is empty if the requesting service credentials own no custom language models (if no language is specified) or own no custom language models for the specified language.

    +

    An array of objects that provides information about each available custom language model. The array is empty if the +requesting service credentials own no custom language models (if no language is specified) or own no custom +language models for the specified language.

    @@ -243,7 +242,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/RecognitionJob.html b/docs/swift-api/services/SpeechToTextV1/Structs/RecognitionJob.html index f44da3b74..cb7073887 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/RecognitionJob.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/RecognitionJob.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,18 @@

    RecognitionJob

    -

    The current status of the job: * waiting: The service is preparing the job for processing. The service returns this status when the job is initially created or when it is waiting for capacity to process the job. The job remains in this state until the service has the capacity to begin processing it. * processing: The service is actively processing the job. * completed: The service has finished processing the job. If the job specified a callback URL and the event recognitions.completed_with_results, the service sent the results with the callback notification; otherwise, you must retrieve the results by checking the individual job. * failed: The job failed.

    +

    The current status of the job:

    + +
      +
    • waiting: The service is preparing the job for processing. The service returns this status when the job is +initially created or when it is waiting for capacity to process the job. The job remains in this state until the +service has the capacity to begin processing it.
    • +
    • processing: The service is actively processing the job.
    • +
    • completed: The service has finished processing the job. If the job specified a callback URL and the event +recognitions.completed_with_results, the service sent the results with the callback notification; otherwise, you +must retrieve the results by checking the individual job.
    • +
    • failed: The job failed.
    • +
    See more
    @@ -279,7 +287,18 @@

    Declaration

    -

    The current status of the job: * waiting: The service is preparing the job for processing. The service returns this status when the job is initially created or when it is waiting for capacity to process the job. The job remains in this state until the service has the capacity to begin processing it. * processing: The service is actively processing the job. * completed: The service has finished processing the job. If the job specified a callback URL and the event recognitions.completed_with_results, the service sent the results with the callback notification; otherwise, you must retrieve the results by checking the individual job. * failed: The job failed.

    +

    The current status of the job:

    + +
      +
    • waiting: The service is preparing the job for processing. The service returns this status when the job is +initially created or when it is waiting for capacity to process the job. The job remains in this state until the +service has the capacity to begin processing it.
    • +
    • processing: The service is actively processing the job.
    • +
    • completed: The service has finished processing the job. If the job specified a callback URL and the event +recognitions.completed_with_results, the service sent the results with the callback notification; otherwise, you +must retrieve the results by checking the individual job.
    • +
    • failed: The job failed.
    • +
    @@ -306,7 +325,8 @@

    Declaration

    -

    The date and time in Coordinated Universal Time (UTC) at which the job was created. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    +

    The date and time in Coordinated Universal Time (UTC) at which the job was created. The value is provided in full +ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    @@ -333,7 +353,9 @@

    Declaration

    -

    The date and time in Coordinated Universal Time (UTC) at which the job was last updated by the service. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD). This field is returned only by the Check jobs and Check a job methods.

    +

    The date and time in Coordinated Universal Time (UTC) at which the job was last updated by the service. The value +is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD). This field is returned only by the Check jobs +and Check a job methods.

    @@ -360,7 +382,8 @@

    Declaration

    -

    The URL to use to request information about the job with the Check a job method. This field is returned only by the Create a job method.

    +

    The URL to use to request information about the job with the Check a job method. This field is returned only by +the Create a job method.

    @@ -387,7 +410,8 @@

    Declaration

    -

    The user token associated with a job that was created with a callback URL and a user token. This field can be returned only by the Check jobs method.

    +

    The user token associated with a job that was created with a callback URL and a user token. This field can be +returned only by the Check jobs method.

    @@ -414,7 +438,8 @@

    Declaration

    -

    If the status is completed, the results of the recognition request as an array that includes a single instance of a SpeechRecognitionResults object. This field is returned only by the Check a job method.

    +

    If the status is completed, the results of the recognition request as an array that includes a single instance of +a SpeechRecognitionResults object. This field is returned only by the Check a job method.

    @@ -441,7 +466,10 @@

    Declaration

    -

    An array of warning messages about invalid parameters included with the request. Each warning includes a descriptive message and a list of invalid argument strings, for example, "unexpected query parameter 'user_token', query parameter 'callback_url' was not specified". The request succeeds despite the warnings. This field can be returned only by the Create a job method.

    +

    An array of warning messages about invalid parameters included with the request. Each warning includes a +descriptive message and a list of invalid argument strings, for example, "unexpected query parameter 'user_token', +query parameter 'callback_url' was not specified". The request succeeds despite the warnings. This field can be +returned only by the Create a job method.

    @@ -460,7 +488,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/RecognitionJob/Status.html b/docs/swift-api/services/SpeechToTextV1/Structs/RecognitionJob/Status.html index ce65ec196..81ba8a65c 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/RecognitionJob/Status.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/RecognitionJob/Status.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,18 @@

    Status

    -

    The current status of the job: * waiting: The service is preparing the job for processing. The service returns this status when the job is initially created or when it is waiting for capacity to process the job. The job remains in this state until the service has the capacity to begin processing it. * processing: The service is actively processing the job. * completed: The service has finished processing the job. If the job specified a callback URL and the event recognitions.completed_with_results, the service sent the results with the callback notification; otherwise, you must retrieve the results by checking the individual job. * failed: The job failed.

    +

    The current status of the job:

    + +
      +
    • waiting: The service is preparing the job for processing. The service returns this status when the job is +initially created or when it is waiting for capacity to process the job. The job remains in this state until the +service has the capacity to begin processing it.
    • +
    • processing: The service is actively processing the job.
    • +
    • completed: The service has finished processing the job. If the job specified a callback URL and the event +recognitions.completed_with_results, the service sent the results with the callback notification; otherwise, you +must retrieve the results by checking the individual job.
    • +
    • failed: The job failed.
    • +
    @@ -324,7 +332,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/RecognitionJobs.html b/docs/swift-api/services/SpeechToTextV1/Structs/RecognitionJobs.html index f861ec359..720a53f23 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/RecognitionJobs.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/RecognitionJobs.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,8 @@

    RecognitionJobs

    -

    An array of objects that provides the status for each of the user’s current jobs. The array is empty if the user has no current jobs.

    +

    An array of objects that provides the status for each of the user’s current jobs. The array is empty if the user +has no current jobs.

    @@ -243,7 +241,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/RecognitionSettings.html b/docs/swift-api/services/SpeechToTextV1/Structs/RecognitionSettings.html index b4bb2656f..1f9a65b65 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/RecognitionSettings.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/RecognitionSettings.html @@ -113,9 +113,6 @@ - @@ -617,7 +614,7 @@

    Return Value

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/RegisterStatus.html b/docs/swift-api/services/SpeechToTextV1/Structs/RegisterStatus.html index 6411baa6d..cd9943cab 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/RegisterStatus.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/RegisterStatus.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,12 @@

    RegisterStatus

    -

    The current status of the job: * created if the callback URL was successfully white-listed as a result of the call. * already created if the URL was already white-listed.

    +

    The current status of the job:

    + +
      +
    • created if the callback URL was successfully white-listed as a result of the call.
    • +
    • already created if the URL was already white-listed.
    • +
    See more
    @@ -252,7 +254,12 @@

    Declaration

    -

    The current status of the job: * created if the callback URL was successfully white-listed as a result of the call. * already created if the URL was already white-listed.

    +

    The current status of the job:

    + +
      +
    • created if the callback URL was successfully white-listed as a result of the call.
    • +
    • already created if the URL was already white-listed.
    • +
    @@ -298,7 +305,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/RegisterStatus/Status.html b/docs/swift-api/services/SpeechToTextV1/Structs/RegisterStatus/Status.html index fb1d3a772..5063fc7a1 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/RegisterStatus/Status.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/RegisterStatus/Status.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,12 @@

    Status

    -

    The current status of the job: * created if the callback URL was successfully white-listed as a result of the call. * already created if the URL was already white-listed.

    +

    The current status of the job:

    + +
      +
    • created if the callback URL was successfully white-listed as a result of the call.
    • +
    • already created if the URL was already white-listed.
    • +
    @@ -270,7 +272,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/SpeakerLabelsResult.html b/docs/swift-api/services/SpeechToTextV1/Structs/SpeakerLabelsResult.html index c9f53274d..8730114e3 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/SpeakerLabelsResult.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/SpeakerLabelsResult.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,8 @@

    SpeakerLabelsResult

    -

    The start time of a word from the transcript. The value matches the start time of a word from the timestamps array.

    +

    The start time of a word from the transcript. The value matches the start time of a word from the timestamps +array.

    @@ -278,7 +276,9 @@

    Declaration

    -

    The numeric identifier that the service assigns to a speaker from the audio. Speaker IDs begin at 0 initially but can evolve and change across interim results (if supported by the method) and between interim and final results as the service processes the audio. They are not guaranteed to be sequential, contiguous, or ordered.

    +

    The numeric identifier that the service assigns to a speaker from the audio. Speaker IDs begin at 0 initially but +can evolve and change across interim results (if supported by the method) and between interim and final results as +the service processes the audio. They are not guaranteed to be sequential, contiguous, or ordered.

    @@ -332,7 +332,9 @@

    Declaration

    -

    An indication of whether the service might further change word and speaker-label results. A value of true means that the service guarantees not to send any further updates for the current or any preceding results; false means that the service might send further updates to the results.

    +

    An indication of whether the service might further change word and speaker-label results. A value of true means +that the service guarantees not to send any further updates for the current or any preceding results; false means +that the service might send further updates to the results.

    @@ -351,7 +353,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/SpeechModel.html b/docs/swift-api/services/SpeechToTextV1/Structs/SpeechModel.html index be4e9b5cc..f431d18e1 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/SpeechModel.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/SpeechModel.html @@ -113,9 +113,6 @@ - @@ -386,7 +383,8 @@

    Declaration

    -

    The URI for the model for use with the Create a session method. This field is returned only by the Get a model method.

    +

    The URI for the model for use with the Create a session method. This field is returned only by the Get a +model method.

    @@ -405,7 +403,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/SpeechModels.html b/docs/swift-api/services/SpeechToTextV1/Structs/SpeechModels.html index b82e86301..057c4a2bf 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/SpeechModels.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/SpeechModels.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,7 @@

    SpeechModels

    -

    Information about each available model.

    +

    An array of objects that provides information about each available model.

    @@ -243,7 +240,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/SpeechRecognitionAlternative.html b/docs/swift-api/services/SpeechToTextV1/Structs/SpeechRecognitionAlternative.html index 84669e71d..695fc6241 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/SpeechRecognitionAlternative.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/SpeechRecognitionAlternative.html @@ -113,9 +113,6 @@ - @@ -251,7 +248,8 @@

    Declaration

    -

    A score that indicates the service’s confidence in the transcript in the range of 0 to 1. Returned only for the best alternative and only with results marked as final.

    +

    A score that indicates the service’s confidence in the transcript in the range of 0 to 1. Returned only for the +best alternative and only with results marked as final.

    @@ -278,7 +276,9 @@

    Declaration

    -

    Time alignments for each word from the transcript as a list of lists. Each inner list consists of three elements: the word followed by its start and end time in seconds. Example: [["hello",0.0,1.2],["world",1.2,2.5]]. Returned only for the best alternative.

    +

    Time alignments for each word from the transcript as a list of lists. Each inner list consists of three elements: +the word followed by its start and end time in seconds. Example: [["hello",0.0,1.2],["world",1.2,2.5]]. Returned +only for the best alternative.

    @@ -305,7 +305,9 @@

    Declaration

    -

    A confidence score for each word of the transcript as a list of lists. Each inner list consists of two elements: the word and its confidence score in the range of 0 to 1. Example: [["hello",0.95],["world",0.866]]. Returned only for the best alternative and only with results marked as final.

    +

    A confidence score for each word of the transcript as a list of lists. Each inner list consists of two elements: +the word and its confidence score in the range of 0 to 1. Example: [["hello",0.95],["world",0.866]]. Returned +only for the best alternative and only with results marked as final.

    @@ -324,7 +326,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/SpeechRecognitionResult.html b/docs/swift-api/services/SpeechToTextV1/Structs/SpeechRecognitionResult.html index ddd3ab3d6..b4dbf3a69 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/SpeechRecognitionResult.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/SpeechRecognitionResult.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,8 @@

    SpeechRecognitionResult

    -

    An indication of whether the transcription results are final. If true, the results for this utterance are not updated further; no additional results are sent for a result_index once its results are indicated as final.

    +

    An indication of whether the transcription results are final. If true, the results for this utterance are not +updated further; no additional results are sent for a result_index once its results are indicated as final.

    @@ -251,7 +249,8 @@

    Declaration

    -

    An array of alternative transcripts. The alternatives array can include additional requested output such as word confidence or timestamps.

    +

    An array of alternative transcripts. The alternatives array can include additional requested output such as word +confidence or timestamps.

    @@ -278,7 +277,9 @@

    Declaration

    -

    A dictionary (or associative array) whose keys are the strings specified for keywords if both that parameter and keywords_threshold are specified. A keyword for which no matches are found is omitted from the array. The array is omitted if no matches are found for any keywords.

    +

    A dictionary (or associative array) whose keys are the strings specified for keywords if both that parameter and +keywords_threshold are specified. A keyword for which no matches are found is omitted from the array. The array +is omitted if no matches are found for any keywords.

    @@ -305,7 +306,8 @@

    Declaration

    -

    An array of alternative hypotheses found for words of the input audio if a word_alternatives_threshold is specified.

    +

    An array of alternative hypotheses found for words of the input audio if a word_alternatives_threshold is +specified.

    @@ -324,7 +326,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/SpeechRecognitionResults.html b/docs/swift-api/services/SpeechToTextV1/Structs/SpeechRecognitionResults.html index c6e1cd630..58b5aac82 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/SpeechRecognitionResults.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/SpeechRecognitionResults.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,10 @@

    SpeechRecognitionResults

    -

    An array that can include interim and final results (interim results are returned only if supported by the method). Final results are guaranteed not to change; interim results might be replaced by further interim results and final results. The service periodically sends updates to the results list; the result_index is set to the lowest index in the array that has changed; it is incremented for new results.

    +

    An array that can include interim and final results (interim results are returned only if supported by the method). +Final results are guaranteed not to change; interim results might be replaced by further interim results and final +results. The service periodically sends updates to the results list; the result_index is set to the lowest index +in the array that has changed; it is incremented for new results.

    @@ -251,7 +251,8 @@

    Declaration

    -

    An index that indicates a change point in the results array. The service increments the index only for additional results that it sends for new audio for the same request.

    +

    An index that indicates a change point in the results array. The service increments the index only for additional +results that it sends for new audio for the same request.

    @@ -278,7 +279,9 @@

    Declaration

    -

    An array that identifies which words were spoken by which speakers in a multi-person exchange. Returned in the response only if speaker_labels is true. When interim results are also requested for methods that support them, it is possible for a SpeechRecognitionResults object to include only the speaker_labels field.

    +

    An array that identifies which words were spoken by which speakers in a multi-person exchange. Returned in the +response only if speaker_labels is true. When interim results are also requested for methods that support them, +it is possible for a SpeechRecognitionResults object to include only the speaker_labels field.

    @@ -305,7 +308,19 @@

    Declaration

    -

    An array of warning messages associated with the request: * Warnings for invalid parameters or fields can include a descriptive message and a list of invalid argument strings, for example, "Unknown arguments:" or "Unknown url query arguments:" followed by a list of the form "invalid_arg_1, invalid_arg_2." * The following warning is returned if the request passes a custom model that is based on an older version of a base model for which an updated version is available: "Using previous version of base model, because your custom model has been built with it. Please note that this version will be supported only for a limited time. Consider updating your custom model to the new base model. If you do not do that you will be automatically switched to base model when you used the non-updated custom model." In both cases, the request succeeds despite the warnings.

    +

    An array of warning messages associated with the request:

    + +
      +
    • Warnings for invalid parameters or fields can include a descriptive message and a list of invalid argument +strings, for example, "Unknown arguments:" or "Unknown url query arguments:" followed by a list of the form +"invalid_arg_1, invalid_arg_2."
    • +
    • The following warning is returned if the request passes a custom model that is based on an older version of a +base model for which an updated version is available: "Using previous version of base model, because your custom +model has been built with it. Please note that this version will be supported only for a limited time. Consider +updating your custom model to the new base model. If you do not do that you will be automatically switched to base +model when you used the non-updated custom model." +In both cases, the request succeeds despite the warnings.
    • +
    @@ -324,7 +339,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/SpeechRecognitionResultsAccumulator.html b/docs/swift-api/services/SpeechToTextV1/Structs/SpeechRecognitionResultsAccumulator.html index 548b771bc..41619868b 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/SpeechRecognitionResultsAccumulator.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/SpeechRecognitionResultsAccumulator.html @@ -113,9 +113,6 @@ - @@ -351,7 +348,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/SupportedFeatures.html b/docs/swift-api/services/SpeechToTextV1/Structs/SupportedFeatures.html index 5d4571285..bd46463b8 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/SupportedFeatures.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/SupportedFeatures.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,8 @@

    SupportedFeatures

    -

    Indicates whether the customization interface can be used to create a custom language model based on the language model.

    +

    Indicates whether the customization interface can be used to create a custom language model based on the language +model.

    @@ -270,7 +268,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/Word.html b/docs/swift-api/services/SpeechToTextV1/Structs/Word.html index cf8499a32..82d586b48 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/Word.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/Word.html @@ -113,9 +113,6 @@ - @@ -251,7 +248,9 @@

    Declaration

    -

    An array of pronunciations for the word. The array can include the sounds-like pronunciation automatically generated by the service if none is provided for the word; the service adds this pronunciation when it finishes processing the word.

    +

    An array of pronunciations for the word. The array can include the sounds-like pronunciation automatically +generated by the service if none is provided for the word; the service adds this pronunciation when it finishes +processing the word.

    @@ -278,7 +277,8 @@

    Declaration

    -

    The spelling of the word that the service uses to display the word in a transcript. The field contains an empty string if no display-as value is provided for the word, in which case the word is displayed as it is spelled.

    +

    The spelling of the word that the service uses to display the word in a transcript. The field contains an empty +string if no display-as value is provided for the word, in which case the word is displayed as it is spelled.

    @@ -305,7 +305,10 @@

    Declaration

    -

    A sum of the number of times the word is found across all corpora. For example, if the word occurs five times in one corpus and seven times in another, its count is 12. If you add a custom word to a model before it is added by any corpora, the count begins at 1; if the word is added from a corpus first and later modified, the count reflects only the number of times it is found in corpora.

    +

    A sum of the number of times the word is found across all corpora. For example, if the word occurs five times in +one corpus and seven times in another, its count is 12. If you add a custom word to a model before it is added by +any corpora, the count begins at 1; if the word is added from a corpus first and later modified, the count +reflects only the number of times it is found in corpora.

    @@ -332,7 +335,9 @@

    Declaration

    -

    An array of sources that describes how the word was added to the custom model’s words resource. For OOV words added from a corpus, includes the name of the corpus; if the word was added by multiple corpora, the names of all corpora are listed. If the word was modified or added by the user directly, the field includes the string user.

    +

    An array of sources that describes how the word was added to the custom model’s words resource. For OOV words added +from a corpus, includes the name of the corpus; if the word was added by multiple corpora, the names of all corpora +are listed. If the word was modified or added by the user directly, the field includes the string user.

    @@ -359,7 +364,8 @@

    Declaration

    -

    If the service discovered one or more problems that you need to correct for the word’s definition, an array that describes each of the errors.

    +

    If the service discovered one or more problems that you need to correct for the word’s definition, an array that +describes each of the errors.

    @@ -378,7 +384,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/WordAlternativeResult.html b/docs/swift-api/services/SpeechToTextV1/Structs/WordAlternativeResult.html index 388351f9e..c86c0b401 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/WordAlternativeResult.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/WordAlternativeResult.html @@ -113,9 +113,6 @@ - @@ -270,7 +267,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/WordAlternativeResults.html b/docs/swift-api/services/SpeechToTextV1/Structs/WordAlternativeResults.html index 8576526f2..058677566 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/WordAlternativeResults.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/WordAlternativeResults.html @@ -113,9 +113,6 @@ - @@ -297,7 +294,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/WordConfidence.html b/docs/swift-api/services/SpeechToTextV1/Structs/WordConfidence.html index d2edac4cf..a582e30e3 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/WordConfidence.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/WordConfidence.html @@ -113,9 +113,6 @@ - @@ -297,7 +294,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/WordError.html b/docs/swift-api/services/SpeechToTextV1/Structs/WordError.html index 180902717..ce3df5ed5 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/WordError.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/WordError.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,11 @@

    WordError

    -

    A key-value pair that describes an error associated with the definition of a word in the words resource. Each pair has the format "element": "message", where element is the aspect of the definition that caused the problem and message describes the problem. The following example describes a problem with one of the word’s sounds-like definitions: "{sounds_like_string}": "Numbers are not allowed in sounds-like. You can try for example '{suggested_string}'." You must correct the error before you can train the model.

    +

    A key-value pair that describes an error associated with the definition of a word in the words resource. Each pair +has the format "element": "message", where element is the aspect of the definition that caused the problem and +message describes the problem. The following example describes a problem with one of the word’s sounds-like +definitions: "{sounds_like_string}": "Numbers are not allowed in sounds-like. You can try for example +'{suggested_string}'." You must correct the error before you can train the model.

    @@ -243,7 +244,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/WordTimestamp.html b/docs/swift-api/services/SpeechToTextV1/Structs/WordTimestamp.html index e7e02873a..e5dbe6963 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/WordTimestamp.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/WordTimestamp.html @@ -113,9 +113,6 @@ - @@ -324,7 +321,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/Structs/Words.html b/docs/swift-api/services/SpeechToTextV1/Structs/Words.html index 7d0405f25..cdf5bc55b 100644 --- a/docs/swift-api/services/SpeechToTextV1/Structs/Words.html +++ b/docs/swift-api/services/SpeechToTextV1/Structs/Words.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,8 @@

    Words

    -

    Information about each word in the custom model’s words resource. The array is empty if the custom model has no words.

    +

    An array of objects that provides information about each word in the custom model’s words resource. The array is +empty if the custom model has no words.

    @@ -243,7 +241,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Classes.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Classes.html index c78ec0b8a..7a4471d40 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Classes.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Classes.html @@ -113,9 +113,6 @@ - @@ -317,7 +314,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Classes/SpeechToText.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Classes/SpeechToText.html index 52b04d62f..fceddefa0 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Classes/SpeechToText.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Classes/SpeechToText.html @@ -113,9 +113,6 @@ - @@ -561,10 +558,10 @@

    Declaration

    -

    Get models.

    +

    List models.

    -

    Retrieves a list of all language models that are available for use with the service. The information includes the -name of the model and its minimum sampling rate in Hertz, among other things.

    +

    Lists all language models that are available for use with the service. The information includes the name of the +model and its minimum sampling rate in Hertz, among other things.

    @@ -639,8 +636,8 @@

    Parameters

    Get a model.

    -

    Retrieves information about a single specified language model that is available for use with the service. The -information includes the name of the model and its minimum sampling rate in Hertz, among other things.

    +

    Gets information for a single specified language model that is available for use with the service. The information +includes the name of the model and its minimum sampling rate in Hertz, among other things.

    @@ -726,34 +723,54 @@

    Parameters

    -

    Sends audio for speech recognition in sessionless mode.

    +

    Recognize audio.

    Sends audio and returns transcription results for a sessionless recognition request. Returns only the final results; to enable interim results, use session-based requests or the WebSocket API. The service imposes a data size limit of 100 MB. It automatically detects the endianness of the incoming audio and, for audio that includes multiple channels, downmixes the audio to one-channel mono during transcoding. (For the audio/l16 format, you can -specify the endianness.) ### Streaming mode For requests to transcribe live audio as it becomes available, you -must set the Transfer-Encoding header to chunked to use streaming mode. In streaming mode, the server closes -the connection (status code 408) if the service receives no data chunk for 30 seconds and the service has no audio -to transcribe for 30 seconds. The server also closes the connection (status code 400) if no speech is detected for -inactivity_timeout seconds of audio (not processing time); use the inactivity_timeout parameter to change the -default of 30 seconds. ### Audio formats (content types) Use the Content-Type header to specify the audio -format (MIME type) of the audio. The service accepts the following formats: * audio/basic (Use only with -narrowband models.) * audio/flac * audio/l16 (Specify the sampling rate (rate) and optionally the number of -channels (channels) and endianness (endianness) of the audio.) * audio/mp3 * audio/mpeg * audio/mulaw -(Specify the sampling rate (rate) of the audio.) * audio/ogg (The service automatically detects the codec of -the input audio.) * audio/ogg;codecs=opus * audio/ogg;codecs=vorbis * audio/wav (Provide audio with a maximum -of nine channels.) * audio/webm (The service automatically detects the codec of the input audio.) * -audio/webm;codecs=opus * audio/webm;codecs=vorbis For information about the supported audio formats, -including specifying the sampling rate, channels, and endianness for the indicated formats, see Audio -formats. ### Multipart speech -recognition The method also supports multipart recognition requests. With multipart requests, you pass all audio -data as multipart form data. You specify some parameters as request headers and query parameters, but you pass JSON -metadata as form data to control most aspects of the transcription. The multipart approach is intended for use -with browsers for which JavaScript is disabled or when the parameters used with the request are greater than the 8 -KB limit imposed by most HTTP servers and proxies. You can encounter this limit, for example, if you want to spot a -very large number of keywords. For information about submitting a multipart request, see Submitting multipart -requests as form data.

    +specify the endianness.)

    +

    Streaming mode

    + +

    For requests to transcribe live audio as it becomes available, you must set the Transfer-Encoding header to +chunked to use streaming mode. In streaming mode, the server closes the connection (status code 408) if the +service receives no data chunk for 30 seconds and the service has no audio to transcribe for 30 seconds. The server +also closes the connection (status code 400) if no speech is detected for inactivity_timeout seconds of audio +(not processing time); use the inactivity_timeout parameter to change the default of 30 seconds.

    +

    Audio formats (content types)

    + +

    Use the Content-Type header to specify the audio format (MIME type) of the audio. The service accepts the +following formats:

    + +
      +
    • audio/basic (Use only with narrowband models.)
    • +
    • audio/flac
    • +
    • audio/l16 (Specify the sampling rate (rate) and optionally the number of channels (channels) and endianness +(endianness) of the audio.)
    • +
    • audio/mp3
    • +
    • audio/mpeg
    • +
    • audio/mulaw (Specify the sampling rate (rate) of the audio.)
    • +
    • audio/ogg (The service automatically detects the codec of the input audio.)
    • +
    • audio/ogg;codecs=opus
    • +
    • audio/ogg;codecs=vorbis
    • +
    • audio/wav (Provide audio with a maximum of nine channels.)
    • +
    • audio/webm (The service automatically detects the codec of the input audio.)
    • +
    • audio/webm;codecs=opus
    • +
    • audio/webm;codecs=vorbis +For information about the supported audio formats, including specifying the sampling rate, channels, and endianness +for the indicated formats, see Audio +formats.

      +

      Multipart speech recognition

      + +

      The method also supports multipart recognition requests. With multipart requests, you pass all audio data as +multipart form data. You specify some parameters as request headers and query parameters, but you pass JSON +metadata as form data to control most aspects of the transcription. +The multipart approach is intended for use with browsers for which JavaScript is disabled or when the parameters +used with the request are greater than the 8 KB limit imposed by most HTTP servers and proxies. You can encounter +this limit, for example, if you want to spot a very large number of keywords. +For information about submitting a multipart request, see Submitting multipart requests as form +data.

    • +
    @@ -822,8 +839,8 @@

    Parameters

    -

    The identifier of the model that is to be used for the recognition request or, for the Create a session method, -with the new session.

    +

    The identifier of the model that is to be used for the recognition request or, for the Create a session +method, with the new session.

    @@ -835,10 +852,10 @@

    Parameters

    -

    The customization ID (GUID) of a custom language model that is to be used with the recognition request or, for the -Create a session method, with the new session. The base model of the specified custom language model must match -the model specified with the model parameter. You must make the request with service credentials created for the -instance of the service that owns the custom model. By default, no custom language model is used.

    +

    The customization ID (GUID) of a custom language model that is to be used with the recognition request or, for +the Create a session method, with the new session. The base model of the specified custom language model must +match the model specified with the model parameter. You must make the request with service credentials created +for the instance of the service that owns the custom model. By default, no custom language model is used.

    @@ -850,10 +867,10 @@

    Parameters

    -

    The customization ID (GUID) of a custom acoustic model that is to be used with the recognition request or, for the -Create a session method, with the new session. The base model of the specified custom acoustic model must match -the model specified with the model parameter. You must make the request with service credentials created for the -instance of the service that owns the custom model. By default, no custom acoustic model is used.

    +

    The customization ID (GUID) of a custom acoustic model that is to be used with the recognition request or, for +the Create a session method, with the new session. The base model of the specified custom acoustic model must +match the model specified with the model parameter. You must make the request with service credentials created +for the instance of the service that owns the custom model. By default, no custom acoustic model is used.

    @@ -867,9 +884,10 @@

    Parameters

    The version of the specified base model that is to be used with recognition request or, for the Create a session method, with the new session. Multiple versions of a base model can exist when a model is updated for -internal improvements. The parameter is intended primarily for use with custom models that have been upgraded for a -new base model. The default value depends on whether the parameter is used with or without a custom model. For more -information, see Base model version.

    +internal improvements. The parameter is intended primarily for use with custom models that have been upgraded for +a new base model. The default value depends on whether the parameter is used with or without a custom model. For +more information, see Base model +version.

    @@ -882,14 +900,14 @@

    Parameters

    If you specify the customization ID (GUID) of a custom language model with the recognition request or, for -sessions, with the Create a session method, the customization weight tells the service how much weight to give -to words from the custom language model compared to those from the base model for the current request. Specify a -value between 0.0 and 1.0. Unless a different customization weight was specified for the custom model when it was -trained, the default value is 0.3. A customization weight that you specify overrides a weight that was specified -when the custom model was trained. The default value yields the best performance in general. Assign a higher -value if your audio makes frequent use of OOV words from the custom model. Use caution when setting the weight: a -higher value can improve the accuracy of phrases from the custom model’s domain, but it can negatively affect -performance on non-domain phrases.

    +sessions, with the Create a session method, the customization weight tells the service how much weight to +give to words from the custom language model compared to those from the base model for the current request. +Specify a value between 0.0 and 1.0. Unless a different customization weight was specified for the custom model +when it was trained, the default value is 0.3. A customization weight that you specify overrides a weight that +was specified when the custom model was trained. +The default value yields the best performance in general. Assign a higher value if your audio makes frequent use +of OOV words from the custom model. Use caution when setting the weight: a higher value can improve the accuracy +of phrases from the custom model’s domain, but it can negatively affect performance on non-domain phrases.

    @@ -902,8 +920,8 @@

    Parameters

    The time in seconds after which, if only silence (no speech) is detected in submitted audio, the connection is -closed with a 400 error. Useful for stopping audio submission from a live microphone when a user simply walks away. -Use -1 for infinity.

    +closed with a 400 error. The parameter is useful for stopping audio submission from a live microphone when a user +simply walks away. Use -1 for infinity.

    @@ -915,10 +933,10 @@

    Parameters

    -

    An array of keyword strings to spot in the audio. Each keyword string can include one or more tokens. Keywords are -spotted only in the final hypothesis, not in interim results. If you specify any keywords, you must also specify a -keywords threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify an empty array if you do -not need to spot keywords.

    +

    An array of keyword strings to spot in the audio. Each keyword string can include one or more tokens. Keywords +are spotted only in the final results, not in interim hypotheses. If you specify any keywords, you must also +specify a keywords threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify an empty +array if you do not need to spot keywords.

    @@ -957,9 +975,9 @@

    Parameters

    -

    A confidence value that is the lower bound for identifying a hypothesis as a possible word alternative (also known -as \Confusion Networks\). An alternative word is considered if its confidence is greater than or equal to the -threshold. Specify a probability between 0 and 1 inclusive. No alternative words are computed if you omit the +

    A confidence value that is the lower bound for identifying a hypothesis as a possible word alternative (also +known as \Confusion Networks\). An alternative word is considered if its confidence is greater than or equal to +the threshold. Specify a probability between 0 and 1 inclusive. No alternative words are computed if you omit the parameter.

    @@ -1012,8 +1030,8 @@

    Parameters

    If true, converts dates, times, series of digits and numbers, phone numbers, currency values, and internet -addresses into more readable, conventional representations in the final transcript of a recognition request. For US -English, also converts certain keyword strings to punctuation symbols. By default, no smart formatting is +addresses into more readable, conventional representations in the final transcript of a recognition request. For +US English, also converts certain keyword strings to punctuation symbols. By default, no smart formatting is performed. Applies to US English and Spanish transcription only.

    @@ -1028,9 +1046,9 @@

    Parameters

    If true, the response includes labels that identify which words were spoken by which participants in a multi-person exchange. By default, no speaker labels are returned. Setting speaker_labels to true forces the -timestamps parameter to be true, regardless of whether you specify false for the parameter. To determine -whether a language model supports speaker labels, use the Get models method and check that the attribute -speaker_labels is set to true. You can also refer to Speaker +timestamps parameter to be true, regardless of whether you specify false for the parameter. +To determine whether a language model supports speaker labels, use the Get models method and check that the +attribute speaker_labels is set to true. You can also refer to Speaker labels.

    @@ -1099,18 +1117,20 @@

    Parameters

    To be registered successfully, the callback URL must respond to the GET request from the service. The response must send status code 200 and must include the challenge string in its body. Set the Content-Type response header to text/plain. Upon receiving this response, the service responds to the original registration request with -response code 201. The service sends only a single GET request to the callback URL. If the service does not -receive a reply with a response code of 200 and a body that echoes the challenge string sent by the service within -five seconds, it does not white-list the URL; it instead sends status code 400 in response to the Register a -callback request. If the requested callback URL is already white-listed, the service responds to the initial -registration request with response code 200. If you specify a user secret with the request, the service uses it -as a key to calculate an HMAC-SHA1 signature of the challenge string in its response to the POST request. It -sends this signature in the X-Callback-Signature header of its GET request to the URL during registration. It -also uses the secret to calculate a signature over the payload of every callback notification that uses the URL. -The signature provides authentication and data integrity for HTTP communications. After you successfully register -a callback URL, you can use it with an indefinite number of recognition requests. You can register a maximum of 20 -callback URLS in a one-hour span of time. For more information, see Registering a callback -URL.

    +response code 201. +The service sends only a single GET request to the callback URL. If the service does not receive a reply with a +response code of 200 and a body that echoes the challenge string sent by the service within five seconds, it does +not white-list the URL; it instead sends status code 400 in response to the Register a callback request. If the +requested callback URL is already white-listed, the service responds to the initial registration request with +response code 200. +If you specify a user secret with the request, the service uses it as a key to calculate an HMAC-SHA1 signature of +the challenge string in its response to the POST request. It sends this signature in the X-Callback-Signature +header of its GET request to the URL during registration. It also uses the secret to calculate a signature over +the payload of every callback notification that uses the URL. The signature provides authentication and data +integrity for HTTP communications. +After you successfully register a callback URL, you can use it with an indefinite number of recognition requests. +You can register a maximum of 20 callback URLS in a one-hour span of time. For more information, see Registering a +callback URL.

    @@ -1138,9 +1158,9 @@

    Parameters

    -

    An HTTP or HTTPS URL to which callback notifications are to be sent. To be white-listed, the URL must successfully -echo the challenge string during URL verification. During verification, the client can also check the signature -that the service sends in the X-Callback-Signature header to verify the origin of the request.

    +

    An HTTP or HTTPS URL to which callback notifications are to be sent. To be white-listed, the URL must +successfully echo the challenge string during URL verification. During verification, the client can also check +the signature that the service sends in the X-Callback-Signature header to verify the origin of the request.

    @@ -1153,9 +1173,9 @@

    Parameters

    A user-specified string that the service uses to generate the HMAC-SHA1 signature that it sends via the -X-Callback-Signature header. The service includes the header during URL verification and with every notification -sent to the callback URL. It calculates the signature over the payload of the notification. If you omit the -parameter, the service does not send the header.

    +X-Callback-Signature header. The service includes the header during URL verification and with every +notification sent to the callback URL. It calculates the signature over the payload of the notification. If you +omit the parameter, the service does not send the header.

    @@ -1307,32 +1327,52 @@

    Parameters

    Creates a job for a new asynchronous recognition request. The job is owned by the user whose service credentials are used to create it. How you learn the status and results of a job depends on the parameters you include with the -job creation request: * By callback notification: Include the callback_url parameter to specify a URL to which -the service is to send callback notifications when the status of the job changes. Optionally, you can also include -the events and user_token parameters to subscribe to specific events and to specify a string that is to be -included with each notification for the job. * By polling the service: Omit the callback_url, events, and -user_token parameters. You must then use the Check jobs or Check a job methods to check the status of the -job, using the latter to retrieve the results when the job is complete. The two approaches are not mutually -exclusive. You can poll the service for job status or obtain results from the service manually even if you include -a callback URL. In both cases, you can include the results_ttl parameter to specify how long the results are to -remain available after the job is complete. For detailed usage information about the two approaches, including -callback notifications, see Creating a +job creation request:

    + +
    @@ -1405,8 +1445,8 @@

    Parameters

    -

    The identifier of the model that is to be used for the recognition request or, for the Create a session method, -with the new session.

    +

    The identifier of the model that is to be used for the recognition request or, for the Create a session +method, with the new session.

    @@ -1419,9 +1459,10 @@

    Parameters

    A URL to which callback notifications are to be sent. The URL must already be successfully white-listed by using -the Register a callback method. Omit the parameter to poll the service for job completion and results. You can -include the same callback URL with any number of job creation requests. Use the user_token parameter to specify a -unique user-specified string with each job to differentiate the callback notifications for the jobs.

    +the Register a callback method. You can include the same callback URL with any number of job creation +requests. Omit the parameter to poll the service for job completion and results. +Use the user_token parameter to specify a unique user-specified string with each job to differentiate the +callback notifications for the jobs.

    @@ -1434,15 +1475,21 @@

    Parameters

    If the job includes a callback URL, a comma-separated list of notification events to which to subscribe. Valid -events are: recognitions.started generates a callback notification when the service begins to process the job. -recognitions.completed generates a callback notification when the job is complete; you must use the Check a -job method to retrieve the results before they time out or are deleted. recognitions.completed_with_results -generates a callback notification when the job is complete; the notification includes the results of the request. -recognitions.failed generates a callback notification if the service experiences an error while processing the -job. Omit the parameter to subscribe to the default events: recognitions.started, recognitions.completed, and +events are

    + +
      +
    • recognitions.started generates a callback notification when the service begins to process the job.
    • +
    • recognitions.completed generates a callback notification when the job is complete. You must use the Check a +job method to retrieve the results before they time out or are deleted.
    • +
    • recognitions.completed_with_results generates a callback notification when the job is complete. The +notification includes the results of the request.
    • +
    • recognitions.failed generates a callback notification if the service experiences an error while processing +the job. +Omit the parameter to subscribe to the default events: recognitions.started, recognitions.completed, and recognitions.failed. The recognitions.completed and recognitions.completed_with_results events are incompatible; you can specify only of the two events. If the job does not include a callback URL, omit the -parameter.

      +parameter.
    • +
    @@ -1468,9 +1515,9 @@

    Parameters

    -

    The number of minutes for which the results are to be available after the job has finished. If not delivered via a -callback, the results must be retrieved within this time. Omit the parameter to use a time to live of one week. The -parameter is valid with or without a callback URL.

    +

    The number of minutes for which the results are to be available after the job has finished. If not delivered via +a callback, the results must be retrieved within this time. Omit the parameter to use a time to live of one week. +The parameter is valid with or without a callback URL.

    @@ -1482,10 +1529,10 @@

    Parameters

    -

    The customization ID (GUID) of a custom language model that is to be used with the recognition request or, for the -Create a session method, with the new session. The base model of the specified custom language model must match -the model specified with the model parameter. You must make the request with service credentials created for the -instance of the service that owns the custom model. By default, no custom language model is used.

    +

    The customization ID (GUID) of a custom language model that is to be used with the recognition request or, for +the Create a session method, with the new session. The base model of the specified custom language model must +match the model specified with the model parameter. You must make the request with service credentials created +for the instance of the service that owns the custom model. By default, no custom language model is used.

    @@ -1497,10 +1544,10 @@

    Parameters

    -

    The customization ID (GUID) of a custom acoustic model that is to be used with the recognition request or, for the -Create a session method, with the new session. The base model of the specified custom acoustic model must match -the model specified with the model parameter. You must make the request with service credentials created for the -instance of the service that owns the custom model. By default, no custom acoustic model is used.

    +

    The customization ID (GUID) of a custom acoustic model that is to be used with the recognition request or, for +the Create a session method, with the new session. The base model of the specified custom acoustic model must +match the model specified with the model parameter. You must make the request with service credentials created +for the instance of the service that owns the custom model. By default, no custom acoustic model is used.

    @@ -1514,9 +1561,10 @@

    Parameters

    The version of the specified base model that is to be used with recognition request or, for the Create a session method, with the new session. Multiple versions of a base model can exist when a model is updated for -internal improvements. The parameter is intended primarily for use with custom models that have been upgraded for a -new base model. The default value depends on whether the parameter is used with or without a custom model. For more -information, see Base model version.

    +internal improvements. The parameter is intended primarily for use with custom models that have been upgraded for +a new base model. The default value depends on whether the parameter is used with or without a custom model. For +more information, see Base model +version.

    @@ -1529,14 +1577,14 @@

    Parameters

    If you specify the customization ID (GUID) of a custom language model with the recognition request or, for -sessions, with the Create a session method, the customization weight tells the service how much weight to give -to words from the custom language model compared to those from the base model for the current request. Specify a -value between 0.0 and 1.0. Unless a different customization weight was specified for the custom model when it was -trained, the default value is 0.3. A customization weight that you specify overrides a weight that was specified -when the custom model was trained. The default value yields the best performance in general. Assign a higher -value if your audio makes frequent use of OOV words from the custom model. Use caution when setting the weight: a -higher value can improve the accuracy of phrases from the custom model’s domain, but it can negatively affect -performance on non-domain phrases.

    +sessions, with the Create a session method, the customization weight tells the service how much weight to +give to words from the custom language model compared to those from the base model for the current request. +Specify a value between 0.0 and 1.0. Unless a different customization weight was specified for the custom model +when it was trained, the default value is 0.3. A customization weight that you specify overrides a weight that +was specified when the custom model was trained. +The default value yields the best performance in general. Assign a higher value if your audio makes frequent use +of OOV words from the custom model. Use caution when setting the weight: a higher value can improve the accuracy +of phrases from the custom model’s domain, but it can negatively affect performance on non-domain phrases.

    @@ -1549,8 +1597,8 @@

    Parameters

    The time in seconds after which, if only silence (no speech) is detected in submitted audio, the connection is -closed with a 400 error. Useful for stopping audio submission from a live microphone when a user simply walks away. -Use -1 for infinity.

    +closed with a 400 error. The parameter is useful for stopping audio submission from a live microphone when a user +simply walks away. Use -1 for infinity.

    @@ -1562,10 +1610,10 @@

    Parameters

    -

    An array of keyword strings to spot in the audio. Each keyword string can include one or more tokens. Keywords are -spotted only in the final hypothesis, not in interim results. If you specify any keywords, you must also specify a -keywords threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify an empty array if you do -not need to spot keywords.

    +

    An array of keyword strings to spot in the audio. Each keyword string can include one or more tokens. Keywords +are spotted only in the final results, not in interim hypotheses. If you specify any keywords, you must also +specify a keywords threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify an empty +array if you do not need to spot keywords.

    @@ -1604,9 +1652,9 @@

    Parameters

    -

    A confidence value that is the lower bound for identifying a hypothesis as a possible word alternative (also known -as \Confusion Networks\). An alternative word is considered if its confidence is greater than or equal to the -threshold. Specify a probability between 0 and 1 inclusive. No alternative words are computed if you omit the +

    A confidence value that is the lower bound for identifying a hypothesis as a possible word alternative (also +known as \Confusion Networks\). An alternative word is considered if its confidence is greater than or equal to +the threshold. Specify a probability between 0 and 1 inclusive. No alternative words are computed if you omit the parameter.

    @@ -1659,8 +1707,8 @@

    Parameters

    If true, converts dates, times, series of digits and numbers, phone numbers, currency values, and internet -addresses into more readable, conventional representations in the final transcript of a recognition request. For US -English, also converts certain keyword strings to punctuation symbols. By default, no smart formatting is +addresses into more readable, conventional representations in the final transcript of a recognition request. For +US English, also converts certain keyword strings to punctuation symbols. By default, no smart formatting is performed. Applies to US English and Spanish transcription only.

    @@ -1675,9 +1723,9 @@

    Parameters

    If true, the response includes labels that identify which words were spoken by which participants in a multi-person exchange. By default, no speaker labels are returned. Setting speaker_labels to true forces the -timestamps parameter to be true, regardless of whether you specify false for the parameter. To determine -whether a language model supports speaker labels, use the Get models method and check that the attribute -speaker_labels is set to true. You can also refer to Speaker +timestamps parameter to be true, regardless of whether you specify false for the parameter. +To determine whether a language model supports speaker labels, use the Get models method and check that the +attribute speaker_labels is set to true. You can also refer to Speaker labels.

    @@ -1821,11 +1869,11 @@

    Parameters

    Returns information about the specified job. The response always includes the status of the job and its creation and update times. If the status is completed, the response includes the results of the recognition request. You -must submit the request with the service credentials of the user who created the job. You can use the method to -retrieve the results of any job, regardless of whether it was submitted with a callback URL and the -recognitions.completed_with_results event, and you can retrieve the results multiple times for as long as they -remain available. Use the Check jobs method to request information about the most recent jobs associated with -the calling user.

    +must submit the request with the service credentials of the user who created the job. +You can use the method to retrieve the results of any job, regardless of whether it was submitted with a callback +URL and the recognitions.completed_with_results event, and you can retrieve the results multiple times for as +long as they remain available. Use the Check jobs method to request information about the most recent jobs +associated with the calling user.

    @@ -2005,7 +2053,7 @@

    Parameters

    Creates a new custom language model for a specified base model. The custom language model can be used only with the base model for which it is created. The model is owned by the instance of the service whose credentials are used to -create it. You must pass a value of application/json with the Content-Type header.

    +create it.

    @@ -2094,7 +2142,7 @@

    Parameters

    List custom language models.

    Lists information about all custom language models that are owned by an instance of the service. Use the language -parameter to see all custom language models for the specified language; omit the parameter to see all custom +parameter to see all custom language models for the specified language. Omit the parameter to see all custom language models for all languages. You must use credentials for the instance of the service that owns a model to list information about it.

    @@ -2123,9 +2171,9 @@

    Parameters

    -

    The identifier of the language for which custom language or custom acoustic models are to be returned (for example, -en-US). Omit the parameter to see all custom language or custom acoustic models owned by the requesting service -credentials.

    +

    The identifier of the language for which custom language or custom acoustic models are to be returned (for +example, en-US). Omit the parameter to see all custom language or custom acoustic models owned by the +requesting service credentials.

    @@ -2184,9 +2232,9 @@

    Parameters

    -

    List a custom language model.

    +

    Get a custom language model.

    -

    Lists information about a specified custom language model. You must use credentials for the instance of the service +

    Gets information about a specified custom language model. You must use credentials for the instance of the service that owns a model to list information about it.

    @@ -2371,17 +2419,23 @@

    Parameters

    or deleting corpora or words for a custom language model, use this method to begin the actual training of the model on the latest data. You can specify whether the custom language model is to be trained with all words from its words resource or only with words that were added or modified by the user. You must use credentials for the -instance of the service that owns a model to train it. The training method is asynchronous. It can take on the -order of minutes to complete depending on the amount of data on which the service is being trained and the current -load on the service. The method returns an HTTP 200 response code to indicate that the training process has begun. - You can monitor the status of the training by using the List a custom language model method to poll the -model’s status. Use a loop to check the status every 10 seconds. The method returns a Customization object that -includes status and progress fields. A status of available means that the custom model is trained and ready -to use. The service cannot accept subsequent training requests, or requests to add new corpora or words, until the -existing request completes. Training can fail to start for the following reasons: * The service is currently -handling another request for the custom model, such as another training request or a request to add a corpus or -words to the model. * No training data (corpora or words) have been added to the custom model. * One or more words -that were added to the custom model have invalid sounds-like pronunciations that you must fix.

    +instance of the service that owns a model to train it. +The training method is asynchronous. It can take on the order of minutes to complete depending on the amount of +data on which the service is being trained and the current load on the service. The method returns an HTTP 200 +response code to indicate that the training process has begun. +You can monitor the status of the training by using the Get a custom language model method to poll the model’s +status. Use a loop to check the status every 10 seconds. The method returns a LanguageModel object that includes +status and progress fields. A status of available means that the custom model is trained and ready to use. +The service cannot accept subsequent training requests, or requests to add new corpora or words, until the existing +request completes. +Training can fail to start for the following reasons:

    + +
      +
    • The service is currently handling another request for the custom model, such as another training request or a +request to add a corpus or words to the model.
    • +
    • No training data (corpora or words) have been added to the custom model.
    • +
    • One or more words that were added to the custom model have invalid sounds-like pronunciations that you must fix.

    • +
    @@ -2423,10 +2477,14 @@

    Parameters

    -

    The type of words from the custom language model’s words resource on which to train the model: * all (the -default) trains the model on all new words, regardless of whether they were extracted from corpora or were added or -modified by the user. * user trains the model only on new words that were added or modified by the user; the -model is not trained on new words extracted from corpora.

    +

    The type of words from the custom language model’s words resource on which to train the model:

    + +
      +
    • all (the default) trains the model on all new words, regardless of whether they were extracted from corpora +or were added or modified by the user.
    • +
    • user trains the model only on new words that were added or modified by the user; the model is not trained on +new words extracted from corpora.
    • +
    @@ -2438,14 +2496,14 @@

    Parameters

    -

    Specifies a customization weight for the custom language model. The customization weight tells the service how much -weight to give to words from the custom language model compared to those from the base model for speech -recognition. Specify a value between 0.0 and 1.0; the default is 0.3. The default value yields the best -performance in general. Assign a higher value if your audio makes frequent use of OOV words from the custom model. -Use caution when setting the weight: a higher value can improve the accuracy of phrases from the custom model’s -domain, but it can negatively affect performance on non-domain phrases. The value that you assign is used for all -recognition requests that use the model. You can override it for any recognition request by specifying a -customization weight for that request.

    +

    Specifies a customization weight for the custom language model. The customization weight tells the service how +much weight to give to words from the custom language model compared to those from the base model for speech +recognition. Specify a value between 0.0 and 1.0; the default is 0.3. +The default value yields the best performance in general. Assign a higher value if your audio makes frequent use +of OOV words from the custom model. Use caution when setting the weight: a higher value can improve the accuracy +of phrases from the custom model’s domain, but it can negatively affect performance on non-domain phrases. +The value that you assign is used for all recognition requests that use the model. You can override it for any +recognition request by specifying a customization weight for that request.

    @@ -2601,12 +2659,14 @@

    Parameters

    Initiates the upgrade of a custom language model to the latest version of its base language model. The upgrade method is asynchronous. It can take on the order of minutes to complete depending on the amount of data in the custom model and the current load on the service. A custom model must be in the ready or available state to be -upgraded. You must use credentials for the instance of the service that owns a model to upgrade it. The method -returns an HTTP 200 response code to indicate that the upgrade process has begun successfully. You can monitor the -status of the upgrade by using the List a custom language model method to poll the model’s status. Use a loop -to check the status every 10 seconds. While it is being upgraded, the custom model has the status upgrading. When -the upgrade is complete, the model resumes the status that it had prior to upgrade. The service cannot accept -subsequent requests for the model until the upgrade completes. For more information, see Upgrading custom +upgraded. You must use credentials for the instance of the service that owns a model to upgrade it. +The method returns an HTTP 200 response code to indicate that the upgrade process has begun successfully. You can +monitor the status of the upgrade by using the Get a custom language model method to poll the model’s status. +The method returns a LanguageModel object that includes status and progress fields. Use a loop to check the +status every 10 seconds. While it is being upgraded, the custom model has the status upgrading. When the upgrade +is complete, the model resumes the status that it had prior to upgrade. The service cannot accept subsequent +requests for the model until the upgrade completes. +For more information, see Upgrading custom models.

    @@ -2790,28 +2850,29 @@

    Parameters

    Adds a single corpus text file of new training data to a custom language model. Use multiple requests to submit multiple corpus text files. You must use credentials for the instance of the service that owns a model to add a corpus to it. Adding a corpus does not affect the custom language model until you train the model for the new data -by using the Train a custom language model method. Submit a plain text file that contains sample sentences -from the domain of interest to enable the service to extract words in context. The more sentences you add that -represent the context in which speakers use words from the domain, the better the service’s recognition accuracy. -For guidelines about adding a corpus text file and for information about how the service parses a corpus file, see -Preparing a corpus text -file. The call -returns an HTTP 201 response code if the corpus is valid. The service then asynchronously processes the contents of -the corpus and automatically extracts new words that it finds. This can take on the order of a minute or two to -complete depending on the total number of words and the number of new words in the corpus, as well as the current -load on the service. You cannot submit requests to add additional corpora or words to the custom model, or to train -the model, until the service’s analysis of the corpus for the current request completes. Use the List a corpus -method to check the status of the analysis. The service auto-populates the model’s words resource with any word -that is not found in its base vocabulary; these are referred to as out-of-vocabulary (OOV) words. You can use the -List custom words method to examine the words resource, using other words method to eliminate typos and modify -how words are pronounced as needed. To add a corpus file that has the same name as an existing corpus, set the -allow_overwrite parameter to true; otherwise, the request fails. Overwriting an existing corpus causes the -service to process the corpus text file and extract OOV words anew. Before doing so, it removes any OOV words -associated with the existing corpus from the model’s words resource unless they were also added by another corpus -or they have been modified in some way with the Add custom words or Add a custom word method. The service -limits the overall amount of data that you can add to a custom model to a maximum of 10 million total words from -all corpora combined. Also, you can add no more than 30 thousand custom (OOV) words to a model; this includes words -that the service extracts from corpora and words that you add directly.

    +by using the Train a custom language model method. +Submit a plain text file that contains sample sentences from the domain of interest to enable the service to +extract words in context. The more sentences you add that represent the context in which speakers use words from +the domain, the better the service’s recognition accuracy. For guidelines about adding a corpus text file and for +information about how the service parses a corpus file, see Preparing a corpus text +file. +The call returns an HTTP 201 response code if the corpus is valid. The service then asynchronously processes the +contents of the corpus and automatically extracts new words that it finds. This can take on the order of a minute +or two to complete depending on the total number of words and the number of new words in the corpus, as well as the +current load on the service. You cannot submit requests to add additional corpora or words to the custom model, or +to train the model, until the service’s analysis of the corpus for the current request completes. Use the List a +corpus method to check the status of the analysis. +The service auto-populates the model’s words resource with any word that is not found in its base vocabulary; these +are referred to as out-of-vocabulary (OOV) words. You can use the List custom words method to examine the words +resource, using other words method to eliminate typos and modify how words are pronounced as needed. +To add a corpus file that has the same name as an existing corpus, set the allow_overwrite parameter to true; +otherwise, the request fails. Overwriting an existing corpus causes the service to process the corpus text file and +extract OOV words anew. Before doing so, it removes any OOV words associated with the existing corpus from the +model’s words resource unless they were also added by another corpus or they have been modified in some way with +the Add custom words or Add a custom word method. +The service limits the overall amount of data that you can add to a custom model to a maximum of 10 million total +words from all corpora combined. Also, you can add no more than 30 thousand custom (OOV) words to a model; this +includes words that the service extracts from corpora and words that you add directly.

    @@ -2855,9 +2916,9 @@

    Parameters

    -

    The name of the corpus for the custom language model. When adding a corpus, do not include spaces in the name; use -a localized name that matches the language of the custom model; and do not use the name user, which is reserved -by the service to denote custom words added or modified by the user.

    +

    The name of the corpus for the custom language model. When adding a corpus, do not include spaces in the name; +use a localized name that matches the language of the custom model; and do not use the name user, which is +reserved by the service to denote custom words added or modified by the user.

    @@ -2869,9 +2930,9 @@

    Parameters

    -

    A plain text file that contains the training data for the corpus. Encode the file in UTF-8 if it contains non-ASCII -characters; the service assumes UTF-8 encoding if it encounters non-ASCII characters. With cURL, use the ---data-binary option to upload the file for the request.

    +

    A plain text file that contains the training data for the corpus. Encode the file in UTF-8 if it contains +non-ASCII characters; the service assumes UTF-8 encoding if it encounters non-ASCII characters. With cURL, use +the --data-binary option to upload the file for the request.

    @@ -2884,8 +2945,8 @@

    Parameters

    If true, the specified corpus or audio resource overwrites an existing corpus or audio resource with the same -name. If false (the default), the request fails if a corpus or audio resource with the same name already exists. -The parameter has no effect if a corpus or audio resource with the same name does not already exist.

    +name. If false (the default), the request fails if a corpus or audio resource with the same name already +exists. The parameter has no effect if a corpus or audio resource with the same name does not already exist.

    @@ -2956,9 +3017,9 @@

    Parameters

    -

    List a corpus.

    +

    Get a corpus.

    -

    Lists information about a corpus from a custom language model. The information includes the total number of words +

    Gets information about a corpus from a custom language model. The information includes the total number of words and out-of-vocabulary (OOV) words, name, and status of the corpus. You must use credentials for the instance of the service that owns a model to list its corpora.

    @@ -3001,9 +3062,9 @@

    Parameters

    -

    The name of the corpus for the custom language model. When adding a corpus, do not include spaces in the name; use -a localized name that matches the language of the custom model; and do not use the name user, which is reserved -by the service to denote custom words added or modified by the user.

    +

    The name of the corpus for the custom language model. When adding a corpus, do not include spaces in the name; +use a localized name that matches the language of the custom model; and do not use the name user, which is +reserved by the service to denote custom words added or modified by the user.

    @@ -3109,9 +3170,9 @@

    Parameters

    -

    The name of the corpus for the custom language model. When adding a corpus, do not include spaces in the name; use -a localized name that matches the language of the custom model; and do not use the name user, which is reserved -by the service to denote custom words added or modified by the user.

    +

    The name of the corpus for the custom language model. When adding a corpus, do not include spaces in the name; +use a localized name that matches the language of the custom model; and do not use the name user, which is +reserved by the service to denote custom words added or modified by the user.

    @@ -3218,9 +3279,13 @@

    Parameters

    -

    The type of words to be listed from the custom language model’s words resource: * all (the default) shows all -words. * user shows only custom words that were added or modified by the user. * corpora shows only OOV that -were extracted from corpora.

    +

    The type of words to be listed from the custom language model’s words resource: + +

      +
    • all (the default) shows all words.
    • +
    • user shows only custom words that were added or modified by the user.
    • +
    • corpora shows only OOV that were extracted from corpora.
    • +

    @@ -3232,11 +3297,11 @@

    Parameters

    -

    Indicates the order in which the words are to be listed, alphabetical or by count. You can prepend an optional -+ or - to an argument to indicate whether the results are to be sorted in ascending or descending order. By -default, words are sorted in ascending alphabetical order. For alphabetical ordering, the lexicographical -precedence is numeric values, uppercase letters, and lowercase letters. For count ordering, values with the same -count are ordered alphabetically. With cURL, URL encode the + symbol as %2B.

    +

    Indicates the order in which the words are to be listed, alphabetical or by count. You can prepend an +optional + or - to an argument to indicate whether the results are to be sorted in ascending or descending +order. By default, words are sorted in ascending alphabetical order. For alphabetical ordering, the +lexicographical precedence is numeric values, uppercase letters, and lowercase letters. For count ordering, +values with the same count are ordered alphabetically. With cURL, URL encode the + symbol as %2B.

    @@ -3301,36 +3366,40 @@

    Parameters

    model with out-of-vocabulary (OOV) words found in each corpus added to the model. You can use this method to add additional words or to modify existing words in the words resource. The words resource for a model can contain a maximum of 30 thousand custom (OOV) words, including words that the service extracts from corpora and words that -you add directly. You must use credentials for the instance of the service that owns a model to add or modify -custom words for the model. You must pass a value of application/json with the Content-Type header. Adding or -modifying custom words does not affect the custom model until you train the model for the new data by using the -Train a custom language model method. You add custom words by providing a Words object, which is an array -of Word objects, one per word. You must use the object’s word parameter to identify the word that is to be added. -You can also provide one or both of the optional sounds_like and display_as fields for each word. * The -sounds_like field provides an array of one or more pronunciations for the word. Use the parameter to specify how -the word can be pronounced by users. Use the parameter for words that are difficult to pronounce, foreign words, -acronyms, and so on. For example, you might specify that the word IEEE can sound like i triple e. You can -specify a maximum of five sounds-like pronunciations for a word. For information about pronunciation rules, see -Using the sounds_like -field. * The -display_as field provides a different way of spelling the word in a transcript. Use the parameter when you want -the word to appear different from its usual representation or from its spelling in corpora training data. For -example, you might indicate that the word IBM(trademark) is to be displayed as IBM. For more information, see -Using the display_as -field. If you add a -custom word that already exists in the words resource for the custom model, the new definition overwrites the -existing data for the word. If the service encounters an error with the input data, it returns a failure code and -does not add any of the words to the words resource. The call returns an HTTP 201 response code if the input data -is valid. It then asynchronously processes the words to add them to the model’s words resource. The time that it -takes for the analysis to complete depends on the number of new words that you add but is generally faster than -adding a corpus or training a model. You can monitor the status of the request by using the List a custom -language model method to poll the model’s status. Use a loop to check the status every 10 seconds. The method -returns a Customization object that includes a status field. A status of ready means that the words have been -added to the custom model. The service cannot accept requests to add new corpora or words or to train the model -until the existing request completes. You can use the List custom words or List a custom word method to -review the words that you add. Words with an invalid sounds_like field include an error field that describes -the problem. You can use other words-related methods to correct errors, eliminate typos, and modify how words are -pronounced as needed.

    +you add directly. +You must use credentials for the instance of the service that owns a model to add or modify custom words for the +model. Adding or modifying custom words does not affect the custom model until you train the model for the new data +by using the Train a custom language model method. +You add custom words by providing a CustomWords object, which is an array of CustomWord objects, one per word. +You must use the object’s word parameter to identify the word that is to be added. You can also provide one or +both of the optional sounds_like and display_as fields for each word.

    + +
      +
    • The sounds_like field provides an array of one or more pronunciations for the word. Use the parameter to +specify how the word can be pronounced by users. Use the parameter for words that are difficult to pronounce, +foreign words, acronyms, and so on. For example, you might specify that the word IEEE can sound like i triple +e. You can specify a maximum of five sounds-like pronunciations for a word. For information about pronunciation +rules, see Using the sounds_like +field.
    • +
    • The display_as field provides a different way of spelling the word in a transcript. Use the parameter when you +want the word to appear different from its usual representation or from its spelling in corpora training data. For +example, you might indicate that the word IBM(trademark) is to be displayed as IBM&trade;. For more +information, see Using the display_as +field. +If you add a custom word that already exists in the words resource for the custom model, the new definition +overwrites the existing data for the word. If the service encounters an error with the input data, it returns a +failure code and does not add any of the words to the words resource. +The call returns an HTTP 201 response code if the input data is valid. It then asynchronously processes the words +to add them to the model’s words resource. The time that it takes for the analysis to complete depends on the +number of new words that you add but is generally faster than adding a corpus or training a model. +You can monitor the status of the request by using the List a custom language model method to poll the model’s +status. Use a loop to check the status every 10 seconds. The method returns a Customization object that includes +a status field. A status of ready means that the words have been added to the custom model. The service cannot +accept requests to add new corpora or words or to train the model until the existing request completes. +You can use the List custom words or List a custom word method to review the words that you add. Words with +an invalid sounds_like field include an error field that describes the problem. You can use other words-related +methods to correct errors, eliminate typos, and modify how words are pronounced as needed.

    • +
    @@ -3436,26 +3505,29 @@

    Parameters

    Adds a custom word to a custom language model. The service populates the words resource for a custom model with out-of-vocabulary (OOV) words found in each corpus added to the model. You can use this method to add a word or to modify an existing word in the words resource. The words resource for a model can contain a maximum of 30 thousand -custom (OOV) words, including words that the service extracts from corpora and words that you add directly. You -must use credentials for the instance of the service that owns a model to add or modify a custom word for the -model. You must pass a value of application/json with the Content-Type header. Adding or modifying a custom -word does not affect the custom model until you train the model for the new data by using the Train a custom -language model method. Use the word_name parameter to specify the custom word that is to be added or -modified. Use the CustomWord object to provide one or both of the optional sounds_like and display_as fields -for the word. * The sounds_like field provides an array of one or more pronunciations for the word. Use the -parameter to specify how the word can be pronounced by users. Use the parameter for words that are difficult to -pronounce, foreign words, acronyms, and so on. For example, you might specify that the word IEEE can sound like -i triple e. You can specify a maximum of five sounds-like pronunciations for a word. For information about -pronunciation rules, see Using the sounds_like -field. * The -display_as field provides a different way of spelling the word in a transcript. Use the parameter when you want -the word to appear different from its usual representation or from its spelling in corpora training data. For -example, you might indicate that the word IBM(trademark) is to be displayed as IBM. For more information, see -Using the display_as -field. If you add a -custom word that already exists in the words resource for the custom model, the new definition overwrites the -existing data for the word. If the service encounters an error, it does not add the word to the words resource. Use -the List a custom word method to review the word that you add.

    +custom (OOV) words, including words that the service extracts from corpora and words that you add directly. +You must use credentials for the instance of the service that owns a model to add or modify a custom word for the +model. Adding or modifying a custom word does not affect the custom model until you train the model for the new +data by using the Train a custom language model method. +Use the word_name parameter to specify the custom word that is to be added or modified. Use the CustomWord +object to provide one or both of the optional sounds_like and display_as fields for the word.

    + +
      +
    • The sounds_like field provides an array of one or more pronunciations for the word. Use the parameter to +specify how the word can be pronounced by users. Use the parameter for words that are difficult to pronounce, +foreign words, acronyms, and so on. For example, you might specify that the word IEEE can sound like i triple +e. You can specify a maximum of five sounds-like pronunciations for a word. For information about pronunciation +rules, see Using the sounds_like +field.
    • +
    • The display_as field provides a different way of spelling the word in a transcript. Use the parameter when you +want the word to appear different from its usual representation or from its spelling in corpora training data. For +example, you might indicate that the word IBM(trademark) is to be displayed as IBM&trade;. For more +information, see Using the display_as +field. +If you add a custom word that already exists in the words resource for the custom model, the new definition +overwrites the existing data for the word. If the service encounters an error, it does not add the word to the +words resource. Use the List a custom word method to review the word that you add.

    • +
    @@ -3499,9 +3571,9 @@

    Parameters

    -

    The custom word for the custom language model. When you add or update a custom word with the Add a custom word -method, do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of compound -words.

    +

    The custom word for the custom language model. When you add or update a custom word with the Add a custom +word method, do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of +compound words.

    @@ -3515,7 +3587,8 @@

    Parameters

    For the Add custom words method, you must specify the custom word that is to be added to or updated in the custom model. Do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of -compound words. Omit this field for the Add a custom word method.

    +compound words. +Omit this field for the Add a custom word method.

    @@ -3529,11 +3602,11 @@

    Parameters

    An array of sounds-like pronunciations for the custom word. Specify how words that are difficult to pronounce, foreign words, acronyms, and so on can be pronounced by users. For a word that is not in the service’s base -vocabulary, omit the parameter to have the service automatically generate a sounds-like pronunciation for the word. -For a word that is in the service’s base vocabulary, use the parameter to specify additional pronunciations for the -word. You cannot override the default pronunciation of a word; pronunciations you add augment the pronunciation -from the base vocabulary. A word can have at most five sounds-like pronunciations, and a pronunciation can include -at most 40 characters not including spaces.

    +vocabulary, omit the parameter to have the service automatically generate a sounds-like pronunciation for the +word. For a word that is in the service’s base vocabulary, use the parameter to specify additional pronunciations +for the word. You cannot override the default pronunciation of a word; pronunciations you add augment the +pronunciation from the base vocabulary. A word can have at most five sounds-like pronunciations, and a +pronunciation can include at most 40 characters not including spaces.

    @@ -3606,10 +3679,10 @@

    Parameters

    -

    List a custom word.

    +

    Get a custom word.

    -

    Lists information about a custom word from a custom language model. You must use credentials for the instance of -the service that owns a model to query information about its words.

    +

    Gets information about a custom word from a custom language model. You must use credentials for the instance of the +service that owns a model to query information about its words.

    @@ -3650,9 +3723,9 @@

    Parameters

    -

    The custom word for the custom language model. When you add or update a custom word with the Add a custom word -method, do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of compound -words.

    +

    The custom word for the custom language model. When you add or update a custom word with the Add a custom +word method, do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of +compound words.

    @@ -3758,9 +3831,9 @@

    Parameters

    -

    The custom word for the custom language model. When you add or update a custom word with the Add a custom word -method, do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of compound -words.

    +

    The custom word for the custom language model. When you add or update a custom word with the Add a custom +word method, do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of +compound words.

    @@ -3823,7 +3896,7 @@

    Parameters

    Creates a new custom acoustic model for a specified base model. The custom acoustic model can be used only with the base model for which it is created. The model is owned by the instance of the service whose credentials are used to -create it. You must pass a value of application/json with the Content-Type header.

    +create it.

    @@ -3866,9 +3939,9 @@

    Parameters

    -

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model -can be used only with the base model that it customizes. To determine whether a base model supports acoustic model -customization, refer to Language support for +

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom +model can be used only with the base model that it customizes. To determine whether a base model supports +acoustic model customization, refer to Language support for customization.

    @@ -3881,8 +3954,8 @@

    Parameters

    -

    A description of the new custom acoustic model. Use a localized description that matches the language of the custom -model.

    +

    A description of the new custom acoustic model. Use a localized description that matches the language of the +custom model.

    @@ -3944,7 +4017,7 @@

    Parameters

    List custom acoustic models.

    Lists information about all custom acoustic models that are owned by an instance of the service. Use the language -parameter to see all custom acoustic models for the specified language; omit the parameter to see all custom +parameter to see all custom acoustic models for the specified language. Omit the parameter to see all custom acoustic models for all languages. You must use credentials for the instance of the service that owns a model to list information about it.

    @@ -3973,9 +4046,9 @@

    Parameters

    -

    The identifier of the language for which custom language or custom acoustic models are to be returned (for example, -en-US). Omit the parameter to see all custom language or custom acoustic models owned by the requesting service -credentials.

    +

    The identifier of the language for which custom language or custom acoustic models are to be returned (for +example, en-US). Omit the parameter to see all custom language or custom acoustic models owned by the +requesting service credentials.

    @@ -4034,9 +4107,9 @@

    Parameters

    -

    List a custom acoustic model.

    +

    Get a custom acoustic model.

    -

    Lists information about a specified custom acoustic model. You must use credentials for the instance of the service +

    Gets information about a specified custom acoustic model. You must use credentials for the instance of the service that owns a model to list information about it.

    @@ -4220,25 +4293,31 @@

    Parameters

    Initiates the training of a custom acoustic model with new or changed audio resources. After adding or deleting audio resources for a custom acoustic model, use this method to begin the actual training of the model on the latest audio data. The custom acoustic model does not reflect its changed data until you train it. You must use -credentials for the instance of the service that owns a model to train it. The training method is asynchronous. -It can take on the order of minutes or hours to complete depending on the total amount of audio data on which the -custom acoustic model is being trained and the current load on the service. Typically, training a custom acoustic -model takes approximately two to four times the length of its audio data. The range of time depends on the model -being trained and the nature of the audio, such as whether the audio is clean or noisy. The method returns an HTTP -200 response code to indicate that the training process has begun. You can monitor the status of the training by -using the List a custom acoustic model method to poll the model’s status. Use a loop to check the status once a -minute. The method returns an Customization object that includes status and progress fields. A status of -available indicates that the custom model is trained and ready to use. The service cannot accept subsequent -training requests, or requests to add new audio resources, until the existing request completes. You can use the -optional custom_language_model_id parameter to specify the GUID of a separately created custom language model -that is to be used during training. Specify a custom language model if you have verbatim transcriptions of the -audio files that you have added to the custom model or you have either corpora (text files) or a list of words that -are relevant to the contents of the audio files. For information about creating a separate custom language model, -see Creating a custom language -model. Training can fail to start -for the following reasons: * The service is currently handling another request for the custom model, such as -another training request or a request to add audio resources to the model. * The custom model contains less than 10 -minutes or more than 50 hours of audio data. * One or more of the custom model’s audio resources is invalid.

    +credentials for the instance of the service that owns a model to train it. +The training method is asynchronous. It can take on the order of minutes or hours to complete depending on the +total amount of audio data on which the custom acoustic model is being trained and the current load on the service. +Typically, training a custom acoustic model takes approximately two to four times the length of its audio data. The +range of time depends on the model being trained and the nature of the audio, such as whether the audio is clean or +noisy. The method returns an HTTP 200 response code to indicate that the training process has begun. +You can monitor the status of the training by using the Get a custom acoustic model method to poll the model’s +status. Use a loop to check the status once a minute. The method returns an AcousticModel object that includes +status and progress fields. A status of available indicates that the custom model is trained and ready to +use. The service cannot accept subsequent training requests, or requests to add new audio resources, until the +existing request completes. +You can use the optional custom_language_model_id parameter to specify the GUID of a separately created custom +language model that is to be used during training. Specify a custom language model if you have verbatim +transcriptions of the audio files that you have added to the custom model or you have either corpora (text files) +or a list of words that are relevant to the contents of the audio files. For information about creating a separate +custom language model, see Creating a custom language +model. +Training can fail to start for the following reasons:

    + +
      +
    • The service is currently handling another request for the custom model, such as another training request or a +request to add audio resources to the model.
    • +
    • The custom model contains less than 10 minutes or more than 50 hours of audio data.
    • +
    • One or more of the custom model’s audio resources is invalid.

    • +
    @@ -4280,8 +4359,8 @@

    Parameters

    The customization ID (GUID) of a custom language model that is to be used during training of the custom acoustic -model. Specify a custom language model that has been trained with verbatim transcriptions of the audio resources or -that contains words that are relevant to the contents of the audio resources.

    +model. Specify a custom language model that has been trained with verbatim transcriptions of the audio resources +or that contains words that are relevant to the contents of the audio resources.

    @@ -4438,16 +4517,18 @@

    Parameters

    method is asynchronous. It can take on the order of minutes or hours to complete depending on the amount of data in the custom model and the current load on the service; typically, upgrade takes approximately twice the length of the total audio contained in the custom model. A custom model must be in the ready or available state to be -upgraded. You must use credentials for the instance of the service that owns a model to upgrade it. The method -returns an HTTP 200 response code to indicate that the upgrade process has begun successfully. You can monitor the -status of the upgrade by using the List a custom acoustic model method to poll the model’s status. Use a loop -to check the status once a minute. While it is being upgraded, the custom model has the status upgrading. When -the upgrade is complete, the model resumes the status that it had prior to upgrade. The service cannot accept -subsequent requests for the model until the upgrade completes. If the custom acoustic model was trained with a -separately created custom language model, you must use the custom_language_model_id parameter to specify the GUID -of that custom language model. The custom language model must be upgraded before the custom acoustic model can be -upgraded. Omit the parameter if the custom acoustic model was not trained with a custom language model. For more -information, see Upgrading custom +upgraded. You must use credentials for the instance of the service that owns a model to upgrade it. +The method returns an HTTP 200 response code to indicate that the upgrade process has begun successfully. You can +monitor the status of the upgrade by using the Get a custom acoustic model method to poll the model’s status. +The method returns an AcousticModel object that includes status and progress fields. Use a loop to check the +status once a minute. While it is being upgraded, the custom model has the status upgrading. When the upgrade is +complete, the model resumes the status that it had prior to upgrade. The service cannot accept subsequent requests +for the model until the upgrade completes. +If the custom acoustic model was trained with a separately created custom language model, you must use the +custom_language_model_id parameter to specify the GUID of that custom language model. The custom language model +must be upgraded before the custom acoustic model can be upgraded. Omit the parameter if the custom acoustic model +was not trained with a custom language model. +For more information, see Upgrading custom models.

    @@ -4647,46 +4728,64 @@

    Parameters

    Adds an audio resource to a custom acoustic model. Add audio content that reflects the acoustic characteristics of the audio that you plan to transcribe. You must use credentials for the instance of the service that owns a model to add an audio resource to it. Adding audio data does not affect the custom acoustic model until you train the -model for the new data by using the Train a custom acoustic model method. You can add individual audio files -or an archive file that contains multiple audio files. Adding multiple audio files via a single archive file is -significantly more efficient than adding each file individually. You can add audio resources in any format that the -service supports for speech recognition. You can use this method to add any number of audio resources to a custom -model by calling the method once for each audio or archive file. But the addition of one audio resource must be -fully complete before you can add another. You must add a minimum of 10 minutes and a maximum of 50 hours of audio -that includes speech, not just silence, to a custom acoustic model before you can train it. No audio resource, -audio- or archive-type, can be larger than 100 MB. To add an audio resource that has the same name as an existing -audio resource, set the allow_overwrite parameter to true; otherwise, the request fails. The method is -asynchronous. It can take several seconds to complete depending on the duration of the audio and, in the case of an -archive file, the total number of audio files being processed. The service returns a 201 response code if the audio -is valid. It then asynchronously analyzes the contents of the audio file or files and automatically extracts -information about the audio such as its length, sampling rate, and encoding. You cannot submit requests to add -additional audio resources to a custom acoustic model, or to train the model, until the service’s analysis of all -audio files for the current request completes. To determine the status of the service’s analysis of the audio, -use the List an audio resource method to poll the status of the audio. The method accepts the GUID of the -custom model and the name of the audio resource, and it returns the status of the resource. Use a loop to check the -status of the audio every few seconds until it becomes ok. ### Content types for audio-type resources You can -add an individual audio file in any format that the service supports for speech recognition. For an audio-type -resource, use the Content-Type parameter to specify the audio format (MIME type) of the audio file: * -audio/basic (Use only with narrowband models.) * audio/flac * audio/l16 (Specify the sampling rate (rate) -and optionally the number of channels (channels) and endianness (endianness) of the audio.) * audio/mp3 * -audio/mpeg * audio/mulaw (Specify the sampling rate (rate) of the audio.) * audio/ogg (The service -automatically detects the codec of the input audio.) * audio/ogg;codecs=opus * audio/ogg;codecs=vorbis * -audio/wav (Provide audio with a maximum of nine channels.) * audio/webm (The service automatically detects the -codec of the input audio.) * audio/webm;codecs=opus * audio/webm;codecs=vorbis For information about the -supported audio formats, including specifying the sampling rate, channels, and endianness for the indicated -formats, see Audio formats. +model for the new data by using the Train a custom acoustic model method. +You can add individual audio files or an archive file that contains multiple audio files. Adding multiple audio +files via a single archive file is significantly more efficient than adding each file individually. You can add +audio resources in any format that the service supports for speech recognition. +You can use this method to add any number of audio resources to a custom model by calling the method once for each +audio or archive file. But the addition of one audio resource must be fully complete before you can add another. +You must add a minimum of 10 minutes and a maximum of 50 hours of audio that includes speech, not just silence, to +a custom acoustic model before you can train it. No audio resource, audio- or archive-type, can be larger than 100 +MB. To add an audio resource that has the same name as an existing audio resource, set the allow_overwrite +parameter to true; otherwise, the request fails. +The method is asynchronous. It can take several seconds to complete depending on the duration of the audio and, in +the case of an archive file, the total number of audio files being processed. The service returns a 201 response +code if the audio is valid. It then asynchronously analyzes the contents of the audio file or files and +automatically extracts information about the audio such as its length, sampling rate, and encoding. You cannot +submit requests to add additional audio resources to a custom acoustic model, or to train the model, until the +service’s analysis of all audio files for the current request completes. +To determine the status of the service’s analysis of the audio, use the Get an audio resource method to poll +the status of the audio. The method accepts the customization ID of the custom model and the name of the audio +resource, and it returns the status of the resource. Use a loop to check the status of the audio every few seconds +until it becomes ok.

    +

    Content types for audio-type resources

    + +

    You can add an individual audio file in any format that the service supports for speech recognition. For an +audio-type resource, use the Content-Type parameter to specify the audio format (MIME type) of the audio file:

    + +
      +
    • audio/basic (Use only with narrowband models.)
    • +
    • audio/flac
    • +
    • audio/l16 (Specify the sampling rate (rate) and optionally the number of channels (channels) and endianness +(endianness) of the audio.)
    • +
    • audio/mp3
    • +
    • audio/mpeg
    • +
    • audio/mulaw (Specify the sampling rate (rate) of the audio.)
    • +
    • audio/ogg (The service automatically detects the codec of the input audio.)
    • +
    • audio/ogg;codecs=opus
    • +
    • audio/ogg;codecs=vorbis
    • +
    • audio/wav (Provide audio with a maximum of nine channels.)
    • +
    • audio/webm (The service automatically detects the codec of the input audio.)
    • +
    • audio/webm;codecs=opus
    • +
    • audio/webm;codecs=vorbis +For information about the supported audio formats, including specifying the sampling rate, channels, and endianness +for the indicated formats, see Audio +formats. Note: The sampling rate of an audio file must match the sampling rate of the base model for the custom model: for broadband models, at least 16 kHz; for narrowband models, at least 8 kHz. If the sampling rate of the audio is higher than the minimum required rate, the service down-samples the audio to the appropriate rate. If the sampling -rate of the audio is lower than the minimum required rate, the service labels the audio file as invalid. ### -Content types for archive-type resources You can add an archive file (.zip or .tar.gz file) that contains -audio files in any format that the service supports for speech recognition. For an archive-type resource, use the -Content-Type parameter to specify the media type of the archive file: * application/zip for a .zip file * -application/gzip for a .tar.gz file. All audio files contained in the archive must have the same audio -format. Use the Contained-Content-Type parameter to specify the format of the contained audio files. The -parameter accepts all of the audio formats supported for use with speech recognition and with the Content-Type -header, including the rate, channels, and endianness parameters that are used with some formats. The default -contained audio format is audio/wav.

      +rate of the audio is lower than the minimum required rate, the service labels the audio file as invalid. +### Content types for archive-type resources +You can add an archive file (.zip or .tar.gz file) that contains audio files in any format that the +service supports for speech recognition. For an archive-type resource, use the Content-Type parameter to specify +the media type of the archive file:
    • +
    • application/zip for a .zip file
    • +
    • application/gzip for a .tar.gz file. +All audio files contained in the archive must have the same audio format. Use the Contained-Content-Type +parameter to specify the format of the contained audio files. The parameter accepts all of the audio formats +supported for use with speech recognition and with the Content-Type header, including the rate, channels, and +endianness parameters that are used with some formats. The default contained audio format is audio/wav.

    • +
    @@ -4731,8 +4830,8 @@

    Parameters

    -

    The name of the audio resource for the custom acoustic model. When adding an audio resource, do not include spaces -in the name; use a localized name that matches the language of the custom model.

    +

    The name of the audio resource for the custom acoustic model. When adding an audio resource, do not include +spaces in the name; use a localized name that matches the language of the custom model.

    @@ -4770,10 +4869,10 @@

    Parameters

    -

    For an archive-type resource, specifies the format of the audio files contained in the archive file. The parameter -accepts all of the audio formats supported for use with speech recognition, including the rate, channels, and -endianness parameters that are used with some formats. For a complete list of supported audio formats, see Audio -formats.

    +

    For an archive-type resource, specifies the format of the audio files contained in the archive file. The +parameter accepts all of the audio formats supported for use with speech recognition, including the rate, +channels, and endianness parameters that are used with some formats. For a complete list of supported audio +formats, see Audio formats.

    @@ -4786,8 +4885,8 @@

    Parameters

    If true, the specified corpus or audio resource overwrites an existing corpus or audio resource with the same -name. If false (the default), the request fails if a corpus or audio resource with the same name already exists. -The parameter has no effect if a corpus or audio resource with the same name does not already exist.

    +name. If false (the default), the request fails if a corpus or audio resource with the same name already +exists. The parameter has no effect if a corpus or audio resource with the same name does not already exist.

    @@ -4846,17 +4945,24 @@

    Parameters

    -

    List an audio resource.

    +

    Get an audio resource.

    + +

    Gets information about an audio resource from a custom acoustic model. The method returns an AudioListing object +whose fields depend on the type of audio resource that you specify with the method’s audio_name parameter:

    -

    Lists information about an audio resource from a custom acoustic model. The method returns an AudioListing object -whose fields depend on the type of audio resource you specify with the method’s audio_name parameter: * For an -audio-type resource, the object’s fields match those of an AudioResource object: duration, name, details, -and status. * For an archive-type resource, the object includes a container field whose fields match those -of an AudioResource object. It also includes an audio field, which contains an array of AudioResource objects -that provides information about the audio files that are contained in the archive. The information includes the -status of the specified audio resource, which is important for checking the service’s analysis of the resource in -response to a request to add it to the custom model. You must use credentials for the instance of the service that -owns a model to list its audio resources.

    +
      +
    • For an audio-type resource, the object’s fields match those of an AudioResource object: duration, name, +details, and status.
    • +
    • For an archive-type resource, the object includes a container field whose fields match those of an +AudioResource object. It also includes an audio field, which contains an array of AudioResource objects that +provides information about the audio files that are contained in the archive. +The information includes the status of the specified audio resource. The status is important for checking the +service’s analysis of a resource that you add to the custom model.
    • +
    • For an audio-type resource, the status field is located in the AudioListing object.
    • +
    • For an archive-type resource, the status field is located in the AudioResource object that is returned in the +container field. +You must use credentials for the instance of the service that owns a model to list its audio resources.

    • +
    @@ -4897,8 +5003,8 @@

    Parameters

    -

    The name of the audio resource for the custom acoustic model. When adding an audio resource, do not include spaces -in the name; use a localized name that matches the language of the custom model.

    +

    The name of the audio resource for the custom acoustic model. When adding an audio resource, do not include +spaces in the name; use a localized name that matches the language of the custom model.

    @@ -5004,8 +5110,8 @@

    Parameters

    -

    The name of the audio resource for the custom acoustic model. When adding an audio resource, do not include spaces -in the name; use a localized name that matches the language of the custom model.

    +

    The name of the audio resource for the custom acoustic model. When adding an audio resource, do not include +spaces in the name; use a localized name that matches the language of the custom model.

    @@ -5069,9 +5175,10 @@

    Parameters

    Deletes all data that is associated with a specified customer ID. The method deletes all data for the customer ID, regardless of the method by which the information was added. The method has no effect if no data is associated with the customer ID. You must issue the request with credentials for the same instance of the service that was used to -associate the customer ID with the data. You associate a customer ID with data by passing the X-Watson-Metadata -header with a request that passes the data. For more information about customer IDs and about using this method, -see Information security.

    +associate the customer ID with the data. +You associate a customer ID with data by passing the X-Watson-Metadata header with a request that passes the +data. For more information about customer IDs and about using this method, see Information +security.

    @@ -5586,7 +5693,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Classes/SpeechToTextSession.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Classes/SpeechToTextSession.html index 3a92a3a72..352e760cc 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Classes/SpeechToTextSession.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Classes/SpeechToTextSession.html @@ -113,9 +113,6 @@ - @@ -925,7 +922,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Enums.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Enums.html index f175f4d3a..d7ec99978 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Enums.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Enums.html @@ -113,9 +113,6 @@ - @@ -270,7 +267,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html index 8d9e8c8a7..1b7a66ecf 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html @@ -113,9 +113,6 @@ - @@ -540,7 +537,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html index 13815e6a5..7e31ac228 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html @@ -113,9 +113,6 @@ - @@ -407,7 +404,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs.html index 0003300cb..a9998b92c 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs.html @@ -113,9 +113,6 @@ - @@ -203,45 +200,6 @@

    Structures

    -
    -
    - - - -

    JSON

    -
    -
    -
      -
    • -
      - - - - JSONWrapper - -
      -
      -
      -
      -
      -
      -

      Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public struct JSONWrapper
      - -
      -
      -
      -
      -
    • -
    -
    • @@ -1337,7 +1295,7 @@

      Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AcousticModel.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AcousticModel.html index 6fcc4a7a3..63a4f4907 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AcousticModel.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AcousticModel.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,17 @@

    AcousticModel

    -

    The current status of the custom acoustic model: * pending indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * ready indicates that the model contains data and is ready to be trained. * training indicates that the model is currently being trained. * available indicates that the model is trained and ready to use. * upgrading indicates that the model is currently being upgraded. * failed indicates that training of the model failed.

    +

    The current status of the custom acoustic model:

    + +
      +
    • pending indicates that the model was created but is waiting either for training data to be added or for the +service to finish analyzing added data.
    • +
    • ready indicates that the model contains data and is ready to be trained.
    • +
    • training indicates that the model is currently being trained.
    • +
    • available indicates that the model is trained and ready to use.
    • +
    • upgrading indicates that the model is currently being upgraded.
    • +
    • failed indicates that training of the model failed.
    • +
    See more
    @@ -252,7 +259,8 @@

    Declaration

    -

    The customization ID (GUID) of the custom acoustic model. The Create a custom acoustic model method returns only this field of the object; it does not return the other fields.

    +

    The customization ID (GUID) of the custom acoustic model. The Create a custom acoustic model method returns +only this field of the object; it does not return the other fields.

    @@ -279,7 +287,8 @@

    Declaration

    -

    The date and time in Coordinated Universal Time (UTC) at which the custom acoustic model was created. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    +

    The date and time in Coordinated Universal Time (UTC) at which the custom acoustic model was created. The value is +provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    @@ -333,7 +342,9 @@

    Declaration

    -

    A list of the available versions of the custom acoustic model. Each element of the array indicates a version of the base model with which the custom model can be used. Multiple versions exist only if the custom model has been upgraded; otherwise, only a single version is shown.

    +

    A list of the available versions of the custom acoustic model. Each element of the array indicates a version of the +base model with which the custom model can be used. Multiple versions exist only if the custom model has been +upgraded; otherwise, only a single version is shown.

    @@ -468,7 +479,17 @@

    Declaration

    -

    The current status of the custom acoustic model: * pending indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * ready indicates that the model contains data and is ready to be trained. * training indicates that the model is currently being trained. * available indicates that the model is trained and ready to use. * upgrading indicates that the model is currently being upgraded. * failed indicates that training of the model failed.

    +

    The current status of the custom acoustic model:

    + +
      +
    • pending indicates that the model was created but is waiting either for training data to be added or for the +service to finish analyzing added data.
    • +
    • ready indicates that the model contains data and is ready to be trained.
    • +
    • training indicates that the model is currently being trained.
    • +
    • available indicates that the model is trained and ready to use.
    • +
    • upgrading indicates that the model is currently being upgraded.
    • +
    • failed indicates that training of the model failed.
    • +
    @@ -495,7 +516,9 @@

    Declaration

    -

    A percentage that indicates the progress of the custom acoustic model’s current training. A value of 100 means that the model is fully trained. Note: The progress field does not currently reflect the progress of the training. The field changes from 0 to 100 when training is complete.

    +

    A percentage that indicates the progress of the custom acoustic model’s current training. A value of 100 means +that the model is fully trained. Note: The progress field does not currently reflect the progress of the +training. The field changes from 0 to 100 when training is complete.

    @@ -522,7 +545,8 @@

    Declaration

    -

    If the request included unknown parameters, the following message: Unexpected query parameter(s) ['parameters'] detected, where parameters is a list that includes a quoted string for each unknown parameter.

    +

    If the request included unknown parameters, the following message: Unexpected query parameter(s) ['parameters'] +detected, where parameters is a list that includes a quoted string for each unknown parameter.

    @@ -541,7 +565,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AcousticModel/Status.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AcousticModel/Status.html index a155fd62c..f1debd38f 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AcousticModel/Status.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AcousticModel/Status.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,17 @@

    Status

    -

    The current status of the custom acoustic model: * pending indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * ready indicates that the model contains data and is ready to be trained. * training indicates that the model is currently being trained. * available indicates that the model is trained and ready to use. * upgrading indicates that the model is currently being upgraded. * failed indicates that training of the model failed.

    +

    The current status of the custom acoustic model:

    + +
      +
    • pending indicates that the model was created but is waiting either for training data to be added or for the +service to finish analyzing added data.
    • +
    • ready indicates that the model contains data and is ready to be trained.
    • +
    • training indicates that the model is currently being trained.
    • +
    • available indicates that the model is trained and ready to use.
    • +
    • upgrading indicates that the model is currently being upgraded.
    • +
    • failed indicates that training of the model failed.
    • +
    @@ -378,7 +385,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AcousticModels.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AcousticModels.html index c965c7271..4d6363f60 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AcousticModels.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AcousticModels.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,9 @@

    AcousticModels

    -

    An array of objects that provides information about each available custom acoustic model. The array is empty if the requesting service credentials own no custom acoustic models (if no language is specified) or own no custom acoustic models for the specified language.

    +

    An array of objects that provides information about each available custom acoustic model. The array is empty if the +requesting service credentials own no custom acoustic models (if no language is specified) or own no custom +acoustic models for the specified language.

    @@ -243,7 +242,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioDetails.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioDetails.html index 9f7331ee9..78ba372c3 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioDetails.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioDetails.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,14 @@

    AudioDetails

    -

    The type of the audio resource: * audio for an individual audio file * archive for an archive (.zip or .tar.gz) file that contains audio files.

    +

    The type of the audio resource:

    + +
      +
    • audio for an individual audio file
    • +
    • archive for an archive (.zip or .tar.gz) file that contains audio files
    • +
    • undetermined for a resource that the service cannot validate (for example, if the user mistakenly passes a file +that does not contain audio, such as a JPEG file).
    • +
    See more
    @@ -252,7 +256,13 @@

    Declaration

    -

    For an archive-type resource,** the format of the compressed archive: * zip for a .zip file * gzip for a .tar.gz file Omitted for an audio-type resource.

    +

    For an archive-type resource, the format of the compressed archive:

    + +
      +
    • zip for a .zip file
    • +
    • gzip for a .tar.gz file +Omitted for an audio-type resource.
    • +
    See more
    @@ -280,7 +290,14 @@

    Declaration

    -

    The type of the audio resource: * audio for an individual audio file * archive for an archive (.zip or .tar.gz) file that contains audio files.

    +

    The type of the audio resource:

    + +
      +
    • audio for an individual audio file
    • +
    • archive for an archive (.zip or .tar.gz) file that contains audio files
    • +
    • undetermined for a resource that the service cannot validate (for example, if the user mistakenly passes a file +that does not contain audio, such as a JPEG file).
    • +
    @@ -334,7 +351,8 @@

    Declaration

    -

    For an audio-type resource,** the sampling rate of the audio in Hertz (samples per second). Omitted for an archive-type resource.

    +

    For an audio-type resource, the sampling rate of the audio in Hertz (samples per second). Omitted for an +archive-type resource.

    @@ -361,7 +379,13 @@

    Declaration

    -

    For an archive-type resource,** the format of the compressed archive: * zip for a .zip file * gzip for a .tar.gz file Omitted for an audio-type resource.

    +

    For an archive-type resource, the format of the compressed archive:

    + +
      +
    • zip for a .zip file
    • +
    • gzip for a .tar.gz file +Omitted for an audio-type resource.
    • +
    @@ -380,7 +404,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioDetails/Compression.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioDetails/Compression.html index 6ba4031a3..17ee9d515 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioDetails/Compression.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioDetails/Compression.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,13 @@

    Compression

    -

    For an archive-type resource,** the format of the compressed archive: * zip for a .zip file * gzip for a .tar.gz file Omitted for an audio-type resource.

    +

    For an archive-type resource, the format of the compressed archive:

    + +
      +
    • zip for a .zip file
    • +
    • gzip for a .tar.gz file +Omitted for an audio-type resource.
    • +
    @@ -270,7 +273,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioDetails/ModelType.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioDetails/ModelType.html index 585d1870c..265d4bd83 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioDetails/ModelType.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioDetails/ModelType.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,14 @@

    ModelType

    -

    The type of the audio resource: * audio for an individual audio file * archive for an archive (.zip or .tar.gz) file that contains audio files.

    +

    The type of the audio resource:

    + +
      +
    • audio for an individual audio file
    • +
    • archive for an archive (.zip or .tar.gz) file that contains audio files
    • +
    • undetermined for a resource that the service cannot validate (for example, if the user mistakenly passes a file +that does not contain audio, such as a JPEG file).
    • +
    @@ -265,12 +269,39 @@

    Declaration

    +
  • +
    + + + + undetermined + +
    +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case undetermined = "undetermined"
    + +
    +
    +
    +
    +
  • diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioListing.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioListing.html index ce0aa3d95..2c6b1c40a 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioListing.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioListing.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,17 @@

    AudioListing

    -

    For an audio-type resource,** the status of the resource: * ok indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * being_processed indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * invalid indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). Omitted for an archive-type resource.

    +

    For an audio-type resource, the status of the resource:

    + +
      +
    • ok indicates that the service has successfully analyzed the audio data. The data can be used to train the +custom model.
    • +
    • being_processed indicates that the service is still analyzing the audio data. The service cannot accept +requests to add new audio resources or to train the custom model until its analysis is complete.
    • +
    • invalid indicates that the audio data is not valid for training the custom model (possibly because it has the +wrong format or sampling rate, or because it is corrupted). +Omitted for an archive-type resource.
    • +
    See more
    @@ -252,7 +259,8 @@

    Declaration

    -

    For an audio-type resource,** the total seconds of audio in the resource. Omitted for an archive-type resource.

    +

    For an audio-type resource, the total seconds of audio in the resource. The value is always a whole number. +Omitted for an archive-type resource.

    @@ -279,7 +287,7 @@

    Declaration

    -

    For an audio-type resource,** the name of the resource. Omitted for an archive-type resource.

    +

    For an audio-type resource,** the user-specified name of the resource. Omitted for an archive-type resource.

    @@ -306,7 +314,8 @@

    Declaration

    -

    For an audio-type resource,** an AudioDetails object that provides detailed information about the resource. The object is empty until the service finishes processing the audio. Omitted for an archive-type resource.

    +

    For an audio-type resource, an AudioDetails object that provides detailed information about the resource. The +object is empty until the service finishes processing the audio. Omitted for an archive-type resource.

    @@ -333,7 +342,17 @@

    Declaration

    -

    For an audio-type resource,** the status of the resource: * ok indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * being_processed indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * invalid indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). Omitted for an archive-type resource.

    +

    For an audio-type resource, the status of the resource:

    + +
      +
    • ok indicates that the service has successfully analyzed the audio data. The data can be used to train the +custom model.
    • +
    • being_processed indicates that the service is still analyzing the audio data. The service cannot accept +requests to add new audio resources or to train the custom model until its analysis is complete.
    • +
    • invalid indicates that the audio data is not valid for training the custom model (possibly because it has the +wrong format or sampling rate, or because it is corrupted). +Omitted for an archive-type resource.
    • +
    @@ -360,7 +379,8 @@

    Declaration

    -

    For an archive-type resource,** an object of type AudioResource that provides information about the resource. Omitted for an audio-type resource.

    +

    For an archive-type resource, an object of type AudioResource that provides information about the resource. +Omitted for an audio-type resource.

    @@ -387,7 +407,8 @@

    Declaration

    -

    For an archive-type resource,** an array of AudioResource objects that provides information about the audio-type resources that are contained in the resource. Omitted for an audio-type resource.

    +

    For an archive-type resource, an array of AudioResource objects that provides information about the +audio-type resources that are contained in the resource. Omitted for an audio-type resource.

    @@ -406,7 +427,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioListing/Status.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioListing/Status.html index ad7350dda..90aad912e 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioListing/Status.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioListing/Status.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,17 @@

    Status

    -

    For an audio-type resource,** the status of the resource: * ok indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * being_processed indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * invalid indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). Omitted for an archive-type resource.

    +

    For an audio-type resource, the status of the resource:

    + +
      +
    • ok indicates that the service has successfully analyzed the audio data. The data can be used to train the +custom model.
    • +
    • being_processed indicates that the service is still analyzing the audio data. The service cannot accept +requests to add new audio resources or to train the custom model until its analysis is complete.
    • +
    • invalid indicates that the audio data is not valid for training the custom model (possibly because it has the +wrong format or sampling rate, or because it is corrupted). +Omitted for an archive-type resource.
    • +
    @@ -297,7 +304,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioResource.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioResource.html index 9d964b86f..6dca4baf4 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioResource.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioResource.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,17 @@

    AudioResource

    -

    The status of the audio resource: * ok indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * being_processed indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * invalid indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if any of its audio files are invalid.

    +

    The status of the audio resource:

    + +
      +
    • ok indicates that the service has successfully analyzed the audio data. The data can be used to train the +custom model.
    • +
    • being_processed indicates that the service is still analyzing the audio data. The service cannot accept +requests to add new audio resources or to train the custom model until its analysis is complete.
    • +
    • invalid indicates that the audio data is not valid for training the custom model (possibly because it has the +wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if +any of its audio files are invalid.
    • +
    See more
    @@ -252,7 +259,7 @@

    Declaration

    -

    The total seconds of audio in the audio resource.

    +

    The total seconds of audio in the audio resource. The value is always a whole number.

    @@ -279,7 +286,9 @@

    Declaration

    -

    The name of the audio resource.

    +

    For an archive-type resource, the user-specified name of the resource. +For an audio-type resource, the user-specified name of the resource or the name of the audio file that the user +added for the resource. The value depends on the method that is called.

    @@ -306,7 +315,8 @@

    Declaration

    -

    An AudioDetails object that provides detailed information about the audio resource. The object is empty until the service finishes processing the audio.

    +

    An AudioDetails object that provides detailed information about the audio resource. The object is empty until the +service finishes processing the audio.

    @@ -333,7 +343,17 @@

    Declaration

    -

    The status of the audio resource: * ok indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * being_processed indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * invalid indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if any of its audio files are invalid.

    +

    The status of the audio resource:

    + +
      +
    • ok indicates that the service has successfully analyzed the audio data. The data can be used to train the +custom model.
    • +
    • being_processed indicates that the service is still analyzing the audio data. The service cannot accept +requests to add new audio resources or to train the custom model until its analysis is complete.
    • +
    • invalid indicates that the audio data is not valid for training the custom model (possibly because it has the +wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if +any of its audio files are invalid.
    • +
    @@ -352,7 +372,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioResource/Status.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioResource/Status.html index 760f5dbcf..342b53ff9 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioResource/Status.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioResource/Status.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,17 @@

    Status

    -

    The status of the audio resource: * ok indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * being_processed indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * invalid indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if any of its audio files are invalid.

    +

    The status of the audio resource:

    + +
      +
    • ok indicates that the service has successfully analyzed the audio data. The data can be used to train the +custom model.
    • +
    • being_processed indicates that the service is still analyzing the audio data. The service cannot accept +requests to add new audio resources or to train the custom model until its analysis is complete.
    • +
    • invalid indicates that the audio data is not valid for training the custom model (possibly because it has the +wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if +any of its audio files are invalid.
    • +
    @@ -297,7 +304,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioResources.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioResources.html index 6311f77c8..fda91cded 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioResources.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/AudioResources.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,8 @@

    AudioResources

    -

    The total minutes of accumulated audio summed over all of the valid audio resources for the custom acoustic model. You can use this value to determine whether the custom model has too little or too much audio to begin training.

    +

    The total minutes of accumulated audio summed over all of the valid audio resources for the custom acoustic model. +You can use this value to determine whether the custom model has too little or too much audio to begin training.

    @@ -251,7 +249,8 @@

    Declaration

    -

    An array of AudioResource objects that provides information about the audio resources of the custom acoustic model. The array is empty if the custom model has no audio resources.

    +

    An array of objects that provides information about the audio resources of the custom acoustic model. The array is +empty if the custom model has no audio resources.

    @@ -270,7 +269,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/Corpora.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/Corpora.html index cddd43c6e..f17f169a6 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/Corpora.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/Corpora.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,8 @@

    Corpora

    -

    Information about corpora of the custom model. The array is empty if the custom model has no corpora.

    +

    An array of objects that provides information about the corpora for the custom model. The array is empty if the +custom model has no corpora.

    @@ -243,7 +241,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/Corpus.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/Corpus.html index f596ba2cd..52bfa1b80 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/Corpus.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/Corpus.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,15 @@

    Corpus

    -

    The status of the corpus: * analyzed indicates that the service has successfully analyzed the corpus; the custom model can be trained with data from the corpus. * being_processed indicates that the service is still analyzing the corpus; the service cannot accept requests to add new corpora or words, or to train the custom model. * undetermined indicates that the service encountered an error while processing the corpus.

    +

    The status of the corpus:

    + +
      +
    • analyzed indicates that the service has successfully analyzed the corpus; the custom model can be trained with +data from the corpus.
    • +
    • being_processed indicates that the service is still analyzing the corpus; the service cannot accept requests to +add new corpora or words, or to train the custom model.
    • +
    • undetermined indicates that the service encountered an error while processing the corpus.
    • +
    See more
    @@ -333,7 +338,15 @@

    Declaration

    -

    The status of the corpus: * analyzed indicates that the service has successfully analyzed the corpus; the custom model can be trained with data from the corpus. * being_processed indicates that the service is still analyzing the corpus; the service cannot accept requests to add new corpora or words, or to train the custom model. * undetermined indicates that the service encountered an error while processing the corpus.

    +

    The status of the corpus:

    + +
      +
    • analyzed indicates that the service has successfully analyzed the corpus; the custom model can be trained with +data from the corpus.
    • +
    • being_processed indicates that the service is still analyzing the corpus; the service cannot accept requests to +add new corpora or words, or to train the custom model.
    • +
    • undetermined indicates that the service encountered an error while processing the corpus.
    • +
    @@ -360,7 +373,8 @@

    Declaration

    -

    If the status of the corpus is undetermined, the following message: Analysis of corpus 'name' failed. Please try adding the corpus again by setting the 'allow_overwrite' flag to 'true'.

    +

    If the status of the corpus is undetermined, the following message: Analysis of corpus 'name' failed. Please try +adding the corpus again by setting the 'allow_overwrite' flag to 'true'.

    @@ -379,7 +393,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/Corpus/Status.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/Corpus/Status.html index 63a9d8c98..92d5fd88c 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/Corpus/Status.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/Corpus/Status.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,15 @@

    Status

    -

    The status of the corpus: * analyzed indicates that the service has successfully analyzed the corpus; the custom model can be trained with data from the corpus. * being_processed indicates that the service is still analyzing the corpus; the service cannot accept requests to add new corpora or words, or to train the custom model. * undetermined indicates that the service encountered an error while processing the corpus.

    +

    The status of the corpus:

    + +
      +
    • analyzed indicates that the service has successfully analyzed the corpus; the custom model can be trained with +data from the corpus.
    • +
    • being_processed indicates that the service is still analyzing the corpus; the service cannot accept requests to +add new corpora or words, or to train the custom model.
    • +
    • undetermined indicates that the service encountered an error while processing the corpus.
    • +
    @@ -297,7 +302,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateAcousticModel.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateAcousticModel.html index 62a7decc0..57621fd01 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateAcousticModel.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateAcousticModel.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,10 @@

    CreateAcousticModel

    -

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports acoustic model customization, refer to Language support for customization.

    +

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model +can be used only with the base model that it customizes. To determine whether a base model supports acoustic model +customization, refer to Language support for +customization.

    See more
    @@ -252,7 +252,9 @@

    Declaration

    -

    A user-defined name for the new custom acoustic model. Use a name that is unique among all custom acoustic models that you own. Use a localized name that matches the language of the custom model. Use a name that describes the acoustic environment of the custom model, such as Mobile custom model or Noisy car custom model.

    +

    A user-defined name for the new custom acoustic model. Use a name that is unique among all custom acoustic models +that you own. Use a localized name that matches the language of the custom model. Use a name that describes the +acoustic environment of the custom model, such as Mobile custom model or Noisy car custom model.

    @@ -279,7 +281,10 @@

    Declaration

    -

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports acoustic model customization, refer to Language support for customization.

    +

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model +can be used only with the base model that it customizes. To determine whether a base model supports acoustic model +customization, refer to Language support for +customization.

    @@ -306,7 +311,8 @@

    Declaration

    -

    A description of the new custom acoustic model. Use a localized description that matches the language of the custom model.

    +

    A description of the new custom acoustic model. Use a localized description that matches the language of the custom +model.

    @@ -340,7 +346,11 @@

    Declaration

    Declaration

    Swift

    -
    public init(name: String, baseModelName: String, description: String? = nil)
    +
    public init(
    +    name: String,
    +    baseModelName: String,
    +    description: String? = nil
    +)
    @@ -356,7 +366,9 @@

    Parameters

    -

    A user-defined name for the new custom acoustic model. Use a name that is unique among all custom acoustic models that you own. Use a localized name that matches the language of the custom model. Use a name that describes the acoustic environment of the custom model, such as Mobile custom model or Noisy car custom model.

    +

    A user-defined name for the new custom acoustic model. Use a name that is unique among all custom acoustic models +that you own. Use a localized name that matches the language of the custom model. Use a name that describes the +acoustic environment of the custom model, such as Mobile custom model or Noisy car custom model.

    @@ -368,7 +380,10 @@

    Parameters

    -

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports acoustic model customization, refer to Language support for customization.

    +

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom +model can be used only with the base model that it customizes. To determine whether a base model supports +acoustic model customization, refer to Language support for +customization.

    @@ -380,7 +395,8 @@

    Parameters

    -

    A description of the new custom acoustic model. Use a localized description that matches the language of the custom model.

    +

    A description of the new custom acoustic model. Use a localized description that matches the language of the +custom model.

    @@ -399,7 +415,7 @@

    Return Value

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateAcousticModel/BaseModelName.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateAcousticModel/BaseModelName.html index 95bdbc7f8..afd49ad9c 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateAcousticModel/BaseModelName.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateAcousticModel/BaseModelName.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,10 @@

    BaseModelName

    -

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports acoustic model customization, refer to Language support for customization.

    +

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model +can be used only with the base model that it customizes. To determine whether a base model supports acoustic model +customization, refer to Language support for +customization.

    @@ -648,7 +648,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateLanguageModel.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateLanguageModel.html index 44bbb3e7e..4f79d7eee 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateLanguageModel.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateLanguageModel.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,11 @@

    CreateLanguageModel

    -

    The name of the base language model that is to be customized by the new custom language model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports language model customization, request information about the base model and check that the attribute custom_language_model is set to true, or refer to Language support for customization.

    +

    The name of the base language model that is to be customized by the new custom language model. The new custom model +can be used only with the base model that it customizes. To determine whether a base model supports language model +customization, request information about the base model and check that the attribute custom_language_model is set +to true, or refer to Language support for +customization.

    See more
    @@ -252,7 +253,9 @@

    Declaration

    -

    A user-defined name for the new custom language model. Use a name that is unique among all custom language models that you own. Use a localized name that matches the language of the custom model. Use a name that describes the domain of the custom model, such as Medical custom model or Legal custom model.

    +

    A user-defined name for the new custom language model. Use a name that is unique among all custom language models +that you own. Use a localized name that matches the language of the custom model. Use a name that describes the +domain of the custom model, such as Medical custom model or Legal custom model.

    @@ -279,7 +282,11 @@

    Declaration

    -

    The name of the base language model that is to be customized by the new custom language model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports language model customization, request information about the base model and check that the attribute custom_language_model is set to true, or refer to Language support for customization.

    +

    The name of the base language model that is to be customized by the new custom language model. The new custom model +can be used only with the base model that it customizes. To determine whether a base model supports language model +customization, request information about the base model and check that the attribute custom_language_model is set +to true, or refer to Language support for +customization.

    @@ -306,7 +313,17 @@

    Declaration

    -

    The dialect of the specified language that is to be used with the custom language model. The parameter is meaningful only for Spanish models, for which the service creates a custom language model that is suited for speech in one of the following dialects: * es-ES for Castilian Spanish (the default) * es-LA for Latin American Spanish * es-US for North American (Mexican) Spanish A specified dialect must be valid for the base model. By default, the dialect matches the language of the base model; for example, en-US for either of the US English language models.

    +

    The dialect of the specified language that is to be used with the custom language model. The parameter is +meaningful only for Spanish models, for which the service creates a custom language model that is suited for speech +in one of the following dialects:

    + +
      +
    • es-ES for Castilian Spanish (the default)
    • +
    • es-LA for Latin American Spanish
    • +
    • es-US for North American (Mexican) Spanish +A specified dialect must be valid for the base model. By default, the dialect matches the language of the base +model; for example, en-US for either of the US English language models.
    • +
    @@ -333,7 +350,8 @@

    Declaration

    -

    A description of the new custom language model. Use a localized description that matches the language of the custom model.

    +

    A description of the new custom language model. Use a localized description that matches the language of the custom +model.

    @@ -367,7 +385,12 @@

    Declaration

    Declaration

    Swift

    -
    public init(name: String, baseModelName: String, dialect: String? = nil, description: String? = nil)
    +
    public init(
    +    name: String,
    +    baseModelName: String,
    +    dialect: String? = nil,
    +    description: String? = nil
    +)
    @@ -383,7 +406,9 @@

    Parameters

    -

    A user-defined name for the new custom language model. Use a name that is unique among all custom language models that you own. Use a localized name that matches the language of the custom model. Use a name that describes the domain of the custom model, such as Medical custom model or Legal custom model.

    +

    A user-defined name for the new custom language model. Use a name that is unique among all custom language models +that you own. Use a localized name that matches the language of the custom model. Use a name that describes the +domain of the custom model, such as Medical custom model or Legal custom model.

    @@ -395,7 +420,11 @@

    Parameters

    -

    The name of the base language model that is to be customized by the new custom language model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports language model customization, request information about the base model and check that the attribute custom_language_model is set to true, or refer to Language support for customization.

    +

    The name of the base language model that is to be customized by the new custom language model. The new custom +model can be used only with the base model that it customizes. To determine whether a base model supports +language model customization, request information about the base model and check that the attribute +custom_language_model is set to true, or refer to Language support for +customization.

    @@ -407,7 +436,17 @@

    Parameters

    -

    The dialect of the specified language that is to be used with the custom language model. The parameter is meaningful only for Spanish models, for which the service creates a custom language model that is suited for speech in one of the following dialects: * es-ES for Castilian Spanish (the default) * es-LA for Latin American Spanish * es-US for North American (Mexican) Spanish A specified dialect must be valid for the base model. By default, the dialect matches the language of the base model; for example, en-US for either of the US English language models.

    +

    The dialect of the specified language that is to be used with the custom language model. The parameter is +meaningful only for Spanish models, for which the service creates a custom language model that is suited for +speech in one of the following dialects: + +

      +
    • es-ES for Castilian Spanish (the default)
    • +
    • es-LA for Latin American Spanish
    • +
    • es-US for North American (Mexican) Spanish +A specified dialect must be valid for the base model. By default, the dialect matches the language of the base +model; for example, en-US for either of the US English language models.
    • +

    @@ -419,7 +458,8 @@

    Parameters

    -

    A description of the new custom language model. Use a localized description that matches the language of the custom model.

    +

    A description of the new custom language model. Use a localized description that matches the language of the +custom model.

    @@ -438,7 +478,7 @@

    Return Value

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateLanguageModel/BaseModelName.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateLanguageModel/BaseModelName.html index 4c00b86f8..c362e6e8e 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateLanguageModel/BaseModelName.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateLanguageModel/BaseModelName.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,11 @@

    BaseModelName

    -

    The name of the base language model that is to be customized by the new custom language model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports language model customization, request information about the base model and check that the attribute custom_language_model is set to true, or refer to Language support for customization.

    +

    The name of the base language model that is to be customized by the new custom language model. The new custom model +can be used only with the base model that it customizes. To determine whether a base model supports language model +customization, request information about the base model and check that the attribute custom_language_model is set +to true, or refer to Language support for +customization.

    @@ -513,7 +514,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CustomWord.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CustomWord.html index 11b1fea40..032e804a8 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CustomWord.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CustomWord.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,10 @@

    CustomWord

    -

    For the Add custom words method, you must specify the custom word that is to be added to or updated in the custom model. Do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of compound words. Omit this field for the Add a custom word method.

    +

    For the Add custom words method, you must specify the custom word that is to be added to or updated in the +custom model. Do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of +compound words. +Omit this field for the Add a custom word method.

    @@ -251,7 +251,13 @@

    Declaration

    -

    An array of sounds-like pronunciations for the custom word. Specify how words that are difficult to pronounce, foreign words, acronyms, and so on can be pronounced by users. For a word that is not in the service’s base vocabulary, omit the parameter to have the service automatically generate a sounds-like pronunciation for the word. For a word that is in the service’s base vocabulary, use the parameter to specify additional pronunciations for the word. You cannot override the default pronunciation of a word; pronunciations you add augment the pronunciation from the base vocabulary. A word can have at most five sounds-like pronunciations, and a pronunciation can include at most 40 characters not including spaces.

    +

    An array of sounds-like pronunciations for the custom word. Specify how words that are difficult to pronounce, +foreign words, acronyms, and so on can be pronounced by users. For a word that is not in the service’s base +vocabulary, omit the parameter to have the service automatically generate a sounds-like pronunciation for the word. +For a word that is in the service’s base vocabulary, use the parameter to specify additional pronunciations for the +word. You cannot override the default pronunciation of a word; pronunciations you add augment the pronunciation +from the base vocabulary. A word can have at most five sounds-like pronunciations, and a pronunciation can include +at most 40 characters not including spaces.

    @@ -278,7 +284,9 @@

    Declaration

    -

    An alternative spelling for the custom word when it appears in a transcript. Use the parameter when you want the word to have a spelling that is different from its usual representation or from its spelling in corpora training data.

    +

    An alternative spelling for the custom word when it appears in a transcript. Use the parameter when you want the +word to have a spelling that is different from its usual representation or from its spelling in corpora training +data.

    @@ -312,7 +320,11 @@

    Declaration

    Declaration

    Swift

    -
    public init(word: String? = nil, soundsLike: [String]? = nil, displayAs: String? = nil)
    +
    public init(
    +    word: String? = nil,
    +    soundsLike: [String]? = nil,
    +    displayAs: String? = nil
    +)
    @@ -328,7 +340,10 @@

    Parameters

    -

    For the Add custom words method, you must specify the custom word that is to be added to or updated in the custom model. Do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of compound words. Omit this field for the Add a custom word method.

    +

    For the Add custom words method, you must specify the custom word that is to be added to or updated in the +custom model. Do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of +compound words. +Omit this field for the Add a custom word method.

    @@ -340,7 +355,13 @@

    Parameters

    -

    An array of sounds-like pronunciations for the custom word. Specify how words that are difficult to pronounce, foreign words, acronyms, and so on can be pronounced by users. For a word that is not in the service’s base vocabulary, omit the parameter to have the service automatically generate a sounds-like pronunciation for the word. For a word that is in the service’s base vocabulary, use the parameter to specify additional pronunciations for the word. You cannot override the default pronunciation of a word; pronunciations you add augment the pronunciation from the base vocabulary. A word can have at most five sounds-like pronunciations, and a pronunciation can include at most 40 characters not including spaces.

    +

    An array of sounds-like pronunciations for the custom word. Specify how words that are difficult to pronounce, +foreign words, acronyms, and so on can be pronounced by users. For a word that is not in the service’s base +vocabulary, omit the parameter to have the service automatically generate a sounds-like pronunciation for the +word. For a word that is in the service’s base vocabulary, use the parameter to specify additional pronunciations +for the word. You cannot override the default pronunciation of a word; pronunciations you add augment the +pronunciation from the base vocabulary. A word can have at most five sounds-like pronunciations, and a +pronunciation can include at most 40 characters not including spaces.

    @@ -352,7 +373,9 @@

    Parameters

    -

    An alternative spelling for the custom word when it appears in a transcript. Use the parameter when you want the word to have a spelling that is different from its usual representation or from its spelling in corpora training data.

    +

    An alternative spelling for the custom word when it appears in a transcript. Use the parameter when you want the +word to have a spelling that is different from its usual representation or from its spelling in corpora training +data.

    @@ -371,7 +394,7 @@

    Return Value

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CustomWords.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CustomWords.html index dc16de9ac..616b305d6 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CustomWords.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/CustomWords.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,8 @@

    CustomWords

    -

    An array of objects that provides information about each custom word that is to be added to or updated in the custom language model.

    +

    An array of objects that provides information about each custom word that is to be added to or updated in the +custom language model.

    @@ -258,7 +256,9 @@

    Declaration

    Declaration

    Swift

    -
    public init(words: [CustomWord])
    +
    public init(
    +    words: [CustomWord]
    +)
    @@ -274,7 +274,8 @@

    Parameters

    -

    An array of objects that provides information about each custom word that is to be added to or updated in the custom language model.

    +

    An array of objects that provides information about each custom word that is to be added to or updated in the +custom language model.

    @@ -293,7 +294,7 @@

    Return Value

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/KeywordResult.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/KeywordResult.html index 71269df0b..f1f6d51d7 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/KeywordResult.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/KeywordResult.html @@ -113,9 +113,6 @@ - @@ -324,7 +321,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/LanguageModel.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/LanguageModel.html index d53530ba1..6d078b5e0 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/LanguageModel.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/LanguageModel.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,17 @@

    LanguageModel

    -

    The current status of the custom language model: * pending indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * ready indicates that the model contains data and is ready to be trained. * training indicates that the model is currently being trained. * available indicates that the model is trained and ready to use. * upgrading indicates that the model is currently being upgraded. * failed indicates that training of the model failed.

    +

    The current status of the custom language model:

    + +
      +
    • pending indicates that the model was created but is waiting either for training data to be added or for the +service to finish analyzing added data.
    • +
    • ready indicates that the model contains data and is ready to be trained.
    • +
    • training indicates that the model is currently being trained.
    • +
    • available indicates that the model is trained and ready to use.
    • +
    • upgrading indicates that the model is currently being upgraded.
    • +
    • failed indicates that training of the model failed.
    • +
    See more
    @@ -252,7 +259,8 @@

    Declaration

    -

    The customization ID (GUID) of the custom language model. The Create a custom language model method returns only this field of the object; it does not return the other fields.

    +

    The customization ID (GUID) of the custom language model. The Create a custom language model method returns +only this field of the object; it does not return the other fields.

    @@ -279,7 +287,8 @@

    Declaration

    -

    The date and time in Coordinated Universal Time (UTC) at which the custom language model was created. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    +

    The date and time in Coordinated Universal Time (UTC) at which the custom language model was created. The value is +provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    @@ -333,7 +342,15 @@

    Declaration

    -

    The dialect of the language for the custom language model. By default, the dialect matches the language of the base model; for example, en-US for either of the US English language models. For Spanish models, the field indicates the dialect for which the model was created: * es-ES for Castilian Spanish (the default) * es-LA for Latin American Spanish * es-US for North American (Mexican) Spanish.

    +

    The dialect of the language for the custom language model. By default, the dialect matches the language of the base +model; for example, en-US for either of the US English language models. For Spanish models, the field indicates +the dialect for which the model was created:

    + +
      +
    • es-ES for Castilian Spanish (the default)
    • +
    • es-LA for Latin American Spanish
    • +
    • es-US for North American (Mexican) Spanish.
    • +
    @@ -360,7 +377,9 @@

    Declaration

    -

    A list of the available versions of the custom language model. Each element of the array indicates a version of the base model with which the custom model can be used. Multiple versions exist only if the custom model has been upgraded; otherwise, only a single version is shown.

    +

    A list of the available versions of the custom language model. Each element of the array indicates a version of the +base model with which the custom model can be used. Multiple versions exist only if the custom model has been +upgraded; otherwise, only a single version is shown.

    @@ -495,7 +514,17 @@

    Declaration

    -

    The current status of the custom language model: * pending indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * ready indicates that the model contains data and is ready to be trained. * training indicates that the model is currently being trained. * available indicates that the model is trained and ready to use. * upgrading indicates that the model is currently being upgraded. * failed indicates that training of the model failed.

    +

    The current status of the custom language model:

    + +
      +
    • pending indicates that the model was created but is waiting either for training data to be added or for the +service to finish analyzing added data.
    • +
    • ready indicates that the model contains data and is ready to be trained.
    • +
    • training indicates that the model is currently being trained.
    • +
    • available indicates that the model is trained and ready to use.
    • +
    • upgrading indicates that the model is currently being upgraded.
    • +
    • failed indicates that training of the model failed.
    • +
    @@ -522,7 +551,9 @@

    Declaration

    -

    A percentage that indicates the progress of the custom language model’s current training. A value of 100 means that the model is fully trained. Note: The progress field does not currently reflect the progress of the training. The field changes from 0 to 100 when training is complete.

    +

    A percentage that indicates the progress of the custom language model’s current training. A value of 100 means +that the model is fully trained. Note: The progress field does not currently reflect the progress of the +training. The field changes from 0 to 100 when training is complete.

    @@ -549,7 +580,8 @@

    Declaration

    -

    If the request included unknown parameters, the following message: Unexpected query parameter(s) ['parameters'] detected, where parameters is a list that includes a quoted string for each unknown parameter.

    +

    If the request included unknown parameters, the following message: Unexpected query parameter(s) ['parameters'] +detected, where parameters is a list that includes a quoted string for each unknown parameter.

    @@ -568,7 +600,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/LanguageModel/Status.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/LanguageModel/Status.html index bdd8eda7b..bf1e89400 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/LanguageModel/Status.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/LanguageModel/Status.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,17 @@

    Status

    -

    The current status of the custom language model: * pending indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * ready indicates that the model contains data and is ready to be trained. * training indicates that the model is currently being trained. * available indicates that the model is trained and ready to use. * upgrading indicates that the model is currently being upgraded. * failed indicates that training of the model failed.

    +

    The current status of the custom language model:

    + +
      +
    • pending indicates that the model was created but is waiting either for training data to be added or for the +service to finish analyzing added data.
    • +
    • ready indicates that the model contains data and is ready to be trained.
    • +
    • training indicates that the model is currently being trained.
    • +
    • available indicates that the model is trained and ready to use.
    • +
    • upgrading indicates that the model is currently being upgraded.
    • +
    • failed indicates that training of the model failed.
    • +
    @@ -378,7 +385,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/LanguageModels.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/LanguageModels.html index c41fa63db..c718ee05c 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/LanguageModels.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/LanguageModels.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,9 @@

    LanguageModels

    -

    An array of objects that provides information about each available custom language model. The array is empty if the requesting service credentials own no custom language models (if no language is specified) or own no custom language models for the specified language.

    +

    An array of objects that provides information about each available custom language model. The array is empty if the +requesting service credentials own no custom language models (if no language is specified) or own no custom +language models for the specified language.

    @@ -243,7 +242,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RecognitionJob.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RecognitionJob.html index f44da3b74..cb7073887 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RecognitionJob.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RecognitionJob.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,18 @@

    RecognitionJob

    -

    The current status of the job: * waiting: The service is preparing the job for processing. The service returns this status when the job is initially created or when it is waiting for capacity to process the job. The job remains in this state until the service has the capacity to begin processing it. * processing: The service is actively processing the job. * completed: The service has finished processing the job. If the job specified a callback URL and the event recognitions.completed_with_results, the service sent the results with the callback notification; otherwise, you must retrieve the results by checking the individual job. * failed: The job failed.

    +

    The current status of the job:

    + +
      +
    • waiting: The service is preparing the job for processing. The service returns this status when the job is +initially created or when it is waiting for capacity to process the job. The job remains in this state until the +service has the capacity to begin processing it.
    • +
    • processing: The service is actively processing the job.
    • +
    • completed: The service has finished processing the job. If the job specified a callback URL and the event +recognitions.completed_with_results, the service sent the results with the callback notification; otherwise, you +must retrieve the results by checking the individual job.
    • +
    • failed: The job failed.
    • +
    See more
    @@ -279,7 +287,18 @@

    Declaration

    -

    The current status of the job: * waiting: The service is preparing the job for processing. The service returns this status when the job is initially created or when it is waiting for capacity to process the job. The job remains in this state until the service has the capacity to begin processing it. * processing: The service is actively processing the job. * completed: The service has finished processing the job. If the job specified a callback URL and the event recognitions.completed_with_results, the service sent the results with the callback notification; otherwise, you must retrieve the results by checking the individual job. * failed: The job failed.

    +

    The current status of the job:

    + +
      +
    • waiting: The service is preparing the job for processing. The service returns this status when the job is +initially created or when it is waiting for capacity to process the job. The job remains in this state until the +service has the capacity to begin processing it.
    • +
    • processing: The service is actively processing the job.
    • +
    • completed: The service has finished processing the job. If the job specified a callback URL and the event +recognitions.completed_with_results, the service sent the results with the callback notification; otherwise, you +must retrieve the results by checking the individual job.
    • +
    • failed: The job failed.
    • +
    @@ -306,7 +325,8 @@

    Declaration

    -

    The date and time in Coordinated Universal Time (UTC) at which the job was created. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    +

    The date and time in Coordinated Universal Time (UTC) at which the job was created. The value is provided in full +ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    @@ -333,7 +353,9 @@

    Declaration

    -

    The date and time in Coordinated Universal Time (UTC) at which the job was last updated by the service. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD). This field is returned only by the Check jobs and Check a job methods.

    +

    The date and time in Coordinated Universal Time (UTC) at which the job was last updated by the service. The value +is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD). This field is returned only by the Check jobs +and Check a job methods.

    @@ -360,7 +382,8 @@

    Declaration

    -

    The URL to use to request information about the job with the Check a job method. This field is returned only by the Create a job method.

    +

    The URL to use to request information about the job with the Check a job method. This field is returned only by +the Create a job method.

    @@ -387,7 +410,8 @@

    Declaration

    -

    The user token associated with a job that was created with a callback URL and a user token. This field can be returned only by the Check jobs method.

    +

    The user token associated with a job that was created with a callback URL and a user token. This field can be +returned only by the Check jobs method.

    @@ -414,7 +438,8 @@

    Declaration

    -

    If the status is completed, the results of the recognition request as an array that includes a single instance of a SpeechRecognitionResults object. This field is returned only by the Check a job method.

    +

    If the status is completed, the results of the recognition request as an array that includes a single instance of +a SpeechRecognitionResults object. This field is returned only by the Check a job method.

    @@ -441,7 +466,10 @@

    Declaration

    -

    An array of warning messages about invalid parameters included with the request. Each warning includes a descriptive message and a list of invalid argument strings, for example, "unexpected query parameter 'user_token', query parameter 'callback_url' was not specified". The request succeeds despite the warnings. This field can be returned only by the Create a job method.

    +

    An array of warning messages about invalid parameters included with the request. Each warning includes a +descriptive message and a list of invalid argument strings, for example, "unexpected query parameter 'user_token', +query parameter 'callback_url' was not specified". The request succeeds despite the warnings. This field can be +returned only by the Create a job method.

    @@ -460,7 +488,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RecognitionJob/Status.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RecognitionJob/Status.html index ce65ec196..81ba8a65c 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RecognitionJob/Status.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RecognitionJob/Status.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,18 @@

    Status

    -

    The current status of the job: * waiting: The service is preparing the job for processing. The service returns this status when the job is initially created or when it is waiting for capacity to process the job. The job remains in this state until the service has the capacity to begin processing it. * processing: The service is actively processing the job. * completed: The service has finished processing the job. If the job specified a callback URL and the event recognitions.completed_with_results, the service sent the results with the callback notification; otherwise, you must retrieve the results by checking the individual job. * failed: The job failed.

    +

    The current status of the job:

    + +
      +
    • waiting: The service is preparing the job for processing. The service returns this status when the job is +initially created or when it is waiting for capacity to process the job. The job remains in this state until the +service has the capacity to begin processing it.
    • +
    • processing: The service is actively processing the job.
    • +
    • completed: The service has finished processing the job. If the job specified a callback URL and the event +recognitions.completed_with_results, the service sent the results with the callback notification; otherwise, you +must retrieve the results by checking the individual job.
    • +
    • failed: The job failed.
    • +
    @@ -324,7 +332,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RecognitionJobs.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RecognitionJobs.html index f861ec359..720a53f23 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RecognitionJobs.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RecognitionJobs.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,8 @@

    RecognitionJobs

    -

    An array of objects that provides the status for each of the user’s current jobs. The array is empty if the user has no current jobs.

    +

    An array of objects that provides the status for each of the user’s current jobs. The array is empty if the user +has no current jobs.

    @@ -243,7 +241,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RecognitionSettings.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RecognitionSettings.html index b4bb2656f..1f9a65b65 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RecognitionSettings.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RecognitionSettings.html @@ -113,9 +113,6 @@ - @@ -617,7 +614,7 @@

    Return Value

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RegisterStatus.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RegisterStatus.html index 6411baa6d..cd9943cab 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RegisterStatus.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RegisterStatus.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,12 @@

    RegisterStatus

    -

    The current status of the job: * created if the callback URL was successfully white-listed as a result of the call. * already created if the URL was already white-listed.

    +

    The current status of the job:

    + +
      +
    • created if the callback URL was successfully white-listed as a result of the call.
    • +
    • already created if the URL was already white-listed.
    • +
    See more
    @@ -252,7 +254,12 @@

    Declaration

    -

    The current status of the job: * created if the callback URL was successfully white-listed as a result of the call. * already created if the URL was already white-listed.

    +

    The current status of the job:

    + +
      +
    • created if the callback URL was successfully white-listed as a result of the call.
    • +
    • already created if the URL was already white-listed.
    • +
    @@ -298,7 +305,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RegisterStatus/Status.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RegisterStatus/Status.html index fb1d3a772..5063fc7a1 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RegisterStatus/Status.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/RegisterStatus/Status.html @@ -113,9 +113,6 @@ - @@ -205,7 +202,12 @@

    Status

    -

    The current status of the job: * created if the callback URL was successfully white-listed as a result of the call. * already created if the URL was already white-listed.

    +

    The current status of the job:

    + +
      +
    • created if the callback URL was successfully white-listed as a result of the call.
    • +
    • already created if the URL was already white-listed.
    • +
    @@ -270,7 +272,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeakerLabelsResult.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeakerLabelsResult.html index c9f53274d..8730114e3 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeakerLabelsResult.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeakerLabelsResult.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,8 @@

    SpeakerLabelsResult

    -

    The start time of a word from the transcript. The value matches the start time of a word from the timestamps array.

    +

    The start time of a word from the transcript. The value matches the start time of a word from the timestamps +array.

    @@ -278,7 +276,9 @@

    Declaration

    -

    The numeric identifier that the service assigns to a speaker from the audio. Speaker IDs begin at 0 initially but can evolve and change across interim results (if supported by the method) and between interim and final results as the service processes the audio. They are not guaranteed to be sequential, contiguous, or ordered.

    +

    The numeric identifier that the service assigns to a speaker from the audio. Speaker IDs begin at 0 initially but +can evolve and change across interim results (if supported by the method) and between interim and final results as +the service processes the audio. They are not guaranteed to be sequential, contiguous, or ordered.

    @@ -332,7 +332,9 @@

    Declaration

    -

    An indication of whether the service might further change word and speaker-label results. A value of true means that the service guarantees not to send any further updates for the current or any preceding results; false means that the service might send further updates to the results.

    +

    An indication of whether the service might further change word and speaker-label results. A value of true means +that the service guarantees not to send any further updates for the current or any preceding results; false means +that the service might send further updates to the results.

    @@ -351,7 +353,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechModel.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechModel.html index be4e9b5cc..f431d18e1 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechModel.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechModel.html @@ -113,9 +113,6 @@ - @@ -386,7 +383,8 @@

    Declaration

    -

    The URI for the model for use with the Create a session method. This field is returned only by the Get a model method.

    +

    The URI for the model for use with the Create a session method. This field is returned only by the Get a +model method.

    @@ -405,7 +403,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechModels.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechModels.html index b82e86301..057c4a2bf 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechModels.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechModels.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,7 @@

    SpeechModels

    -

    Information about each available model.

    +

    An array of objects that provides information about each available model.

    @@ -243,7 +240,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechRecognitionAlternative.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechRecognitionAlternative.html index 84669e71d..695fc6241 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechRecognitionAlternative.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechRecognitionAlternative.html @@ -113,9 +113,6 @@ - @@ -251,7 +248,8 @@

    Declaration

    -

    A score that indicates the service’s confidence in the transcript in the range of 0 to 1. Returned only for the best alternative and only with results marked as final.

    +

    A score that indicates the service’s confidence in the transcript in the range of 0 to 1. Returned only for the +best alternative and only with results marked as final.

    @@ -278,7 +276,9 @@

    Declaration

    -

    Time alignments for each word from the transcript as a list of lists. Each inner list consists of three elements: the word followed by its start and end time in seconds. Example: [["hello",0.0,1.2],["world",1.2,2.5]]. Returned only for the best alternative.

    +

    Time alignments for each word from the transcript as a list of lists. Each inner list consists of three elements: +the word followed by its start and end time in seconds. Example: [["hello",0.0,1.2],["world",1.2,2.5]]. Returned +only for the best alternative.

    @@ -305,7 +305,9 @@

    Declaration

    -

    A confidence score for each word of the transcript as a list of lists. Each inner list consists of two elements: the word and its confidence score in the range of 0 to 1. Example: [["hello",0.95],["world",0.866]]. Returned only for the best alternative and only with results marked as final.

    +

    A confidence score for each word of the transcript as a list of lists. Each inner list consists of two elements: +the word and its confidence score in the range of 0 to 1. Example: [["hello",0.95],["world",0.866]]. Returned +only for the best alternative and only with results marked as final.

    @@ -324,7 +326,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechRecognitionResult.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechRecognitionResult.html index ddd3ab3d6..b4dbf3a69 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechRecognitionResult.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechRecognitionResult.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,8 @@

    SpeechRecognitionResult

    -

    An indication of whether the transcription results are final. If true, the results for this utterance are not updated further; no additional results are sent for a result_index once its results are indicated as final.

    +

    An indication of whether the transcription results are final. If true, the results for this utterance are not +updated further; no additional results are sent for a result_index once its results are indicated as final.

    @@ -251,7 +249,8 @@

    Declaration

    -

    An array of alternative transcripts. The alternatives array can include additional requested output such as word confidence or timestamps.

    +

    An array of alternative transcripts. The alternatives array can include additional requested output such as word +confidence or timestamps.

    @@ -278,7 +277,9 @@

    Declaration

    -

    A dictionary (or associative array) whose keys are the strings specified for keywords if both that parameter and keywords_threshold are specified. A keyword for which no matches are found is omitted from the array. The array is omitted if no matches are found for any keywords.

    +

    A dictionary (or associative array) whose keys are the strings specified for keywords if both that parameter and +keywords_threshold are specified. A keyword for which no matches are found is omitted from the array. The array +is omitted if no matches are found for any keywords.

    @@ -305,7 +306,8 @@

    Declaration

    -

    An array of alternative hypotheses found for words of the input audio if a word_alternatives_threshold is specified.

    +

    An array of alternative hypotheses found for words of the input audio if a word_alternatives_threshold is +specified.

    @@ -324,7 +326,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechRecognitionResults.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechRecognitionResults.html index c6e1cd630..58b5aac82 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechRecognitionResults.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechRecognitionResults.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,10 @@

    SpeechRecognitionResults

    -

    An array that can include interim and final results (interim results are returned only if supported by the method). Final results are guaranteed not to change; interim results might be replaced by further interim results and final results. The service periodically sends updates to the results list; the result_index is set to the lowest index in the array that has changed; it is incremented for new results.

    +

    An array that can include interim and final results (interim results are returned only if supported by the method). +Final results are guaranteed not to change; interim results might be replaced by further interim results and final +results. The service periodically sends updates to the results list; the result_index is set to the lowest index +in the array that has changed; it is incremented for new results.

    @@ -251,7 +251,8 @@

    Declaration

    -

    An index that indicates a change point in the results array. The service increments the index only for additional results that it sends for new audio for the same request.

    +

    An index that indicates a change point in the results array. The service increments the index only for additional +results that it sends for new audio for the same request.

    @@ -278,7 +279,9 @@

    Declaration

    -

    An array that identifies which words were spoken by which speakers in a multi-person exchange. Returned in the response only if speaker_labels is true. When interim results are also requested for methods that support them, it is possible for a SpeechRecognitionResults object to include only the speaker_labels field.

    +

    An array that identifies which words were spoken by which speakers in a multi-person exchange. Returned in the +response only if speaker_labels is true. When interim results are also requested for methods that support them, +it is possible for a SpeechRecognitionResults object to include only the speaker_labels field.

    @@ -305,7 +308,19 @@

    Declaration

    -

    An array of warning messages associated with the request: * Warnings for invalid parameters or fields can include a descriptive message and a list of invalid argument strings, for example, "Unknown arguments:" or "Unknown url query arguments:" followed by a list of the form "invalid_arg_1, invalid_arg_2." * The following warning is returned if the request passes a custom model that is based on an older version of a base model for which an updated version is available: "Using previous version of base model, because your custom model has been built with it. Please note that this version will be supported only for a limited time. Consider updating your custom model to the new base model. If you do not do that you will be automatically switched to base model when you used the non-updated custom model." In both cases, the request succeeds despite the warnings.

    +

    An array of warning messages associated with the request:

    + +
      +
    • Warnings for invalid parameters or fields can include a descriptive message and a list of invalid argument +strings, for example, "Unknown arguments:" or "Unknown url query arguments:" followed by a list of the form +"invalid_arg_1, invalid_arg_2."
    • +
    • The following warning is returned if the request passes a custom model that is based on an older version of a +base model for which an updated version is available: "Using previous version of base model, because your custom +model has been built with it. Please note that this version will be supported only for a limited time. Consider +updating your custom model to the new base model. If you do not do that you will be automatically switched to base +model when you used the non-updated custom model." +In both cases, the request succeeds despite the warnings.
    • +
    @@ -324,7 +339,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechRecognitionResultsAccumulator.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechRecognitionResultsAccumulator.html index 548b771bc..41619868b 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechRecognitionResultsAccumulator.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SpeechRecognitionResultsAccumulator.html @@ -113,9 +113,6 @@ - @@ -351,7 +348,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SupportedFeatures.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SupportedFeatures.html index 5d4571285..bd46463b8 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SupportedFeatures.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/SupportedFeatures.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,8 @@

    SupportedFeatures

    -

    Indicates whether the customization interface can be used to create a custom language model based on the language model.

    +

    Indicates whether the customization interface can be used to create a custom language model based on the language +model.

    @@ -270,7 +268,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/Word.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/Word.html index cf8499a32..82d586b48 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/Word.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/Word.html @@ -113,9 +113,6 @@ - @@ -251,7 +248,9 @@

    Declaration

    -

    An array of pronunciations for the word. The array can include the sounds-like pronunciation automatically generated by the service if none is provided for the word; the service adds this pronunciation when it finishes processing the word.

    +

    An array of pronunciations for the word. The array can include the sounds-like pronunciation automatically +generated by the service if none is provided for the word; the service adds this pronunciation when it finishes +processing the word.

    @@ -278,7 +277,8 @@

    Declaration

    -

    The spelling of the word that the service uses to display the word in a transcript. The field contains an empty string if no display-as value is provided for the word, in which case the word is displayed as it is spelled.

    +

    The spelling of the word that the service uses to display the word in a transcript. The field contains an empty +string if no display-as value is provided for the word, in which case the word is displayed as it is spelled.

    @@ -305,7 +305,10 @@

    Declaration

    -

    A sum of the number of times the word is found across all corpora. For example, if the word occurs five times in one corpus and seven times in another, its count is 12. If you add a custom word to a model before it is added by any corpora, the count begins at 1; if the word is added from a corpus first and later modified, the count reflects only the number of times it is found in corpora.

    +

    A sum of the number of times the word is found across all corpora. For example, if the word occurs five times in +one corpus and seven times in another, its count is 12. If you add a custom word to a model before it is added by +any corpora, the count begins at 1; if the word is added from a corpus first and later modified, the count +reflects only the number of times it is found in corpora.

    @@ -332,7 +335,9 @@

    Declaration

    -

    An array of sources that describes how the word was added to the custom model’s words resource. For OOV words added from a corpus, includes the name of the corpus; if the word was added by multiple corpora, the names of all corpora are listed. If the word was modified or added by the user directly, the field includes the string user.

    +

    An array of sources that describes how the word was added to the custom model’s words resource. For OOV words added +from a corpus, includes the name of the corpus; if the word was added by multiple corpora, the names of all corpora +are listed. If the word was modified or added by the user directly, the field includes the string user.

    @@ -359,7 +364,8 @@

    Declaration

    -

    If the service discovered one or more problems that you need to correct for the word’s definition, an array that describes each of the errors.

    +

    If the service discovered one or more problems that you need to correct for the word’s definition, an array that +describes each of the errors.

    @@ -378,7 +384,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/WordAlternativeResult.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/WordAlternativeResult.html index 388351f9e..c86c0b401 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/WordAlternativeResult.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/WordAlternativeResult.html @@ -113,9 +113,6 @@ - @@ -270,7 +267,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/WordAlternativeResults.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/WordAlternativeResults.html index 8576526f2..058677566 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/WordAlternativeResults.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/WordAlternativeResults.html @@ -113,9 +113,6 @@ - @@ -297,7 +294,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/WordConfidence.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/WordConfidence.html index d2edac4cf..a582e30e3 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/WordConfidence.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/WordConfidence.html @@ -113,9 +113,6 @@ - @@ -297,7 +294,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/WordError.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/WordError.html index 180902717..ce3df5ed5 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/WordError.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/WordError.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,11 @@

    WordError

    -

    A key-value pair that describes an error associated with the definition of a word in the words resource. Each pair has the format "element": "message", where element is the aspect of the definition that caused the problem and message describes the problem. The following example describes a problem with one of the word’s sounds-like definitions: "{sounds_like_string}": "Numbers are not allowed in sounds-like. You can try for example '{suggested_string}'." You must correct the error before you can train the model.

    +

    A key-value pair that describes an error associated with the definition of a word in the words resource. Each pair +has the format "element": "message", where element is the aspect of the definition that caused the problem and +message describes the problem. The following example describes a problem with one of the word’s sounds-like +definitions: "{sounds_like_string}": "Numbers are not allowed in sounds-like. You can try for example +'{suggested_string}'." You must correct the error before you can train the model.

    @@ -243,7 +244,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/WordTimestamp.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/WordTimestamp.html index e7e02873a..e5dbe6963 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/WordTimestamp.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/WordTimestamp.html @@ -113,9 +113,6 @@ - @@ -324,7 +321,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/Words.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/Words.html index 7d0405f25..cdf5bc55b 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/Words.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/Structs/Words.html @@ -113,9 +113,6 @@ - @@ -224,7 +221,8 @@

    Words

    -

    Information about each word in the custom model’s words resource. The array is empty if the custom model has no words.

    +

    An array of objects that provides information about each word in the custom model’s words resource. The array is +empty if the custom model has no words.

    @@ -243,7 +241,7 @@

    Declaration

    diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/index.html b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/index.html index adbe47327..3fad4d4e4 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/index.html +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/index.html @@ -112,9 +112,6 @@ - @@ -238,7 +235,8 @@

    Services

    • Assistant
    • Discovery
    • -
    • Language Translator
    • +
    • Language Translator V2
    • +
    • Language Translator V3
    • Natural Language Classifier
    • Natural Language Understanding
    • Personality Insights
    • @@ -283,7 +281,7 @@

      Swift Package Manager

      Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

      dependencies: [
      -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
      +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
       ]
       

      Service Instances

      @@ -326,7 +324,7 @@

      Username and Password

      API Key

      -

      Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

      +

      Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

      let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
       

      Using IAM

      @@ -561,7 +559,12 @@

      Private Data Collections

    • IBM Discovery - Documentation
    • IBM Discovery - Demo
    -

    Language Translator

    +

    Language Translator V2

    + +

    Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

    The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

    @@ -572,6 +575,25 @@

    Language Translator

    let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} + +

    Language Translator V3

    + +

    The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

    + +

    The following example demonstrates how to use the Language Translator service:

    +
    import LanguageTranslatorV3
    +
    +let username = "your-username-here"
    +let password = "your-password-here"
    +let version = "yyyy-mm-dd" // use today's date for the most recent version
    +let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
    +
     let failure = { (error: Error) in print(error) }
     let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
     languageTranslator.translate(request: request, failure: failure) {
    @@ -962,7 +984,7 @@ 

    Visual Recognition

    let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -970,6 +992,10 @@

    Visual Recognition

    print(classifiedImages) }
    + +

    Note: a different initializer is used for authentication with instances created before May 23, 2018:

    +
    let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
    +

    Using Core ML

    The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

    @@ -1021,7 +1047,7 @@

    Bundlin diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/search.json b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/search.json index 6a81b9b90..28371ba0b 100644 --- a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/search.json +++ b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/Documents/search.json @@ -1 +1 @@ -{"Structs/SpeechRecognitionResultsAccumulator.html#/s:14SpeechToTextV10A29RecognitionResultsAccumulatorV7resultsSayAA0aE6ResultVGvp":{"name":"results","abstract":"

    All accumulated recognition results.

    ","parent_name":"SpeechRecognitionResultsAccumulator"},"Structs/SpeechRecognitionResultsAccumulator.html#/s:14SpeechToTextV10A29RecognitionResultsAccumulatorV13speakerLabelsSayAA07SpeakerI6ResultVGvp":{"name":"speakerLabels","abstract":"

    All accumulated speaker labels.

    ","parent_name":"SpeechRecognitionResultsAccumulator"},"Structs/SpeechRecognitionResultsAccumulator.html#/s:14SpeechToTextV10A29RecognitionResultsAccumulatorV14bestTranscriptSSvp":{"name":"bestTranscript","abstract":"

    A concatenation of transcripts with the greatest confidence.

    ","parent_name":"SpeechRecognitionResultsAccumulator"},"Structs/SpeechRecognitionResultsAccumulator.html#/s:14SpeechToTextV10A29RecognitionResultsAccumulatorVACycfc":{"name":"init()","abstract":"

    Initialize a SpeechRecognitionResultsAccumulator to accumulate recognition results.

    ","parent_name":"SpeechRecognitionResultsAccumulator"},"Structs/SpeechRecognitionResultsAccumulator.html#/s:14SpeechToTextV10A29RecognitionResultsAccumulatorV3addyAA0aeF0V7results_tF":{"name":"add(results:)","abstract":"

    Add recognition results to be accumulated.

    ","parent_name":"SpeechRecognitionResultsAccumulator"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV11contentTypeSSvp":{"name":"contentType","abstract":"

    The format of the audio data. Endianness is automatically detected by the Speech to Text","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV17inactivityTimeoutSiSgvp":{"name":"inactivityTimeout","abstract":"

    The number of seconds after which the connection is to time out due to inactivity.","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV8keywordsSaySSGSgvp":{"name":"keywords","abstract":"

    An array of keyword strings to be matched in the input audio. By default, the service","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV17keywordsThresholdSdSgvp":{"name":"keywordsThreshold","abstract":"

    A minimum level of confidence that the service must have to report a matching keyword","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV15maxAlternativesSiSgvp":{"name":"maxAlternatives","abstract":"

    The maximum number of alternative transcriptions to receive. The default is 1.

    ","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV14interimResultsSbSgvp":{"name":"interimResults","abstract":"

    If true, then interim results (i.e. results that are not final) will be received","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV25wordAlternativesThresholdSdSgvp":{"name":"wordAlternativesThreshold","abstract":"

    A minimum level of confidence that the service must have to report a hypothesis for a","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV14wordConfidenceSbSgvp":{"name":"wordConfidence","abstract":"

    If true, then a confidence score will be received for each word of the transcription.","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV10timestampsSbSgvp":{"name":"timestamps","abstract":"

    If true, then per-word start and end times relative to the beginning of the audio will","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV15filterProfanitySbSgvp":{"name":"filterProfanity","abstract":"

    If true, then profanity will be censored from the service’s output, obscuring each","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV15smartFormattingSbSgvp":{"name":"smartFormatting","abstract":"

    Indicates whether dates, times, series of digits and numbers, phone numbers, currency values,","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV13speakerLabelsSbSgvp":{"name":"speakerLabels","abstract":"

    If true, then speaker labels will be returned for each timestamp. The default is false.

    ","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsVACSS11contentType_tcfc":{"name":"init(contentType:)","abstract":"

    Initialize a RecognitionSettings object to set the parameters of a Watson Speech to","parent_name":"RecognitionSettings"},"Structs/Words.html#/s:14SpeechToTextV15WordsV5wordsSayAA4WordVGvp":{"name":"words","abstract":"

    Information about each word in the custom model’s words resource. The array is empty if the custom model has no words.

    ","parent_name":"Words"},"Structs/WordTimestamp.html#/s:14SpeechToTextV113WordTimestampV4wordSSvp":{"name":"word","abstract":"

    A particular word from the transcription.

    ","parent_name":"WordTimestamp"},"Structs/WordTimestamp.html#/s:14SpeechToTextV113WordTimestampV9startTimeSdvp":{"name":"startTime","abstract":"

    The start time, in seconds, of the given word in the audio input.

    ","parent_name":"WordTimestamp"},"Structs/WordTimestamp.html#/s:14SpeechToTextV113WordTimestampV7endTimeSdvp":{"name":"endTime","abstract":"

    The end time, in seconds, of the given word in the audio input.

    ","parent_name":"WordTimestamp"},"Structs/WordTimestamp.html#/s:14SpeechToTextV113WordTimestampVACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Used internally to initialize a WordTimestamp model from JSON.

    ","parent_name":"WordTimestamp"},"Structs/WordError.html#/s:14SpeechToTextV19WordErrorV7elementSSvp":{"name":"element","abstract":"

    A key-value pair that describes an error associated with the definition of a word in the words resource. Each pair has the format "element": "message", where element is the aspect of the definition that caused the problem and message describes the problem. The following example describes a problem with one of the word’s sounds-like definitions: "{sounds_like_string}": "Numbers are not allowed in sounds-like. You can try for example '{suggested_string}'." You must correct the error before you can train the model.

    ","parent_name":"WordError"},"Structs/WordConfidence.html#/s:14SpeechToTextV114WordConfidenceV4wordSSvp":{"name":"word","abstract":"

    A particular word from the transcription.

    ","parent_name":"WordConfidence"},"Structs/WordConfidence.html#/s:14SpeechToTextV114WordConfidenceV10confidenceSdvp":{"name":"confidence","abstract":"

    The confidence of the given word, between 0 and 1.

    ","parent_name":"WordConfidence"},"Structs/WordConfidence.html#/s:14SpeechToTextV114WordConfidenceVACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Used internally to initialize a WordConfidence model from JSON.

    ","parent_name":"WordConfidence"},"Structs/WordAlternativeResults.html#/s:14SpeechToTextV122WordAlternativeResultsV9startTimeSdvp":{"name":"startTime","abstract":"

    The start time in seconds of the word from the input audio that corresponds to the word alternatives.

    ","parent_name":"WordAlternativeResults"},"Structs/WordAlternativeResults.html#/s:14SpeechToTextV122WordAlternativeResultsV7endTimeSdvp":{"name":"endTime","abstract":"

    The end time in seconds of the word from the input audio that corresponds to the word alternatives.

    ","parent_name":"WordAlternativeResults"},"Structs/WordAlternativeResults.html#/s:14SpeechToTextV122WordAlternativeResultsV12alternativesSayAA0eF6ResultVGvp":{"name":"alternatives","abstract":"

    An array of alternative hypotheses for a word from the input audio.

    ","parent_name":"WordAlternativeResults"},"Structs/WordAlternativeResult.html#/s:14SpeechToTextV121WordAlternativeResultV10confidenceSdvp":{"name":"confidence","abstract":"

    A confidence score for the word alternative hypothesis in the range of 0 to 1.

    ","parent_name":"WordAlternativeResult"},"Structs/WordAlternativeResult.html#/s:14SpeechToTextV121WordAlternativeResultV4wordSSvp":{"name":"word","abstract":"

    An alternative hypothesis for a word from the input audio.

    ","parent_name":"WordAlternativeResult"},"Structs/Word.html#/s:14SpeechToTextV14WordV4wordSSvp":{"name":"word","abstract":"

    A word from the custom model’s words resource. The spelling of the word is used to train the model.

    ","parent_name":"Word"},"Structs/Word.html#/s:14SpeechToTextV14WordV10soundsLikeSaySSGvp":{"name":"soundsLike","abstract":"

    An array of pronunciations for the word. The array can include the sounds-like pronunciation automatically generated by the service if none is provided for the word; the service adds this pronunciation when it finishes processing the word.

    ","parent_name":"Word"},"Structs/Word.html#/s:14SpeechToTextV14WordV9displayAsSSvp":{"name":"displayAs","abstract":"

    The spelling of the word that the service uses to display the word in a transcript. The field contains an empty string if no display-as value is provided for the word, in which case the word is displayed as it is spelled.

    ","parent_name":"Word"},"Structs/Word.html#/s:14SpeechToTextV14WordV5countSivp":{"name":"count","abstract":"

    A sum of the number of times the word is found across all corpora. For example, if the word occurs five times in one corpus and seven times in another, its count is 12. If you add a custom word to a model before it is added by any corpora, the count begins at 1; if the word is added from a corpus first and later modified, the count reflects only the number of times it is found in corpora.

    ","parent_name":"Word"},"Structs/Word.html#/s:14SpeechToTextV14WordV6sourceSaySSGvp":{"name":"source","abstract":"

    An array of sources that describes how the word was added to the custom model’s words resource. For OOV words added from a corpus, includes the name of the corpus; if the word was added by multiple corpora, the names of all corpora are listed. If the word was modified or added by the user directly, the field includes the string user.

    ","parent_name":"Word"},"Structs/Word.html#/s:14SpeechToTextV14WordV5errorSayAA0E5ErrorVGSgvp":{"name":"error","abstract":"

    If the service discovered one or more problems that you need to correct for the word’s definition, an array that describes each of the errors.

    ","parent_name":"Word"},"Structs/SupportedFeatures.html#/s:14SpeechToTextV117SupportedFeaturesV19customLanguageModelSbvp":{"name":"customLanguageModel","abstract":"

    Indicates whether the customization interface can be used to create a custom language model based on the language model.

    ","parent_name":"SupportedFeatures"},"Structs/SupportedFeatures.html#/s:14SpeechToTextV117SupportedFeaturesV13speakerLabelsSbvp":{"name":"speakerLabels","abstract":"

    Indicates whether the speaker_labels parameter can be used with the language model.

    ","parent_name":"SupportedFeatures"},"Structs/SpeechRecognitionResults.html#/s:14SpeechToTextV10A18RecognitionResultsV7resultsSayAA0aE6ResultVGSgvp":{"name":"results","abstract":"

    An array that can include interim and final results (interim results are returned only if supported by the method). Final results are guaranteed not to change; interim results might be replaced by further interim results and final results. The service periodically sends updates to the results list; the result_index is set to the lowest index in the array that has changed; it is incremented for new results.

    ","parent_name":"SpeechRecognitionResults"},"Structs/SpeechRecognitionResults.html#/s:14SpeechToTextV10A18RecognitionResultsV11resultIndexSiSgvp":{"name":"resultIndex","abstract":"

    An index that indicates a change point in the results array. The service increments the index only for additional results that it sends for new audio for the same request.

    ","parent_name":"SpeechRecognitionResults"},"Structs/SpeechRecognitionResults.html#/s:14SpeechToTextV10A18RecognitionResultsV13speakerLabelsSayAA07SpeakerH6ResultVGSgvp":{"name":"speakerLabels","abstract":"

    An array that identifies which words were spoken by which speakers in a multi-person exchange. Returned in the response only if speaker_labels is true. When interim results are also requested for methods that support them, it is possible for a SpeechRecognitionResults object to include only the speaker_labels field.

    ","parent_name":"SpeechRecognitionResults"},"Structs/SpeechRecognitionResults.html#/s:14SpeechToTextV10A18RecognitionResultsV8warningsSaySSGSgvp":{"name":"warnings","abstract":"

    An array of warning messages associated with the request: * Warnings for invalid parameters or fields can include a descriptive message and a list of invalid argument strings, for example, "Unknown arguments:" or "Unknown url query arguments:" followed by a list of the form "invalid_arg_1, invalid_arg_2." * The following warning is returned if the request passes a custom model that is based on an older version of a base model for which an updated version is available: "Using previous version of base model, because your custom model has been built with it. Please note that this version will be supported only for a limited time. Consider updating your custom model to the new base model. If you do not do that you will be automatically switched to base model when you used the non-updated custom model." In both cases, the request succeeds despite the warnings.

    ","parent_name":"SpeechRecognitionResults"},"Structs/SpeechRecognitionResult.html#/s:14SpeechToTextV10A17RecognitionResultV12finalResultsSbvp":{"name":"finalResults","abstract":"

    An indication of whether the transcription results are final. If true, the results for this utterance are not updated further; no additional results are sent for a result_index once its results are indicated as final.

    ","parent_name":"SpeechRecognitionResult"},"Structs/SpeechRecognitionResult.html#/s:14SpeechToTextV10A17RecognitionResultV12alternativesSayAA0aE11AlternativeVGvp":{"name":"alternatives","abstract":"

    An array of alternative transcripts. The alternatives array can include additional requested output such as word confidence or timestamps.

    ","parent_name":"SpeechRecognitionResult"},"Structs/SpeechRecognitionResult.html#/s:14SpeechToTextV10A17RecognitionResultV08keywordsF0s10DictionaryVySSSayAA07KeywordF0VGGSgvp":{"name":"keywordsResult","abstract":"

    A dictionary (or associative array) whose keys are the strings specified for keywords if both that parameter and keywords_threshold are specified. A keyword for which no matches are found is omitted from the array. The array is omitted if no matches are found for any keywords.

    ","parent_name":"SpeechRecognitionResult"},"Structs/SpeechRecognitionResult.html#/s:14SpeechToTextV10A17RecognitionResultV16wordAlternativesSayAA22WordAlternativeResultsVGSgvp":{"name":"wordAlternatives","abstract":"

    An array of alternative hypotheses found for words of the input audio if a word_alternatives_threshold is specified.

    ","parent_name":"SpeechRecognitionResult"},"Structs/SpeechRecognitionAlternative.html#/s:14SpeechToTextV10A22RecognitionAlternativeV10transcriptSSvp":{"name":"transcript","abstract":"

    A transcription of the audio.

    ","parent_name":"SpeechRecognitionAlternative"},"Structs/SpeechRecognitionAlternative.html#/s:14SpeechToTextV10A22RecognitionAlternativeV10confidenceSdSgvp":{"name":"confidence","abstract":"

    A score that indicates the service’s confidence in the transcript in the range of 0 to 1. Returned only for the best alternative and only with results marked as final.

    ","parent_name":"SpeechRecognitionAlternative"},"Structs/SpeechRecognitionAlternative.html#/s:14SpeechToTextV10A22RecognitionAlternativeV10timestampsSayAA13WordTimestampVGSgvp":{"name":"timestamps","abstract":"

    Time alignments for each word from the transcript as a list of lists. Each inner list consists of three elements: the word followed by its start and end time in seconds. Example: [["hello",0.0,1.2],["world",1.2,2.5]]. Returned only for the best alternative.

    ","parent_name":"SpeechRecognitionAlternative"},"Structs/SpeechRecognitionAlternative.html#/s:14SpeechToTextV10A22RecognitionAlternativeV14wordConfidenceSayAA04WordH0VGSgvp":{"name":"wordConfidence","abstract":"

    A confidence score for each word of the transcript as a list of lists. Each inner list consists of two elements: the word and its confidence score in the range of 0 to 1. Example: [["hello",0.95],["world",0.866]]. Returned only for the best alternative and only with results marked as final.

    ","parent_name":"SpeechRecognitionAlternative"},"Structs/SpeechModels.html#/s:14SpeechToTextV10A6ModelsV6modelsSayAA0A5ModelVGvp":{"name":"models","abstract":"

    Information about each available model.

    ","parent_name":"SpeechModels"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV4nameSSvp":{"name":"name","abstract":"

    The name of the model for use as an identifier in calls to the service (for example, en-US_BroadbandModel).

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV8languageSSvp":{"name":"language","abstract":"

    The language identifier of the model (for example, en-US).

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV4rateSivp":{"name":"rate","abstract":"

    The sampling rate (minimum acceptable rate for audio) used by the model in Hertz.

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV3urlSSvp":{"name":"url","abstract":"

    The URI for the model.

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV17supportedFeaturesAA09SupportedG0Vvp":{"name":"supportedFeatures","abstract":"

    Describes the additional service features supported with the model.

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV11descriptionSSvp":{"name":"description","abstract":"

    Brief description of the model.

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV8sessionsSSSgvp":{"name":"sessions","abstract":"

    The URI for the model for use with the Create a session method. This field is returned only by the Get a model method.

    ","parent_name":"SpeechModel"},"Structs/SpeakerLabelsResult.html#/s:14SpeechToTextV119SpeakerLabelsResultV4fromSdvp":{"name":"from","abstract":"

    The start time of a word from the transcript. The value matches the start time of a word from the timestamps array.

    ","parent_name":"SpeakerLabelsResult"},"Structs/SpeakerLabelsResult.html#/s:14SpeechToTextV119SpeakerLabelsResultV2toSdvp":{"name":"to","abstract":"

    The end time of a word from the transcript. The value matches the end time of a word from the timestamps array.

    ","parent_name":"SpeakerLabelsResult"},"Structs/SpeakerLabelsResult.html#/s:14SpeechToTextV119SpeakerLabelsResultV7speakerSivp":{"name":"speaker","abstract":"

    The numeric identifier that the service assigns to a speaker from the audio. Speaker IDs begin at 0 initially but can evolve and change across interim results (if supported by the method) and between interim and final results as the service processes the audio. They are not guaranteed to be sequential, contiguous, or ordered.

    ","parent_name":"SpeakerLabelsResult"},"Structs/SpeakerLabelsResult.html#/s:14SpeechToTextV119SpeakerLabelsResultV10confidenceSdvp":{"name":"confidence","abstract":"

    A score that indicates the service’s confidence in its identification of the speaker in the range of 0 to 1.

    ","parent_name":"SpeakerLabelsResult"},"Structs/SpeakerLabelsResult.html#/s:14SpeechToTextV119SpeakerLabelsResultV12finalResultsSbvp":{"name":"finalResults","abstract":"

    An indication of whether the service might further change word and speaker-label results. A value of true means that the service guarantees not to send any further updates for the current or any preceding results; false means that the service might send further updates to the results.

    ","parent_name":"SpeakerLabelsResult"},"Structs/RegisterStatus/Status.html#/s:14SpeechToTextV114RegisterStatusV0F0O7createdA2EmF":{"name":"created","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RegisterStatus/Status.html#/s:14SpeechToTextV114RegisterStatusV0F0O14alreadyCreatedA2EmF":{"name":"alreadyCreated","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RegisterStatus/Status.html":{"name":"Status","abstract":"

    The current status of the job: * created if the callback URL was successfully white-listed as a result of the call. * already created if the URL was already white-listed.

    ","parent_name":"RegisterStatus"},"Structs/RegisterStatus.html#/s:14SpeechToTextV114RegisterStatusV6statusSSvp":{"name":"status","abstract":"

    The current status of the job: * created if the callback URL was successfully white-listed as a result of the call. * already created if the URL was already white-listed.

    ","parent_name":"RegisterStatus"},"Structs/RegisterStatus.html#/s:14SpeechToTextV114RegisterStatusV3urlSSvp":{"name":"url","abstract":"

    The callback URL that is successfully registered.

    ","parent_name":"RegisterStatus"},"Structs/RecognitionJobs.html#/s:14SpeechToTextV115RecognitionJobsV12recognitionsSayAA0E3JobVGvp":{"name":"recognitions","abstract":"

    An array of objects that provides the status for each of the user’s current jobs. The array is empty if the user has no current jobs.

    ","parent_name":"RecognitionJobs"},"Structs/RecognitionJob/Status.html#/s:14SpeechToTextV114RecognitionJobV6StatusO7waitingA2EmF":{"name":"waiting","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RecognitionJob/Status.html#/s:14SpeechToTextV114RecognitionJobV6StatusO10processingA2EmF":{"name":"processing","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RecognitionJob/Status.html#/s:14SpeechToTextV114RecognitionJobV6StatusO9completedA2EmF":{"name":"completed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RecognitionJob/Status.html#/s:14SpeechToTextV114RecognitionJobV6StatusO6failedA2EmF":{"name":"failed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RecognitionJob/Status.html":{"name":"Status","abstract":"

    The current status of the job: * waiting: The service is preparing the job for processing. The service returns this status when the job is initially created or when it is waiting for capacity to process the job. The job remains in this state until the service has the capacity to begin processing it. * processing: The service is actively processing the job. * completed: The service has finished processing the job. If the job specified a callback URL and the event recognitions.completed_with_results, the service sent the results with the callback notification; otherwise, you must retrieve the results by checking the individual job. * failed: The job failed.

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV2idSSvp":{"name":"id","abstract":"

    The ID of the asynchronous job.

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV6statusSSvp":{"name":"status","abstract":"

    The current status of the job: * waiting: The service is preparing the job for processing. The service returns this status when the job is initially created or when it is waiting for capacity to process the job. The job remains in this state until the service has the capacity to begin processing it. * processing: The service is actively processing the job. * completed: The service has finished processing the job. If the job specified a callback URL and the event recognitions.completed_with_results, the service sent the results with the callback notification; otherwise, you must retrieve the results by checking the individual job. * failed: The job failed.

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV7createdSSvp":{"name":"created","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the job was created. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV7updatedSSSgvp":{"name":"updated","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the job was last updated by the service. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD). This field is returned only by the Check jobs and Check a job methods.

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV3urlSSSgvp":{"name":"url","abstract":"

    The URL to use to request information about the job with the Check a job method. This field is returned only by the Create a job method.

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV9userTokenSSSgvp":{"name":"userToken","abstract":"

    The user token associated with a job that was created with a callback URL and a user token. This field can be returned only by the Check jobs method.

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV7resultsSayAA0aE7ResultsVGSgvp":{"name":"results","abstract":"

    If the status is completed, the results of the recognition request as an array that includes a single instance of a SpeechRecognitionResults object. This field is returned only by the Check a job method.

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV8warningsSaySSGSgvp":{"name":"warnings","abstract":"

    An array of warning messages about invalid parameters included with the request. Each warning includes a descriptive message and a list of invalid argument strings, for example, "unexpected query parameter 'user_token', query parameter 'callback_url' was not specified". The request succeeds despite the warnings. This field can be returned only by the Create a job method.

    ","parent_name":"RecognitionJob"},"Structs/LanguageModels.html#/s:14SpeechToTextV114LanguageModelsV14customizationsSayAA0E5ModelVGvp":{"name":"customizations","abstract":"

    An array of objects that provides information about each available custom language model. The array is empty if the requesting service credentials own no custom language models (if no language is specified) or own no custom language models for the specified language.

    ","parent_name":"LanguageModels"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO7pendingA2EmF":{"name":"pending","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO5readyA2EmF":{"name":"ready","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO8trainingA2EmF":{"name":"training","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO9availableA2EmF":{"name":"available","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO9upgradingA2EmF":{"name":"upgrading","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO6failedA2EmF":{"name":"failed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html":{"name":"Status","abstract":"

    The current status of the custom language model: * pending indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * ready indicates that the model contains data and is ready to be trained. * training indicates that the model is currently being trained. * available indicates that the model is trained and ready to use. * upgrading indicates that the model is currently being upgraded. * failed indicates that training of the model failed.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV15customizationIDSSvp":{"name":"customizationID","abstract":"

    The customization ID (GUID) of the custom language model. The Create a custom language model method returns only this field of the object; it does not return the other fields.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV7createdSSSgvp":{"name":"created","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the custom language model was created. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV8languageSSSgvp":{"name":"language","abstract":"

    The language identifier of the custom language model (for example, en-US).

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV7dialectSSSgvp":{"name":"dialect","abstract":"

    The dialect of the language for the custom language model. By default, the dialect matches the language of the base model; for example, en-US for either of the US English language models. For Spanish models, the field indicates the dialect for which the model was created: * es-ES for Castilian Spanish (the default) * es-LA for Latin American Spanish * es-US for North American (Mexican) Spanish.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV8versionsSaySSGSgvp":{"name":"versions","abstract":"

    A list of the available versions of the custom language model. Each element of the array indicates a version of the base model with which the custom model can be used. Multiple versions exist only if the custom model has been upgraded; otherwise, only a single version is shown.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV5ownerSSSgvp":{"name":"owner","abstract":"

    The GUID of the service credentials for the instance of the service that owns the custom language model.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV4nameSSSgvp":{"name":"name","abstract":"

    The name of the custom language model.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV11descriptionSSSgvp":{"name":"description","abstract":"

    The description of the custom language model.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV04baseF4NameSSSgvp":{"name":"baseModelName","abstract":"

    The name of the language model for which the custom language model was created.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV6statusSSSgvp":{"name":"status","abstract":"

    The current status of the custom language model: * pending indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * ready indicates that the model contains data and is ready to be trained. * training indicates that the model is currently being trained. * available indicates that the model is trained and ready to use. * upgrading indicates that the model is currently being upgraded. * failed indicates that training of the model failed.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV8progressSiSgvp":{"name":"progress","abstract":"

    A percentage that indicates the progress of the custom language model’s current training. A value of 100 means that the model is fully trained. Note: The progress field does not currently reflect the progress of the training. The field changes from 0 to 100 when training is complete.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV8warningsSSSgvp":{"name":"warnings","abstract":"

    If the request included unknown parameters, the following message: Unexpected query parameter(s) ['parameters'] detected, where parameters is a list that includes a quoted string for each unknown parameter.

    ","parent_name":"LanguageModel"},"Structs/KeywordResult.html#/s:14SpeechToTextV113KeywordResultV010normalizedC0SSvp":{"name":"normalizedText","abstract":"

    A specified keyword normalized to the spoken phrase that matched in the audio input.

    ","parent_name":"KeywordResult"},"Structs/KeywordResult.html#/s:14SpeechToTextV113KeywordResultV9startTimeSdvp":{"name":"startTime","abstract":"

    The start time in seconds of the keyword match.

    ","parent_name":"KeywordResult"},"Structs/KeywordResult.html#/s:14SpeechToTextV113KeywordResultV7endTimeSdvp":{"name":"endTime","abstract":"

    The end time in seconds of the keyword match.

    ","parent_name":"KeywordResult"},"Structs/KeywordResult.html#/s:14SpeechToTextV113KeywordResultV10confidenceSdvp":{"name":"confidence","abstract":"

    A confidence score for the keyword match in the range of 0 to 1.

    ","parent_name":"KeywordResult"},"Structs/CustomWords.html#/s:14SpeechToTextV111CustomWordsV5wordsSayAA0E4WordVGvp":{"name":"words","abstract":"

    An array of objects that provides information about each custom word that is to be added to or updated in the custom language model.

    ","parent_name":"CustomWords"},"Structs/CustomWords.html#/s:14SpeechToTextV111CustomWordsVACSayAA0E4WordVG5words_tcfc":{"name":"init(words:)","abstract":"

    Initialize a CustomWords with member variables.

    ","parent_name":"CustomWords"},"Structs/CustomWord.html#/s:14SpeechToTextV110CustomWordV4wordSSSgvp":{"name":"word","abstract":"

    For the Add custom words method, you must specify the custom word that is to be added to or updated in the custom model. Do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of compound words. Omit this field for the Add a custom word method.

    ","parent_name":"CustomWord"},"Structs/CustomWord.html#/s:14SpeechToTextV110CustomWordV10soundsLikeSaySSGSgvp":{"name":"soundsLike","abstract":"

    An array of sounds-like pronunciations for the custom word. Specify how words that are difficult to pronounce, foreign words, acronyms, and so on can be pronounced by users. For a word that is not in the service’s base vocabulary, omit the parameter to have the service automatically generate a sounds-like pronunciation for the word. For a word that is in the service’s base vocabulary, use the parameter to specify additional pronunciations for the word. You cannot override the default pronunciation of a word; pronunciations you add augment the pronunciation from the base vocabulary. A word can have at most five sounds-like pronunciations, and a pronunciation can include at most 40 characters not including spaces.

    ","parent_name":"CustomWord"},"Structs/CustomWord.html#/s:14SpeechToTextV110CustomWordV9displayAsSSSgvp":{"name":"displayAs","abstract":"

    An alternative spelling for the custom word when it appears in a transcript. Use the parameter when you want the word to have a spelling that is different from its usual representation or from its spelling in corpora training data.

    ","parent_name":"CustomWord"},"Structs/CustomWord.html#/s:14SpeechToTextV110CustomWordVACSSSg4word_SaySSGSg10soundsLikeAD9displayAstcfc":{"name":"init(word:soundsLike:displayAs:)","abstract":"

    Initialize a CustomWord with member variables.

    ","parent_name":"CustomWord"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18enGbBroadbandmodelA2EmF":{"name":"enGbBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO19enGbNarrowbandmodelA2EmF":{"name":"enGbNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18enUsBroadbandmodelA2EmF":{"name":"enUsBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO19enUsNarrowbandmodelA2EmF":{"name":"enUsNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18esEsBroadbandmodelA2EmF":{"name":"esEsBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO19esEsNarrowbandmodelA2EmF":{"name":"esEsNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18frFrBroadbandmodelA2EmF":{"name":"frFrBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18jaJpBroadbandmodelA2EmF":{"name":"jaJpBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO19jaJpNarrowbandmodelA2EmF":{"name":"jaJpNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18koKrBroadbandmodelA2EmF":{"name":"koKrBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO19koKrNarrowbandmodelA2EmF":{"name":"koKrNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html":{"name":"BaseModelName","abstract":"

    The name of the base language model that is to be customized by the new custom language model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports language model customization, request information about the base model and check that the attribute custom_language_model is set to true, or refer to Language support for customization.

    ","parent_name":"CreateLanguageModel"},"Structs/CreateLanguageModel.html#/s:14SpeechToTextV119CreateLanguageModelV4nameSSvp":{"name":"name","abstract":"

    A user-defined name for the new custom language model. Use a name that is unique among all custom language models that you own. Use a localized name that matches the language of the custom model. Use a name that describes the domain of the custom model, such as Medical custom model or Legal custom model.

    ","parent_name":"CreateLanguageModel"},"Structs/CreateLanguageModel.html#/s:14SpeechToTextV119CreateLanguageModelV04baseG4NameSSvp":{"name":"baseModelName","abstract":"

    The name of the base language model that is to be customized by the new custom language model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports language model customization, request information about the base model and check that the attribute custom_language_model is set to true, or refer to Language support for customization.

    ","parent_name":"CreateLanguageModel"},"Structs/CreateLanguageModel.html#/s:14SpeechToTextV119CreateLanguageModelV7dialectSSSgvp":{"name":"dialect","abstract":"

    The dialect of the specified language that is to be used with the custom language model. The parameter is meaningful only for Spanish models, for which the service creates a custom language model that is suited for speech in one of the following dialects: * es-ES for Castilian Spanish (the default) * es-LA for Latin American Spanish * es-US for North American (Mexican) Spanish A specified dialect must be valid for the base model. By default, the dialect matches the language of the base model; for example, en-US for either of the US English language models.

    ","parent_name":"CreateLanguageModel"},"Structs/CreateLanguageModel.html#/s:14SpeechToTextV119CreateLanguageModelV11descriptionSSSgvp":{"name":"description","abstract":"

    A description of the new custom language model. Use a localized description that matches the language of the custom model.

    ","parent_name":"CreateLanguageModel"},"Structs/CreateLanguageModel.html#/s:14SpeechToTextV119CreateLanguageModelVACSS4name_SS04baseG4NameSSSg7dialectAF11descriptiontcfc":{"name":"init(name:baseModelName:dialect:description:)","abstract":"

    Initialize a CreateLanguageModel with member variables.

    ","parent_name":"CreateLanguageModel"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18arArBroadbandmodelA2EmF":{"name":"arArBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18enGbBroadbandmodelA2EmF":{"name":"enGbBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19enGbNarrowbandmodelA2EmF":{"name":"enGbNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18enUsBroadbandmodelA2EmF":{"name":"enUsBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19enUsNarrowbandmodelA2EmF":{"name":"enUsNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18esEsBroadbandmodelA2EmF":{"name":"esEsBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19esEsNarrowbandmodelA2EmF":{"name":"esEsNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18frFrBroadbandmodelA2EmF":{"name":"frFrBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18jaJpBroadbandmodelA2EmF":{"name":"jaJpBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19jaJpNarrowbandmodelA2EmF":{"name":"jaJpNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18koKrBroadbandmodelA2EmF":{"name":"koKrBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19koKrNarrowbandmodelA2EmF":{"name":"koKrNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18ptBrBroadbandmodelA2EmF":{"name":"ptBrBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19ptBrNarrowbandmodelA2EmF":{"name":"ptBrNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18zhCnBroadbandmodelA2EmF":{"name":"zhCnBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19zhCnNarrowbandmodelA2EmF":{"name":"zhCnNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html":{"name":"BaseModelName","abstract":"

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports acoustic model customization, refer to Language support for customization.

    ","parent_name":"CreateAcousticModel"},"Structs/CreateAcousticModel.html#/s:14SpeechToTextV119CreateAcousticModelV4nameSSvp":{"name":"name","abstract":"

    A user-defined name for the new custom acoustic model. Use a name that is unique among all custom acoustic models that you own. Use a localized name that matches the language of the custom model. Use a name that describes the acoustic environment of the custom model, such as Mobile custom model or Noisy car custom model.

    ","parent_name":"CreateAcousticModel"},"Structs/CreateAcousticModel.html#/s:14SpeechToTextV119CreateAcousticModelV04baseG4NameSSvp":{"name":"baseModelName","abstract":"

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports acoustic model customization, refer to Language support for customization.

    ","parent_name":"CreateAcousticModel"},"Structs/CreateAcousticModel.html#/s:14SpeechToTextV119CreateAcousticModelV11descriptionSSSgvp":{"name":"description","abstract":"

    A description of the new custom acoustic model. Use a localized description that matches the language of the custom model.

    ","parent_name":"CreateAcousticModel"},"Structs/CreateAcousticModel.html#/s:14SpeechToTextV119CreateAcousticModelVACSS4name_SS04baseG4NameSSSg11descriptiontcfc":{"name":"init(name:baseModelName:description:)","abstract":"

    Initialize a CreateAcousticModel with member variables.

    ","parent_name":"CreateAcousticModel"},"Structs/Corpus/Status.html#/s:14SpeechToTextV16CorpusV6StatusO8analyzedA2EmF":{"name":"analyzed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Corpus/Status.html#/s:14SpeechToTextV16CorpusV6StatusO14beingProcessedA2EmF":{"name":"beingProcessed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Corpus/Status.html#/s:14SpeechToTextV16CorpusV6StatusO12undeterminedA2EmF":{"name":"undetermined","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Corpus/Status.html":{"name":"Status","abstract":"

    The status of the corpus: * analyzed indicates that the service has successfully analyzed the corpus; the custom model can be trained with data from the corpus. * being_processed indicates that the service is still analyzing the corpus; the service cannot accept requests to add new corpora or words, or to train the custom model. * undetermined indicates that the service encountered an error while processing the corpus.

    ","parent_name":"Corpus"},"Structs/Corpus.html#/s:14SpeechToTextV16CorpusV4nameSSvp":{"name":"name","abstract":"

    The name of the corpus.

    ","parent_name":"Corpus"},"Structs/Corpus.html#/s:14SpeechToTextV16CorpusV10totalWordsSivp":{"name":"totalWords","abstract":"

    The total number of words in the corpus. The value is 0 while the corpus is being processed.

    ","parent_name":"Corpus"},"Structs/Corpus.html#/s:14SpeechToTextV16CorpusV20outOfVocabularyWordsSivp":{"name":"outOfVocabularyWords","abstract":"

    The number of OOV words in the corpus. The value is 0 while the corpus is being processed.

    ","parent_name":"Corpus"},"Structs/Corpus.html#/s:14SpeechToTextV16CorpusV6statusSSvp":{"name":"status","abstract":"

    The status of the corpus: * analyzed indicates that the service has successfully analyzed the corpus; the custom model can be trained with data from the corpus. * being_processed indicates that the service is still analyzing the corpus; the service cannot accept requests to add new corpora or words, or to train the custom model. * undetermined indicates that the service encountered an error while processing the corpus.

    ","parent_name":"Corpus"},"Structs/Corpus.html#/s:14SpeechToTextV16CorpusV5errorSSSgvp":{"name":"error","abstract":"

    If the status of the corpus is undetermined, the following message: Analysis of corpus 'name' failed. Please try adding the corpus again by setting the 'allow_overwrite' flag to 'true'.

    ","parent_name":"Corpus"},"Structs/Corpora.html#/s:14SpeechToTextV17CorporaV7corporaSayAA6CorpusVGvp":{"name":"corpora","abstract":"

    Information about corpora of the custom model. The array is empty if the custom model has no corpora.

    ","parent_name":"Corpora"},"Structs/AudioResources.html#/s:14SpeechToTextV114AudioResourcesV014totalMinutesOfE0Sdvp":{"name":"totalMinutesOfAudio","abstract":"

    The total minutes of accumulated audio summed over all of the valid audio resources for the custom acoustic model. You can use this value to determine whether the custom model has too little or too much audio to begin training.

    ","parent_name":"AudioResources"},"Structs/AudioResources.html#/s:14SpeechToTextV114AudioResourcesV5audioSayAA0E8ResourceVGvp":{"name":"audio","abstract":"

    An array of AudioResource objects that provides information about the audio resources of the custom acoustic model. The array is empty if the custom model has no audio resources.

    ","parent_name":"AudioResources"},"Structs/AudioResource/Status.html#/s:14SpeechToTextV113AudioResourceV6StatusO2okA2EmF":{"name":"ok","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioResource/Status.html#/s:14SpeechToTextV113AudioResourceV6StatusO14beingProcessedA2EmF":{"name":"beingProcessed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioResource/Status.html#/s:14SpeechToTextV113AudioResourceV6StatusO7invalidA2EmF":{"name":"invalid","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioResource/Status.html":{"name":"Status","abstract":"

    The status of the audio resource: * ok indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * being_processed indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * invalid indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if any of its audio files are invalid.

    ","parent_name":"AudioResource"},"Structs/AudioResource.html#/s:14SpeechToTextV113AudioResourceV8durationSdvp":{"name":"duration","abstract":"

    The total seconds of audio in the audio resource.

    ","parent_name":"AudioResource"},"Structs/AudioResource.html#/s:14SpeechToTextV113AudioResourceV4nameSSvp":{"name":"name","abstract":"

    The name of the audio resource.

    ","parent_name":"AudioResource"},"Structs/AudioResource.html#/s:14SpeechToTextV113AudioResourceV7detailsAA0E7DetailsVvp":{"name":"details","abstract":"

    An AudioDetails object that provides detailed information about the audio resource. The object is empty until the service finishes processing the audio.

    ","parent_name":"AudioResource"},"Structs/AudioResource.html#/s:14SpeechToTextV113AudioResourceV6statusSSvp":{"name":"status","abstract":"

    The status of the audio resource: * ok indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * being_processed indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * invalid indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if any of its audio files are invalid.

    ","parent_name":"AudioResource"},"Structs/AudioListing/Status.html#/s:14SpeechToTextV112AudioListingV6StatusO2okA2EmF":{"name":"ok","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioListing/Status.html#/s:14SpeechToTextV112AudioListingV6StatusO14beingProcessedA2EmF":{"name":"beingProcessed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioListing/Status.html#/s:14SpeechToTextV112AudioListingV6StatusO7invalidA2EmF":{"name":"invalid","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioListing/Status.html":{"name":"Status","abstract":"

    For an audio-type resource,** the status of the resource: * ok indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * being_processed indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * invalid indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). Omitted for an archive-type resource.

    ","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV8durationSdSgvp":{"name":"duration","abstract":"

    For an audio-type resource,** the total seconds of audio in the resource. Omitted for an archive-type resource.

    ","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV4nameSSSgvp":{"name":"name","abstract":"

    For an audio-type resource,** the name of the resource. Omitted for an archive-type resource.

    ","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV7detailsAA0E7DetailsVSgvp":{"name":"details","abstract":"

    For an audio-type resource,** an AudioDetails object that provides detailed information about the resource. The object is empty until the service finishes processing the audio. Omitted for an archive-type resource.

    ","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV6statusSSSgvp":{"name":"status","abstract":"

    For an audio-type resource,** the status of the resource: * ok indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * being_processed indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * invalid indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). Omitted for an archive-type resource.

    ","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV9containerAA0E8ResourceVSgvp":{"name":"container","abstract":"

    For an archive-type resource,** an object of type AudioResource that provides information about the resource. Omitted for an audio-type resource.

    ","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV5audioSayAA0E8ResourceVGSgvp":{"name":"audio","abstract":"

    For an archive-type resource,** an array of AudioResource objects that provides information about the audio-type resources that are contained in the resource. Omitted for an audio-type resource.

    ","parent_name":"AudioListing"},"Structs/AudioDetails/Compression.html#/s:14SpeechToTextV112AudioDetailsV11CompressionO3zipA2EmF":{"name":"zip","abstract":"

    Undocumented

    ","parent_name":"Compression"},"Structs/AudioDetails/Compression.html#/s:14SpeechToTextV112AudioDetailsV11CompressionO4gzipA2EmF":{"name":"gzip","abstract":"

    Undocumented

    ","parent_name":"Compression"},"Structs/AudioDetails/ModelType.html#/s:14SpeechToTextV112AudioDetailsV9ModelTypeO5audioA2EmF":{"name":"audio","abstract":"

    Undocumented

    ","parent_name":"ModelType"},"Structs/AudioDetails/ModelType.html#/s:14SpeechToTextV112AudioDetailsV9ModelTypeO7archiveA2EmF":{"name":"archive","abstract":"

    Undocumented

    ","parent_name":"ModelType"},"Structs/AudioDetails/ModelType.html":{"name":"ModelType","abstract":"

    The type of the audio resource: * audio for an individual audio file * archive for an archive (.zip or .tar.gz) file that contains audio files.

    ","parent_name":"AudioDetails"},"Structs/AudioDetails/Compression.html":{"name":"Compression","abstract":"

    For an archive-type resource,** the format of the compressed archive: * zip for a .zip file * gzip for a .tar.gz file Omitted for an audio-type resource.

    ","parent_name":"AudioDetails"},"Structs/AudioDetails.html#/s:14SpeechToTextV112AudioDetailsV4typeSSSgvp":{"name":"type","abstract":"

    The type of the audio resource: * audio for an individual audio file * archive for an archive (.zip or .tar.gz) file that contains audio files.

    ","parent_name":"AudioDetails"},"Structs/AudioDetails.html#/s:14SpeechToTextV112AudioDetailsV5codecSSSgvp":{"name":"codec","abstract":"

    For an audio-type resource,** the codec in which the audio is encoded. Omitted for an archive-type resource.

    ","parent_name":"AudioDetails"},"Structs/AudioDetails.html#/s:14SpeechToTextV112AudioDetailsV9frequencySiSgvp":{"name":"frequency","abstract":"

    For an audio-type resource,** the sampling rate of the audio in Hertz (samples per second). Omitted for an archive-type resource.

    ","parent_name":"AudioDetails"},"Structs/AudioDetails.html#/s:14SpeechToTextV112AudioDetailsV11compressionSSSgvp":{"name":"compression","abstract":"

    For an archive-type resource,** the format of the compressed archive: * zip for a .zip file * gzip for a .tar.gz file Omitted for an audio-type resource.

    ","parent_name":"AudioDetails"},"Structs/AcousticModels.html#/s:14SpeechToTextV114AcousticModelsV14customizationsSayAA0E5ModelVGvp":{"name":"customizations","abstract":"

    An array of objects that provides information about each available custom acoustic model. The array is empty if the requesting service credentials own no custom acoustic models (if no language is specified) or own no custom acoustic models for the specified language.

    ","parent_name":"AcousticModels"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO7pendingA2EmF":{"name":"pending","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO5readyA2EmF":{"name":"ready","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO8trainingA2EmF":{"name":"training","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO9availableA2EmF":{"name":"available","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO9upgradingA2EmF":{"name":"upgrading","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO6failedA2EmF":{"name":"failed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html":{"name":"Status","abstract":"

    The current status of the custom acoustic model: * pending indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * ready indicates that the model contains data and is ready to be trained. * training indicates that the model is currently being trained. * available indicates that the model is trained and ready to use. * upgrading indicates that the model is currently being upgraded. * failed indicates that training of the model failed.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV15customizationIDSSvp":{"name":"customizationID","abstract":"

    The customization ID (GUID) of the custom acoustic model. The Create a custom acoustic model method returns only this field of the object; it does not return the other fields.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV7createdSSSgvp":{"name":"created","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the custom acoustic model was created. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV8languageSSSgvp":{"name":"language","abstract":"

    The language identifier of the custom acoustic model (for example, en-US).

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV8versionsSaySSGSgvp":{"name":"versions","abstract":"

    A list of the available versions of the custom acoustic model. Each element of the array indicates a version of the base model with which the custom model can be used. Multiple versions exist only if the custom model has been upgraded; otherwise, only a single version is shown.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV5ownerSSSgvp":{"name":"owner","abstract":"

    The GUID of the service credentials for the instance of the service that owns the custom acoustic model.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV4nameSSSgvp":{"name":"name","abstract":"

    The name of the custom acoustic model.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV11descriptionSSSgvp":{"name":"description","abstract":"

    The description of the custom acoustic model.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV04baseF4NameSSSgvp":{"name":"baseModelName","abstract":"

    The name of the language model for which the custom acoustic model was created.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV6statusSSSgvp":{"name":"status","abstract":"

    The current status of the custom acoustic model: * pending indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * ready indicates that the model contains data and is ready to be trained. * training indicates that the model is currently being trained. * available indicates that the model is trained and ready to use. * upgrading indicates that the model is currently being upgraded. * failed indicates that training of the model failed.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV8progressSiSgvp":{"name":"progress","abstract":"

    A percentage that indicates the progress of the custom acoustic model’s current training. A value of 100 means that the model is fully trained. Note: The progress field does not currently reflect the progress of the training. The field changes from 0 to 100 when training is complete.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV8warningsSSSgvp":{"name":"warnings","abstract":"

    If the request included unknown parameters, the following message: Unexpected query parameter(s) ['parameters'] detected, where parameters is a list that includes a quoted string for each unknown parameter.

    ","parent_name":"AcousticModel"},"Structs.html#/s:14SpeechToTextV111JSONWrapperV":{"name":"JSONWrapper","abstract":"

    Used internally to serialize and deserialize JSON."},"Structs/AcousticModel.html":{"name":"AcousticModel","abstract":"

    AcousticModel.

    "},"Structs/AcousticModels.html":{"name":"AcousticModels","abstract":"

    AcousticModels.

    "},"Structs/AudioDetails.html":{"name":"AudioDetails","abstract":"

    AudioDetails.

    "},"Structs/AudioListing.html":{"name":"AudioListing","abstract":"

    AudioListing.

    "},"Structs/AudioResource.html":{"name":"AudioResource","abstract":"

    AudioResource.

    "},"Structs/AudioResources.html":{"name":"AudioResources","abstract":"

    AudioResources.

    "},"Structs/Corpora.html":{"name":"Corpora","abstract":"

    Corpora.

    "},"Structs/Corpus.html":{"name":"Corpus","abstract":"

    Corpus.

    "},"Structs/CreateAcousticModel.html":{"name":"CreateAcousticModel","abstract":"

    CreateAcousticModel.

    "},"Structs/CreateLanguageModel.html":{"name":"CreateLanguageModel","abstract":"

    CreateLanguageModel.

    "},"Structs/CustomWord.html":{"name":"CustomWord","abstract":"

    CustomWord.

    "},"Structs/CustomWords.html":{"name":"CustomWords","abstract":"

    CustomWords.

    "},"Structs/KeywordResult.html":{"name":"KeywordResult","abstract":"

    KeywordResult.

    "},"Structs/LanguageModel.html":{"name":"LanguageModel","abstract":"

    LanguageModel.

    "},"Structs/LanguageModels.html":{"name":"LanguageModels","abstract":"

    LanguageModels.

    "},"Structs/RecognitionJob.html":{"name":"RecognitionJob","abstract":"

    RecognitionJob.

    "},"Structs/RecognitionJobs.html":{"name":"RecognitionJobs","abstract":"

    RecognitionJobs.

    "},"Structs/RegisterStatus.html":{"name":"RegisterStatus","abstract":"

    RegisterStatus.

    "},"Structs/SpeakerLabelsResult.html":{"name":"SpeakerLabelsResult","abstract":"

    SpeakerLabelsResult.

    "},"Structs/SpeechModel.html":{"name":"SpeechModel","abstract":"

    SpeechModel.

    "},"Structs/SpeechModels.html":{"name":"SpeechModels","abstract":"

    SpeechModels.

    "},"Structs/SpeechRecognitionAlternative.html":{"name":"SpeechRecognitionAlternative","abstract":"

    SpeechRecognitionAlternative.

    "},"Structs/SpeechRecognitionResult.html":{"name":"SpeechRecognitionResult","abstract":"

    SpeechRecognitionResult.

    "},"Structs/SpeechRecognitionResults.html":{"name":"SpeechRecognitionResults","abstract":"

    SpeechRecognitionResults.

    "},"Structs/SupportedFeatures.html":{"name":"SupportedFeatures","abstract":"

    SupportedFeatures.

    "},"Structs/Word.html":{"name":"Word","abstract":"

    Word.

    "},"Structs/WordAlternativeResult.html":{"name":"WordAlternativeResult","abstract":"

    WordAlternativeResult.

    "},"Structs/WordAlternativeResults.html":{"name":"WordAlternativeResults","abstract":"

    WordAlternativeResults.

    "},"Structs/WordConfidence.html":{"name":"WordConfidence","abstract":"

    The confidence of a word in a Speech to Text transcription.

    "},"Structs/WordError.html":{"name":"WordError","abstract":"

    WordError.

    "},"Structs/WordTimestamp.html":{"name":"WordTimestamp","abstract":"

    The timestamp of a word in a Speech to Text transcription.

    "},"Structs/Words.html":{"name":"Words","abstract":"

    Words.

    "},"Structs/RecognitionSettings.html":{"name":"RecognitionSettings","abstract":"

    The settings associated with a Speech to Text recognition request. Any nil parameters will"},"Structs/SpeechRecognitionResultsAccumulator.html":{"name":"SpeechRecognitionResultsAccumulator","abstract":"

    SpeechRecognitionResultsAccumulator.

    "},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

    No response was received from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

    No data was returned from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO013serializationF0A2CmF":{"name":"serializationError","abstract":"

    Failed to serialize value(s) to data.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO08encodingF0A2CmF":{"name":"encodingError","abstract":"

    Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO011fileManagerF0A2CmF":{"name":"fileManagerError","abstract":"

    FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

    Failed to load the given file.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

    An HTTP error with a status code and description.

    ","parent_name":"RestError"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO4nullA2CmF":{"name":"null","abstract":"

    A null value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

    A boolean value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO6stringACSScACmF":{"name":"string","abstract":"

    A string value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO3intACSicACmF":{"name":"int","abstract":"

    A number value, represented as an integer.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

    A number value, represented as a double.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

    An array value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

    An object value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Decode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

    Initialize a JSON value from an encodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

    Convert this JSON value to a decodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

    Encode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compare two JSON values for equality.

    ","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

    A JSON value (one of string, number, object, array, true, false, or null).

    "},"Enums/RestError.html":{"name":"RestError","abstract":"

    An error from processing a network request or response.

    "},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC10serviceURLSSvp":{"name":"serviceURL","abstract":"

    The base URL of the Speech to Text service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC8tokenURLSSvp":{"name":"tokenURL","abstract":"

    The URL that shall be used to obtain a token.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC13websocketsURLSSvp":{"name":"websocketsURL","abstract":"

    The URL that shall be used to stream audio for transcription.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

    The default HTTP headers for all requests to the service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC7resultsAA0A18RecognitionResultsVvp":{"name":"results","abstract":"

    The results of the most recent recognition request.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC9onConnectyycSgvp":{"name":"onConnect","abstract":"

    Invoked when the session connects to the Speech to Text service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC16onMicrophoneDatay10Foundation0H0VcSgvp":{"name":"onMicrophoneData","abstract":"

    Invoked with microphone audio when a recording audio queue buffer has been filled.","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC11onPowerDataySfcSgvp":{"name":"onPowerData","abstract":"

    Invoked every 0.025s when recording with the average dB power of the microphone.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC9onResultsyAA0a11RecognitionG0VcSgvp":{"name":"onResults","abstract":"

    Invoked when transcription results are received for a recognition request.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC7onErrorys0G0_pcSgvp":{"name":"onError","abstract":"

    Invoked when an error or warning occurs.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC12onDisconnectyycSgvp":{"name":"onDisconnect","abstract":"

    Invoked when the session disconnects from the Speech to Text service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionCACSS8username_SS8passwordSSSg5modelAF15customizationIDSbSg14learningOptOuttcfc":{"name":"init(username:password:model:customizationID:learningOptOut:)","abstract":"

    Create a SpeechToTextSession object.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC7connectyyF":{"name":"connect()","abstract":"

    Connect to the Speech to Text service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC12startRequestyAA19RecognitionSettingsV8settings_tF":{"name":"startRequest(settings:)","abstract":"

    Start a recognition request.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC9recognizey10Foundation3URLV5audio_tF":{"name":"recognize(audio:)","abstract":"

    Send an audio file to transcribe.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC9recognizey10Foundation4DataV5audio_tF":{"name":"recognize(audio:)","abstract":"

    Send audio data to transcribe.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC15startMicrophoneySb8compress_tF":{"name":"startMicrophone(compress:)","abstract":"

    Start streaming microphone audio data to transcribe.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC14stopMicrophoneyyF":{"name":"stopMicrophone()","abstract":"

    Stop streaming microphone audio data to transcribe.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC11stopRequestyyF":{"name":"stopRequest()","abstract":"

    Stop the recognition request.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC10disconnectyyF":{"name":"disconnect()","abstract":"

    Wait for any queued recognition requests to complete then disconnect from the service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

    The base URL to use when contacting the service.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8tokenURLSSvp":{"name":"tokenURL","abstract":"

    The URL that shall be used to obtain a token.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C13websocketsURLSSvp":{"name":"websocketsURL","abstract":"

    The URL that shall be used to stream audio for transcription.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

    The default HTTP headers for all requests to the service.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0CACSS8username_SS8passwordtcfc":{"name":"init(username:password:)","abstract":"

    Create a SpeechToText object.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

    Create a SpeechToText object.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

    Create a SpeechToText object.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

    Undocumented

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C10listModelsys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA0aF0Vc7successtF":{"name":"listModels(headers:failure:success:)","abstract":"

    Get models.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8getModelySS7modelID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0aF0Vc7successtF":{"name":"getModel(modelID:headers:failure:success:)","abstract":"

    Get a model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C20recognizeSessionlessySSSg5model_AE15customizationIDAE021acousticCustomizationI0AE16baseModelVersionSdSg0H6Weight10Foundation4DataVSg5audioAE11contentTypeSiSg17inactivityTimeoutSaySSGSg8keywordsAJ0W9ThresholdAR15maxAlternativesAJ04wordzX0SbSg14wordConfidenceAZ10timestampsAZ15profanityFilterAZ15smartFormattingAZ13speakerLabelss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0A18RecognitionResultsVc7successtF":{"name":"recognizeSessionless(model:customizationID:acousticCustomizationID:baseModelVersion:customizationWeight:audio:contentType:inactivityTimeout:keywords:keywordsThreshold:maxAlternatives:wordAlternativesThreshold:wordConfidence:timestamps:profanityFilter:smartFormatting:speakerLabels:headers:failure:success:)","abstract":"

    Sends audio for speech recognition in sessionless mode.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C16registerCallbackySS11callbackUrl_SSSg10userSecrets10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA14RegisterStatusVc7successtF":{"name":"registerCallback(callbackUrl:userSecret:headers:failure:success:)","abstract":"

    Register a callback.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18unregisterCallbackySS11callbackUrl_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"unregisterCallback(callbackUrl:headers:failure:success:)","abstract":"

    Unregister a callback.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9createJoby10Foundation4DataV5audio_SS11contentTypeSSSg5modelAJ11callbackUrlAJ6eventsAJ9userTokenSiSg10resultsTtlAJ15customizationIDAJ021acousticCustomizationU0AJ16baseModelVersionSdSg0T6WeightAO17inactivityTimeoutSaySSGSg8keywordsAT17keywordsThresholdAO15maxAlternativesAT25wordAlternativesThresholdSbSg14wordConfidenceA1_10timestampsA1_15profanityFilterA1_15smartFormattingA1_13speakerLabelss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA011RecognitionF0Vc7successtF":{"name":"createJob(audio:contentType:model:callbackUrl:events:userToken:resultsTtl:customizationID:acousticCustomizationID:baseModelVersion:customizationWeight:inactivityTimeout:keywords:keywordsThreshold:maxAlternatives:wordAlternativesThreshold:wordConfidence:timestamps:profanityFilter:smartFormatting:speakerLabels:headers:failure:success:)","abstract":"

    Create a job.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9checkJobsys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA011RecognitionF0Vc7successtF":{"name":"checkJobs(headers:failure:success:)","abstract":"

    Check jobs.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8checkJobySS2id_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA011RecognitionF0Vc7successtF":{"name":"checkJob(id:headers:failure:success:)","abstract":"

    Check a job.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9deleteJobySS2id_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteJob(id:headers:failure:success:)","abstract":"

    Delete a job.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C19createLanguageModelyAA06CreatefG0VAD_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"createLanguageModel(createLanguageModel:headers:failure:success:)","abstract":"

    Create a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18listLanguageModelsySSSg8language_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"listLanguageModels(language:headers:failure:success:)","abstract":"

    List custom language models.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C16getLanguageModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"getLanguageModel(customizationID:headers:failure:success:)","abstract":"

    List a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C19deleteLanguageModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteLanguageModel(customizationID:headers:failure:success:)","abstract":"

    Delete a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18trainLanguageModelySS15customizationID_SSSg08wordTypeB3AddSdSg0H6Weights10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"trainLanguageModel(customizationID:wordTypeToAdd:customizationWeight:headers:failure:success:)","abstract":"

    Train a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18resetLanguageModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"resetLanguageModel(customizationID:headers:failure:success:)","abstract":"

    Reset a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C20upgradeLanguageModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"upgradeLanguageModel(customizationID:headers:failure:success:)","abstract":"

    Upgrade a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C11listCorporaySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"listCorpora(customizationID:headers:failure:success:)","abstract":"

    List corpora.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9addCorpusySS15customizationID_SS10corpusName10Foundation3URLV0I4FileSbSg14allowOverwriteSSSg0iM11ContentTypes10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addCorpus(customizationID:corpusName:corpusFile:allowOverwrite:corpusFileContentType:headers:failure:success:)","abstract":"

    Add a corpus.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9getCorpusySS15customizationID_SS10corpusNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"getCorpus(customizationID:corpusName:headers:failure:success:)","abstract":"

    List a corpus.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C12deleteCorpusySS15customizationID_SS10corpusNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteCorpus(customizationID:corpusName:headers:failure:success:)","abstract":"

    Delete a corpus.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9listWordsySS15customizationID_SSSg8wordTypeAF4sorts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"listWords(customizationID:wordType:sort:headers:failure:success:)","abstract":"

    List custom words.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8addWordsySS15customizationID_SayAA10CustomWordVG5wordss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addWords(customizationID:words:headers:failure:success:)","abstract":"

    Add custom words.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C7addWordySS15customizationID_SS8wordNameSSSg0I0SaySSGSg10soundsLikeAG9displayAss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addWord(customizationID:wordName:word:soundsLike:displayAs:headers:failure:success:)","abstract":"

    Add a custom word.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C7getWordySS15customizationID_SS8wordNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"getWord(customizationID:wordName:headers:failure:success:)","abstract":"

    List a custom word.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C10deleteWordySS15customizationID_SS8wordNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteWord(customizationID:wordName:headers:failure:success:)","abstract":"

    Delete a custom word.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C19createAcousticModelySS4name_SS04baseG4NameSSSg11descriptions10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"createAcousticModel(name:baseModelName:description:headers:failure:success:)","abstract":"

    Create a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18listAcousticModelsySSSg8language_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"listAcousticModels(language:headers:failure:success:)","abstract":"

    List custom acoustic models.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C16getAcousticModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"getAcousticModel(customizationID:headers:failure:success:)","abstract":"

    List a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C19deleteAcousticModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteAcousticModel(customizationID:headers:failure:success:)","abstract":"

    Delete a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18trainAcousticModelySS15customizationID_SSSg014customLanguagegI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"trainAcousticModel(customizationID:customLanguageModelID:headers:failure:success:)","abstract":"

    Train a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18resetAcousticModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"resetAcousticModel(customizationID:headers:failure:success:)","abstract":"

    Reset a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C20upgradeAcousticModelySS15customizationID_SSSg014customLanguagegI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"upgradeAcousticModel(customizationID:customLanguageModelID:headers:failure:success:)","abstract":"

    Upgrade a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9listAudioySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F9ResourcesVc7successtF":{"name":"listAudio(customizationID:headers:failure:success:)","abstract":"

    List audio resources.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8addAudioySS15customizationID_SS9audioName10Foundation4DataV0I8ResourceSS11contentTypeSSSg016containedContentO0SbSg14allowOverwrites10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addAudio(customizationID:audioName:audioResource:contentType:containedContentType:allowOverwrite:headers:failure:success:)","abstract":"

    Add an audio resource.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8getAudioySS15customizationID_SS9audioNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F7ListingVc7successtF":{"name":"getAudio(customizationID:audioName:headers:failure:success:)","abstract":"

    List an audio resource.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C11deleteAudioySS15customizationID_SS9audioNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteAudio(customizationID:audioName:headers:failure:success:)","abstract":"

    Delete an audio resource.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

    Delete labeled data.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9recognizey10Foundation3URLV5audio_AA19RecognitionSettingsV8settingsSSSg5modelAL15customizationIDSbSg14learningOptOutys5Error_pcSg7failureyAA0aI7ResultsVc7successtF":{"name":"recognize(audio:settings:model:customizationID:learningOptOut:failure:success:)","abstract":"

    Perform speech recognition for an audio file.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9recognizey10Foundation4DataV5audio_AA19RecognitionSettingsV8settingsSSSg5modelAL15customizationIDSbSg14learningOptOutys5Error_pcSg7failureyAA0aI7ResultsVc7successtF":{"name":"recognize(audio:settings:model:customizationID:learningOptOut:failure:success:)","abstract":"

    Perform speech recognition for audio data.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C19recognizeMicrophoneyAA19RecognitionSettingsV8settings_SSSg5modelAH15customizationIDSbSg14learningOptOutSb8compressys5Error_pcSg7failureyAA0aG7ResultsVc7successtF":{"name":"recognizeMicrophone(settings:model:customizationID:learningOptOut:compress:failure:success:)","abstract":"

    Perform speech recognition for microphone audio. To stop the microphone, invoke","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C23stopRecognizeMicrophoneyyF":{"name":"stopRecognizeMicrophone()","abstract":"

    Stop performing speech recognition for microphone audio.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html":{"name":"SpeechToText","abstract":"

    The IBM® Speech to Text service provides an API that uses IBM’s speech-recognition capabilities to produce"},"Classes/SpeechToTextSession.html":{"name":"SpeechToTextSession","abstract":"

    The IBM Watson Speech to Text service enables you to add speech transcription capabilities to"},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "}} \ No newline at end of file +{"Structs/SpeechRecognitionResultsAccumulator.html#/s:14SpeechToTextV10A29RecognitionResultsAccumulatorV7resultsSayAA0aE6ResultVGvp":{"name":"results","abstract":"

    All accumulated recognition results.

    ","parent_name":"SpeechRecognitionResultsAccumulator"},"Structs/SpeechRecognitionResultsAccumulator.html#/s:14SpeechToTextV10A29RecognitionResultsAccumulatorV13speakerLabelsSayAA07SpeakerI6ResultVGvp":{"name":"speakerLabels","abstract":"

    All accumulated speaker labels.

    ","parent_name":"SpeechRecognitionResultsAccumulator"},"Structs/SpeechRecognitionResultsAccumulator.html#/s:14SpeechToTextV10A29RecognitionResultsAccumulatorV14bestTranscriptSSvp":{"name":"bestTranscript","abstract":"

    A concatenation of transcripts with the greatest confidence.

    ","parent_name":"SpeechRecognitionResultsAccumulator"},"Structs/SpeechRecognitionResultsAccumulator.html#/s:14SpeechToTextV10A29RecognitionResultsAccumulatorVACycfc":{"name":"init()","abstract":"

    Initialize a SpeechRecognitionResultsAccumulator to accumulate recognition results.

    ","parent_name":"SpeechRecognitionResultsAccumulator"},"Structs/SpeechRecognitionResultsAccumulator.html#/s:14SpeechToTextV10A29RecognitionResultsAccumulatorV3addyAA0aeF0V7results_tF":{"name":"add(results:)","abstract":"

    Add recognition results to be accumulated.

    ","parent_name":"SpeechRecognitionResultsAccumulator"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV11contentTypeSSvp":{"name":"contentType","abstract":"

    The format of the audio data. Endianness is automatically detected by the Speech to Text","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV17inactivityTimeoutSiSgvp":{"name":"inactivityTimeout","abstract":"

    The number of seconds after which the connection is to time out due to inactivity.","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV8keywordsSaySSGSgvp":{"name":"keywords","abstract":"

    An array of keyword strings to be matched in the input audio. By default, the service","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV17keywordsThresholdSdSgvp":{"name":"keywordsThreshold","abstract":"

    A minimum level of confidence that the service must have to report a matching keyword","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV15maxAlternativesSiSgvp":{"name":"maxAlternatives","abstract":"

    The maximum number of alternative transcriptions to receive. The default is 1.

    ","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV14interimResultsSbSgvp":{"name":"interimResults","abstract":"

    If true, then interim results (i.e. results that are not final) will be received","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV25wordAlternativesThresholdSdSgvp":{"name":"wordAlternativesThreshold","abstract":"

    A minimum level of confidence that the service must have to report a hypothesis for a","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV14wordConfidenceSbSgvp":{"name":"wordConfidence","abstract":"

    If true, then a confidence score will be received for each word of the transcription.","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV10timestampsSbSgvp":{"name":"timestamps","abstract":"

    If true, then per-word start and end times relative to the beginning of the audio will","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV15filterProfanitySbSgvp":{"name":"filterProfanity","abstract":"

    If true, then profanity will be censored from the service’s output, obscuring each","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV15smartFormattingSbSgvp":{"name":"smartFormatting","abstract":"

    Indicates whether dates, times, series of digits and numbers, phone numbers, currency values,","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV13speakerLabelsSbSgvp":{"name":"speakerLabels","abstract":"

    If true, then speaker labels will be returned for each timestamp. The default is false.

    ","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsVACSS11contentType_tcfc":{"name":"init(contentType:)","abstract":"

    Initialize a RecognitionSettings object to set the parameters of a Watson Speech to","parent_name":"RecognitionSettings"},"Structs/Words.html#/s:14SpeechToTextV15WordsV5wordsSayAA4WordVGvp":{"name":"words","abstract":"

    An array of objects that provides information about each word in the custom model’s words resource. The array is","parent_name":"Words"},"Structs/WordTimestamp.html#/s:14SpeechToTextV113WordTimestampV4wordSSvp":{"name":"word","abstract":"

    A particular word from the transcription.

    ","parent_name":"WordTimestamp"},"Structs/WordTimestamp.html#/s:14SpeechToTextV113WordTimestampV9startTimeSdvp":{"name":"startTime","abstract":"

    The start time, in seconds, of the given word in the audio input.

    ","parent_name":"WordTimestamp"},"Structs/WordTimestamp.html#/s:14SpeechToTextV113WordTimestampV7endTimeSdvp":{"name":"endTime","abstract":"

    The end time, in seconds, of the given word in the audio input.

    ","parent_name":"WordTimestamp"},"Structs/WordTimestamp.html#/s:14SpeechToTextV113WordTimestampVACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Used internally to initialize a WordTimestamp model from JSON.

    ","parent_name":"WordTimestamp"},"Structs/WordError.html#/s:14SpeechToTextV19WordErrorV7elementSSvp":{"name":"element","abstract":"

    A key-value pair that describes an error associated with the definition of a word in the words resource. Each pair","parent_name":"WordError"},"Structs/WordConfidence.html#/s:14SpeechToTextV114WordConfidenceV4wordSSvp":{"name":"word","abstract":"

    A particular word from the transcription.

    ","parent_name":"WordConfidence"},"Structs/WordConfidence.html#/s:14SpeechToTextV114WordConfidenceV10confidenceSdvp":{"name":"confidence","abstract":"

    The confidence of the given word, between 0 and 1.

    ","parent_name":"WordConfidence"},"Structs/WordConfidence.html#/s:14SpeechToTextV114WordConfidenceVACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Used internally to initialize a WordConfidence model from JSON.

    ","parent_name":"WordConfidence"},"Structs/WordAlternativeResults.html#/s:14SpeechToTextV122WordAlternativeResultsV9startTimeSdvp":{"name":"startTime","abstract":"

    The start time in seconds of the word from the input audio that corresponds to the word alternatives.

    ","parent_name":"WordAlternativeResults"},"Structs/WordAlternativeResults.html#/s:14SpeechToTextV122WordAlternativeResultsV7endTimeSdvp":{"name":"endTime","abstract":"

    The end time in seconds of the word from the input audio that corresponds to the word alternatives.

    ","parent_name":"WordAlternativeResults"},"Structs/WordAlternativeResults.html#/s:14SpeechToTextV122WordAlternativeResultsV12alternativesSayAA0eF6ResultVGvp":{"name":"alternatives","abstract":"

    An array of alternative hypotheses for a word from the input audio.

    ","parent_name":"WordAlternativeResults"},"Structs/WordAlternativeResult.html#/s:14SpeechToTextV121WordAlternativeResultV10confidenceSdvp":{"name":"confidence","abstract":"

    A confidence score for the word alternative hypothesis in the range of 0 to 1.

    ","parent_name":"WordAlternativeResult"},"Structs/WordAlternativeResult.html#/s:14SpeechToTextV121WordAlternativeResultV4wordSSvp":{"name":"word","abstract":"

    An alternative hypothesis for a word from the input audio.

    ","parent_name":"WordAlternativeResult"},"Structs/Word.html#/s:14SpeechToTextV14WordV4wordSSvp":{"name":"word","abstract":"

    A word from the custom model’s words resource. The spelling of the word is used to train the model.

    ","parent_name":"Word"},"Structs/Word.html#/s:14SpeechToTextV14WordV10soundsLikeSaySSGvp":{"name":"soundsLike","abstract":"

    An array of pronunciations for the word. The array can include the sounds-like pronunciation automatically","parent_name":"Word"},"Structs/Word.html#/s:14SpeechToTextV14WordV9displayAsSSvp":{"name":"displayAs","abstract":"

    The spelling of the word that the service uses to display the word in a transcript. The field contains an empty","parent_name":"Word"},"Structs/Word.html#/s:14SpeechToTextV14WordV5countSivp":{"name":"count","abstract":"

    A sum of the number of times the word is found across all corpora. For example, if the word occurs five times in","parent_name":"Word"},"Structs/Word.html#/s:14SpeechToTextV14WordV6sourceSaySSGvp":{"name":"source","abstract":"

    An array of sources that describes how the word was added to the custom model’s words resource. For OOV words added","parent_name":"Word"},"Structs/Word.html#/s:14SpeechToTextV14WordV5errorSayAA0E5ErrorVGSgvp":{"name":"error","abstract":"

    If the service discovered one or more problems that you need to correct for the word’s definition, an array that","parent_name":"Word"},"Structs/SupportedFeatures.html#/s:14SpeechToTextV117SupportedFeaturesV19customLanguageModelSbvp":{"name":"customLanguageModel","abstract":"

    Indicates whether the customization interface can be used to create a custom language model based on the language","parent_name":"SupportedFeatures"},"Structs/SupportedFeatures.html#/s:14SpeechToTextV117SupportedFeaturesV13speakerLabelsSbvp":{"name":"speakerLabels","abstract":"

    Indicates whether the speaker_labels parameter can be used with the language model.

    ","parent_name":"SupportedFeatures"},"Structs/SpeechRecognitionResults.html#/s:14SpeechToTextV10A18RecognitionResultsV7resultsSayAA0aE6ResultVGSgvp":{"name":"results","abstract":"

    An array that can include interim and final results (interim results are returned only if supported by the method).","parent_name":"SpeechRecognitionResults"},"Structs/SpeechRecognitionResults.html#/s:14SpeechToTextV10A18RecognitionResultsV11resultIndexSiSgvp":{"name":"resultIndex","abstract":"

    An index that indicates a change point in the results array. The service increments the index only for additional","parent_name":"SpeechRecognitionResults"},"Structs/SpeechRecognitionResults.html#/s:14SpeechToTextV10A18RecognitionResultsV13speakerLabelsSayAA07SpeakerH6ResultVGSgvp":{"name":"speakerLabels","abstract":"

    An array that identifies which words were spoken by which speakers in a multi-person exchange. Returned in the","parent_name":"SpeechRecognitionResults"},"Structs/SpeechRecognitionResults.html#/s:14SpeechToTextV10A18RecognitionResultsV8warningsSaySSGSgvp":{"name":"warnings","abstract":"

    An array of warning messages associated with the request:

    ","parent_name":"SpeechRecognitionResults"},"Structs/SpeechRecognitionResult.html#/s:14SpeechToTextV10A17RecognitionResultV12finalResultsSbvp":{"name":"finalResults","abstract":"

    An indication of whether the transcription results are final. If true, the results for this utterance are not","parent_name":"SpeechRecognitionResult"},"Structs/SpeechRecognitionResult.html#/s:14SpeechToTextV10A17RecognitionResultV12alternativesSayAA0aE11AlternativeVGvp":{"name":"alternatives","abstract":"

    An array of alternative transcripts. The alternatives array can include additional requested output such as word","parent_name":"SpeechRecognitionResult"},"Structs/SpeechRecognitionResult.html#/s:14SpeechToTextV10A17RecognitionResultV08keywordsF0s10DictionaryVySSSayAA07KeywordF0VGGSgvp":{"name":"keywordsResult","abstract":"

    A dictionary (or associative array) whose keys are the strings specified for keywords if both that parameter and","parent_name":"SpeechRecognitionResult"},"Structs/SpeechRecognitionResult.html#/s:14SpeechToTextV10A17RecognitionResultV16wordAlternativesSayAA22WordAlternativeResultsVGSgvp":{"name":"wordAlternatives","abstract":"

    An array of alternative hypotheses found for words of the input audio if a word_alternatives_threshold is","parent_name":"SpeechRecognitionResult"},"Structs/SpeechRecognitionAlternative.html#/s:14SpeechToTextV10A22RecognitionAlternativeV10transcriptSSvp":{"name":"transcript","abstract":"

    A transcription of the audio.

    ","parent_name":"SpeechRecognitionAlternative"},"Structs/SpeechRecognitionAlternative.html#/s:14SpeechToTextV10A22RecognitionAlternativeV10confidenceSdSgvp":{"name":"confidence","abstract":"

    A score that indicates the service’s confidence in the transcript in the range of 0 to 1. Returned only for the","parent_name":"SpeechRecognitionAlternative"},"Structs/SpeechRecognitionAlternative.html#/s:14SpeechToTextV10A22RecognitionAlternativeV10timestampsSayAA13WordTimestampVGSgvp":{"name":"timestamps","abstract":"

    Time alignments for each word from the transcript as a list of lists. Each inner list consists of three elements:","parent_name":"SpeechRecognitionAlternative"},"Structs/SpeechRecognitionAlternative.html#/s:14SpeechToTextV10A22RecognitionAlternativeV14wordConfidenceSayAA04WordH0VGSgvp":{"name":"wordConfidence","abstract":"

    A confidence score for each word of the transcript as a list of lists. Each inner list consists of two elements:","parent_name":"SpeechRecognitionAlternative"},"Structs/SpeechModels.html#/s:14SpeechToTextV10A6ModelsV6modelsSayAA0A5ModelVGvp":{"name":"models","abstract":"

    An array of objects that provides information about each available model.

    ","parent_name":"SpeechModels"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV4nameSSvp":{"name":"name","abstract":"

    The name of the model for use as an identifier in calls to the service (for example, en-US_BroadbandModel).

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV8languageSSvp":{"name":"language","abstract":"

    The language identifier of the model (for example, en-US).

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV4rateSivp":{"name":"rate","abstract":"

    The sampling rate (minimum acceptable rate for audio) used by the model in Hertz.

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV3urlSSvp":{"name":"url","abstract":"

    The URI for the model.

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV17supportedFeaturesAA09SupportedG0Vvp":{"name":"supportedFeatures","abstract":"

    Describes the additional service features supported with the model.

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV11descriptionSSvp":{"name":"description","abstract":"

    Brief description of the model.

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV8sessionsSSSgvp":{"name":"sessions","abstract":"

    The URI for the model for use with the Create a session method. This field is returned only by the Get a","parent_name":"SpeechModel"},"Structs/SpeakerLabelsResult.html#/s:14SpeechToTextV119SpeakerLabelsResultV4fromSdvp":{"name":"from","abstract":"

    The start time of a word from the transcript. The value matches the start time of a word from the timestamps","parent_name":"SpeakerLabelsResult"},"Structs/SpeakerLabelsResult.html#/s:14SpeechToTextV119SpeakerLabelsResultV2toSdvp":{"name":"to","abstract":"

    The end time of a word from the transcript. The value matches the end time of a word from the timestamps array.

    ","parent_name":"SpeakerLabelsResult"},"Structs/SpeakerLabelsResult.html#/s:14SpeechToTextV119SpeakerLabelsResultV7speakerSivp":{"name":"speaker","abstract":"

    The numeric identifier that the service assigns to a speaker from the audio. Speaker IDs begin at 0 initially but","parent_name":"SpeakerLabelsResult"},"Structs/SpeakerLabelsResult.html#/s:14SpeechToTextV119SpeakerLabelsResultV10confidenceSdvp":{"name":"confidence","abstract":"

    A score that indicates the service’s confidence in its identification of the speaker in the range of 0 to 1.

    ","parent_name":"SpeakerLabelsResult"},"Structs/SpeakerLabelsResult.html#/s:14SpeechToTextV119SpeakerLabelsResultV12finalResultsSbvp":{"name":"finalResults","abstract":"

    An indication of whether the service might further change word and speaker-label results. A value of true means","parent_name":"SpeakerLabelsResult"},"Structs/RegisterStatus/Status.html#/s:14SpeechToTextV114RegisterStatusV0F0O7createdA2EmF":{"name":"created","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RegisterStatus/Status.html#/s:14SpeechToTextV114RegisterStatusV0F0O14alreadyCreatedA2EmF":{"name":"alreadyCreated","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RegisterStatus/Status.html":{"name":"Status","abstract":"

    The current status of the job:

    ","parent_name":"RegisterStatus"},"Structs/RegisterStatus.html#/s:14SpeechToTextV114RegisterStatusV6statusSSvp":{"name":"status","abstract":"

    The current status of the job:

    ","parent_name":"RegisterStatus"},"Structs/RegisterStatus.html#/s:14SpeechToTextV114RegisterStatusV3urlSSvp":{"name":"url","abstract":"

    The callback URL that is successfully registered.

    ","parent_name":"RegisterStatus"},"Structs/RecognitionJobs.html#/s:14SpeechToTextV115RecognitionJobsV12recognitionsSayAA0E3JobVGvp":{"name":"recognitions","abstract":"

    An array of objects that provides the status for each of the user’s current jobs. The array is empty if the user","parent_name":"RecognitionJobs"},"Structs/RecognitionJob/Status.html#/s:14SpeechToTextV114RecognitionJobV6StatusO7waitingA2EmF":{"name":"waiting","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RecognitionJob/Status.html#/s:14SpeechToTextV114RecognitionJobV6StatusO10processingA2EmF":{"name":"processing","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RecognitionJob/Status.html#/s:14SpeechToTextV114RecognitionJobV6StatusO9completedA2EmF":{"name":"completed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RecognitionJob/Status.html#/s:14SpeechToTextV114RecognitionJobV6StatusO6failedA2EmF":{"name":"failed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RecognitionJob/Status.html":{"name":"Status","abstract":"

    The current status of the job:

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV2idSSvp":{"name":"id","abstract":"

    The ID of the asynchronous job.

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV6statusSSvp":{"name":"status","abstract":"

    The current status of the job:

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV7createdSSvp":{"name":"created","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the job was created. The value is provided in full","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV7updatedSSSgvp":{"name":"updated","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the job was last updated by the service. The value","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV3urlSSSgvp":{"name":"url","abstract":"

    The URL to use to request information about the job with the Check a job method. This field is returned only by","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV9userTokenSSSgvp":{"name":"userToken","abstract":"

    The user token associated with a job that was created with a callback URL and a user token. This field can be","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV7resultsSayAA0aE7ResultsVGSgvp":{"name":"results","abstract":"

    If the status is completed, the results of the recognition request as an array that includes a single instance of","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV8warningsSaySSGSgvp":{"name":"warnings","abstract":"

    An array of warning messages about invalid parameters included with the request. Each warning includes a","parent_name":"RecognitionJob"},"Structs/LanguageModels.html#/s:14SpeechToTextV114LanguageModelsV14customizationsSayAA0E5ModelVGvp":{"name":"customizations","abstract":"

    An array of objects that provides information about each available custom language model. The array is empty if the","parent_name":"LanguageModels"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO7pendingA2EmF":{"name":"pending","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO5readyA2EmF":{"name":"ready","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO8trainingA2EmF":{"name":"training","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO9availableA2EmF":{"name":"available","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO9upgradingA2EmF":{"name":"upgrading","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO6failedA2EmF":{"name":"failed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html":{"name":"Status","abstract":"

    The current status of the custom language model:

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV15customizationIDSSvp":{"name":"customizationID","abstract":"

    The customization ID (GUID) of the custom language model. The Create a custom language model method returns","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV7createdSSSgvp":{"name":"created","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the custom language model was created. The value is","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV8languageSSSgvp":{"name":"language","abstract":"

    The language identifier of the custom language model (for example, en-US).

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV7dialectSSSgvp":{"name":"dialect","abstract":"

    The dialect of the language for the custom language model. By default, the dialect matches the language of the base","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV8versionsSaySSGSgvp":{"name":"versions","abstract":"

    A list of the available versions of the custom language model. Each element of the array indicates a version of the","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV5ownerSSSgvp":{"name":"owner","abstract":"

    The GUID of the service credentials for the instance of the service that owns the custom language model.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV4nameSSSgvp":{"name":"name","abstract":"

    The name of the custom language model.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV11descriptionSSSgvp":{"name":"description","abstract":"

    The description of the custom language model.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV04baseF4NameSSSgvp":{"name":"baseModelName","abstract":"

    The name of the language model for which the custom language model was created.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV6statusSSSgvp":{"name":"status","abstract":"

    The current status of the custom language model:

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV8progressSiSgvp":{"name":"progress","abstract":"

    A percentage that indicates the progress of the custom language model’s current training. A value of 100 means","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV8warningsSSSgvp":{"name":"warnings","abstract":"

    If the request included unknown parameters, the following message: Unexpected query parameter(s) ['parameters']","parent_name":"LanguageModel"},"Structs/KeywordResult.html#/s:14SpeechToTextV113KeywordResultV010normalizedC0SSvp":{"name":"normalizedText","abstract":"

    A specified keyword normalized to the spoken phrase that matched in the audio input.

    ","parent_name":"KeywordResult"},"Structs/KeywordResult.html#/s:14SpeechToTextV113KeywordResultV9startTimeSdvp":{"name":"startTime","abstract":"

    The start time in seconds of the keyword match.

    ","parent_name":"KeywordResult"},"Structs/KeywordResult.html#/s:14SpeechToTextV113KeywordResultV7endTimeSdvp":{"name":"endTime","abstract":"

    The end time in seconds of the keyword match.

    ","parent_name":"KeywordResult"},"Structs/KeywordResult.html#/s:14SpeechToTextV113KeywordResultV10confidenceSdvp":{"name":"confidence","abstract":"

    A confidence score for the keyword match in the range of 0 to 1.

    ","parent_name":"KeywordResult"},"Structs/CustomWords.html#/s:14SpeechToTextV111CustomWordsV5wordsSayAA0E4WordVGvp":{"name":"words","abstract":"

    An array of objects that provides information about each custom word that is to be added to or updated in the","parent_name":"CustomWords"},"Structs/CustomWords.html#/s:14SpeechToTextV111CustomWordsVACSayAA0E4WordVG5words_tcfc":{"name":"init(words:)","abstract":"

    Initialize a CustomWords with member variables.

    ","parent_name":"CustomWords"},"Structs/CustomWord.html#/s:14SpeechToTextV110CustomWordV4wordSSSgvp":{"name":"word","abstract":"

    For the Add custom words method, you must specify the custom word that is to be added to or updated in the","parent_name":"CustomWord"},"Structs/CustomWord.html#/s:14SpeechToTextV110CustomWordV10soundsLikeSaySSGSgvp":{"name":"soundsLike","abstract":"

    An array of sounds-like pronunciations for the custom word. Specify how words that are difficult to pronounce,","parent_name":"CustomWord"},"Structs/CustomWord.html#/s:14SpeechToTextV110CustomWordV9displayAsSSSgvp":{"name":"displayAs","abstract":"

    An alternative spelling for the custom word when it appears in a transcript. Use the parameter when you want the","parent_name":"CustomWord"},"Structs/CustomWord.html#/s:14SpeechToTextV110CustomWordVACSSSg4word_SaySSGSg10soundsLikeAD9displayAstcfc":{"name":"init(word:soundsLike:displayAs:)","abstract":"

    Initialize a CustomWord with member variables.

    ","parent_name":"CustomWord"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18enGbBroadbandmodelA2EmF":{"name":"enGbBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO19enGbNarrowbandmodelA2EmF":{"name":"enGbNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18enUsBroadbandmodelA2EmF":{"name":"enUsBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO19enUsNarrowbandmodelA2EmF":{"name":"enUsNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18esEsBroadbandmodelA2EmF":{"name":"esEsBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO19esEsNarrowbandmodelA2EmF":{"name":"esEsNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18frFrBroadbandmodelA2EmF":{"name":"frFrBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18jaJpBroadbandmodelA2EmF":{"name":"jaJpBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO19jaJpNarrowbandmodelA2EmF":{"name":"jaJpNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18koKrBroadbandmodelA2EmF":{"name":"koKrBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO19koKrNarrowbandmodelA2EmF":{"name":"koKrNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html":{"name":"BaseModelName","abstract":"

    The name of the base language model that is to be customized by the new custom language model. The new custom model","parent_name":"CreateLanguageModel"},"Structs/CreateLanguageModel.html#/s:14SpeechToTextV119CreateLanguageModelV4nameSSvp":{"name":"name","abstract":"

    A user-defined name for the new custom language model. Use a name that is unique among all custom language models","parent_name":"CreateLanguageModel"},"Structs/CreateLanguageModel.html#/s:14SpeechToTextV119CreateLanguageModelV04baseG4NameSSvp":{"name":"baseModelName","abstract":"

    The name of the base language model that is to be customized by the new custom language model. The new custom model","parent_name":"CreateLanguageModel"},"Structs/CreateLanguageModel.html#/s:14SpeechToTextV119CreateLanguageModelV7dialectSSSgvp":{"name":"dialect","abstract":"

    The dialect of the specified language that is to be used with the custom language model. The parameter is","parent_name":"CreateLanguageModel"},"Structs/CreateLanguageModel.html#/s:14SpeechToTextV119CreateLanguageModelV11descriptionSSSgvp":{"name":"description","abstract":"

    A description of the new custom language model. Use a localized description that matches the language of the custom","parent_name":"CreateLanguageModel"},"Structs/CreateLanguageModel.html#/s:14SpeechToTextV119CreateLanguageModelVACSS4name_SS04baseG4NameSSSg7dialectAF11descriptiontcfc":{"name":"init(name:baseModelName:dialect:description:)","abstract":"

    Initialize a CreateLanguageModel with member variables.

    ","parent_name":"CreateLanguageModel"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18arArBroadbandmodelA2EmF":{"name":"arArBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18enGbBroadbandmodelA2EmF":{"name":"enGbBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19enGbNarrowbandmodelA2EmF":{"name":"enGbNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18enUsBroadbandmodelA2EmF":{"name":"enUsBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19enUsNarrowbandmodelA2EmF":{"name":"enUsNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18esEsBroadbandmodelA2EmF":{"name":"esEsBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19esEsNarrowbandmodelA2EmF":{"name":"esEsNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18frFrBroadbandmodelA2EmF":{"name":"frFrBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18jaJpBroadbandmodelA2EmF":{"name":"jaJpBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19jaJpNarrowbandmodelA2EmF":{"name":"jaJpNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18koKrBroadbandmodelA2EmF":{"name":"koKrBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19koKrNarrowbandmodelA2EmF":{"name":"koKrNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18ptBrBroadbandmodelA2EmF":{"name":"ptBrBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19ptBrNarrowbandmodelA2EmF":{"name":"ptBrNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18zhCnBroadbandmodelA2EmF":{"name":"zhCnBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19zhCnNarrowbandmodelA2EmF":{"name":"zhCnNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html":{"name":"BaseModelName","abstract":"

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model","parent_name":"CreateAcousticModel"},"Structs/CreateAcousticModel.html#/s:14SpeechToTextV119CreateAcousticModelV4nameSSvp":{"name":"name","abstract":"

    A user-defined name for the new custom acoustic model. Use a name that is unique among all custom acoustic models","parent_name":"CreateAcousticModel"},"Structs/CreateAcousticModel.html#/s:14SpeechToTextV119CreateAcousticModelV04baseG4NameSSvp":{"name":"baseModelName","abstract":"

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model","parent_name":"CreateAcousticModel"},"Structs/CreateAcousticModel.html#/s:14SpeechToTextV119CreateAcousticModelV11descriptionSSSgvp":{"name":"description","abstract":"

    A description of the new custom acoustic model. Use a localized description that matches the language of the custom","parent_name":"CreateAcousticModel"},"Structs/CreateAcousticModel.html#/s:14SpeechToTextV119CreateAcousticModelVACSS4name_SS04baseG4NameSSSg11descriptiontcfc":{"name":"init(name:baseModelName:description:)","abstract":"

    Initialize a CreateAcousticModel with member variables.

    ","parent_name":"CreateAcousticModel"},"Structs/Corpus/Status.html#/s:14SpeechToTextV16CorpusV6StatusO8analyzedA2EmF":{"name":"analyzed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Corpus/Status.html#/s:14SpeechToTextV16CorpusV6StatusO14beingProcessedA2EmF":{"name":"beingProcessed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Corpus/Status.html#/s:14SpeechToTextV16CorpusV6StatusO12undeterminedA2EmF":{"name":"undetermined","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Corpus/Status.html":{"name":"Status","abstract":"

    The status of the corpus:

    ","parent_name":"Corpus"},"Structs/Corpus.html#/s:14SpeechToTextV16CorpusV4nameSSvp":{"name":"name","abstract":"

    The name of the corpus.

    ","parent_name":"Corpus"},"Structs/Corpus.html#/s:14SpeechToTextV16CorpusV10totalWordsSivp":{"name":"totalWords","abstract":"

    The total number of words in the corpus. The value is 0 while the corpus is being processed.

    ","parent_name":"Corpus"},"Structs/Corpus.html#/s:14SpeechToTextV16CorpusV20outOfVocabularyWordsSivp":{"name":"outOfVocabularyWords","abstract":"

    The number of OOV words in the corpus. The value is 0 while the corpus is being processed.

    ","parent_name":"Corpus"},"Structs/Corpus.html#/s:14SpeechToTextV16CorpusV6statusSSvp":{"name":"status","abstract":"

    The status of the corpus:

    ","parent_name":"Corpus"},"Structs/Corpus.html#/s:14SpeechToTextV16CorpusV5errorSSSgvp":{"name":"error","abstract":"

    If the status of the corpus is undetermined, the following message: Analysis of corpus 'name' failed. Please try","parent_name":"Corpus"},"Structs/Corpora.html#/s:14SpeechToTextV17CorporaV7corporaSayAA6CorpusVGvp":{"name":"corpora","abstract":"

    An array of objects that provides information about the corpora for the custom model. The array is empty if the","parent_name":"Corpora"},"Structs/AudioResources.html#/s:14SpeechToTextV114AudioResourcesV014totalMinutesOfE0Sdvp":{"name":"totalMinutesOfAudio","abstract":"

    The total minutes of accumulated audio summed over all of the valid audio resources for the custom acoustic model.","parent_name":"AudioResources"},"Structs/AudioResources.html#/s:14SpeechToTextV114AudioResourcesV5audioSayAA0E8ResourceVGvp":{"name":"audio","abstract":"

    An array of objects that provides information about the audio resources of the custom acoustic model. The array is","parent_name":"AudioResources"},"Structs/AudioResource/Status.html#/s:14SpeechToTextV113AudioResourceV6StatusO2okA2EmF":{"name":"ok","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioResource/Status.html#/s:14SpeechToTextV113AudioResourceV6StatusO14beingProcessedA2EmF":{"name":"beingProcessed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioResource/Status.html#/s:14SpeechToTextV113AudioResourceV6StatusO7invalidA2EmF":{"name":"invalid","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioResource/Status.html":{"name":"Status","abstract":"

    The status of the audio resource:

    ","parent_name":"AudioResource"},"Structs/AudioResource.html#/s:14SpeechToTextV113AudioResourceV8durationSdvp":{"name":"duration","abstract":"

    The total seconds of audio in the audio resource. The value is always a whole number.

    ","parent_name":"AudioResource"},"Structs/AudioResource.html#/s:14SpeechToTextV113AudioResourceV4nameSSvp":{"name":"name","abstract":"

    For an archive-type resource, the user-specified name of the resource.","parent_name":"AudioResource"},"Structs/AudioResource.html#/s:14SpeechToTextV113AudioResourceV7detailsAA0E7DetailsVvp":{"name":"details","abstract":"

    An AudioDetails object that provides detailed information about the audio resource. The object is empty until the","parent_name":"AudioResource"},"Structs/AudioResource.html#/s:14SpeechToTextV113AudioResourceV6statusSSvp":{"name":"status","abstract":"

    The status of the audio resource:

    ","parent_name":"AudioResource"},"Structs/AudioListing/Status.html#/s:14SpeechToTextV112AudioListingV6StatusO2okA2EmF":{"name":"ok","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioListing/Status.html#/s:14SpeechToTextV112AudioListingV6StatusO14beingProcessedA2EmF":{"name":"beingProcessed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioListing/Status.html#/s:14SpeechToTextV112AudioListingV6StatusO7invalidA2EmF":{"name":"invalid","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioListing/Status.html":{"name":"Status","abstract":"

    For an audio-type resource, the status of the resource:

    ","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV8durationSdSgvp":{"name":"duration","abstract":"

    For an audio-type resource, the total seconds of audio in the resource. The value is always a whole number.","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV4nameSSSgvp":{"name":"name","abstract":"

    For an audio-type resource,** the user-specified name of the resource. Omitted for an archive-type resource.

    ","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV7detailsAA0E7DetailsVSgvp":{"name":"details","abstract":"

    For an audio-type resource, an AudioDetails object that provides detailed information about the resource. The","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV6statusSSSgvp":{"name":"status","abstract":"

    For an audio-type resource, the status of the resource:

    ","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV9containerAA0E8ResourceVSgvp":{"name":"container","abstract":"

    For an archive-type resource, an object of type AudioResource that provides information about the resource.","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV5audioSayAA0E8ResourceVGSgvp":{"name":"audio","abstract":"

    For an archive-type resource, an array of AudioResource objects that provides information about the","parent_name":"AudioListing"},"Structs/AudioDetails/Compression.html#/s:14SpeechToTextV112AudioDetailsV11CompressionO3zipA2EmF":{"name":"zip","abstract":"

    Undocumented

    ","parent_name":"Compression"},"Structs/AudioDetails/Compression.html#/s:14SpeechToTextV112AudioDetailsV11CompressionO4gzipA2EmF":{"name":"gzip","abstract":"

    Undocumented

    ","parent_name":"Compression"},"Structs/AudioDetails/ModelType.html#/s:14SpeechToTextV112AudioDetailsV9ModelTypeO5audioA2EmF":{"name":"audio","abstract":"

    Undocumented

    ","parent_name":"ModelType"},"Structs/AudioDetails/ModelType.html#/s:14SpeechToTextV112AudioDetailsV9ModelTypeO7archiveA2EmF":{"name":"archive","abstract":"

    Undocumented

    ","parent_name":"ModelType"},"Structs/AudioDetails/ModelType.html#/s:14SpeechToTextV112AudioDetailsV9ModelTypeO12undeterminedA2EmF":{"name":"undetermined","abstract":"

    Undocumented

    ","parent_name":"ModelType"},"Structs/AudioDetails/ModelType.html":{"name":"ModelType","abstract":"

    The type of the audio resource:

    ","parent_name":"AudioDetails"},"Structs/AudioDetails/Compression.html":{"name":"Compression","abstract":"

    For an archive-type resource, the format of the compressed archive:

    ","parent_name":"AudioDetails"},"Structs/AudioDetails.html#/s:14SpeechToTextV112AudioDetailsV4typeSSSgvp":{"name":"type","abstract":"

    The type of the audio resource:

    ","parent_name":"AudioDetails"},"Structs/AudioDetails.html#/s:14SpeechToTextV112AudioDetailsV5codecSSSgvp":{"name":"codec","abstract":"

    For an audio-type resource,** the codec in which the audio is encoded. Omitted for an archive-type resource.

    ","parent_name":"AudioDetails"},"Structs/AudioDetails.html#/s:14SpeechToTextV112AudioDetailsV9frequencySiSgvp":{"name":"frequency","abstract":"

    For an audio-type resource, the sampling rate of the audio in Hertz (samples per second). Omitted for an","parent_name":"AudioDetails"},"Structs/AudioDetails.html#/s:14SpeechToTextV112AudioDetailsV11compressionSSSgvp":{"name":"compression","abstract":"

    For an archive-type resource, the format of the compressed archive:

    ","parent_name":"AudioDetails"},"Structs/AcousticModels.html#/s:14SpeechToTextV114AcousticModelsV14customizationsSayAA0E5ModelVGvp":{"name":"customizations","abstract":"

    An array of objects that provides information about each available custom acoustic model. The array is empty if the","parent_name":"AcousticModels"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO7pendingA2EmF":{"name":"pending","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO5readyA2EmF":{"name":"ready","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO8trainingA2EmF":{"name":"training","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO9availableA2EmF":{"name":"available","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO9upgradingA2EmF":{"name":"upgrading","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO6failedA2EmF":{"name":"failed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html":{"name":"Status","abstract":"

    The current status of the custom acoustic model:

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV15customizationIDSSvp":{"name":"customizationID","abstract":"

    The customization ID (GUID) of the custom acoustic model. The Create a custom acoustic model method returns","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV7createdSSSgvp":{"name":"created","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the custom acoustic model was created. The value is","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV8languageSSSgvp":{"name":"language","abstract":"

    The language identifier of the custom acoustic model (for example, en-US).

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV8versionsSaySSGSgvp":{"name":"versions","abstract":"

    A list of the available versions of the custom acoustic model. Each element of the array indicates a version of the","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV5ownerSSSgvp":{"name":"owner","abstract":"

    The GUID of the service credentials for the instance of the service that owns the custom acoustic model.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV4nameSSSgvp":{"name":"name","abstract":"

    The name of the custom acoustic model.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV11descriptionSSSgvp":{"name":"description","abstract":"

    The description of the custom acoustic model.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV04baseF4NameSSSgvp":{"name":"baseModelName","abstract":"

    The name of the language model for which the custom acoustic model was created.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV6statusSSSgvp":{"name":"status","abstract":"

    The current status of the custom acoustic model:

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV8progressSiSgvp":{"name":"progress","abstract":"

    A percentage that indicates the progress of the custom acoustic model’s current training. A value of 100 means","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV8warningsSSSgvp":{"name":"warnings","abstract":"

    If the request included unknown parameters, the following message: Unexpected query parameter(s) ['parameters']","parent_name":"AcousticModel"},"Structs/AcousticModel.html":{"name":"AcousticModel","abstract":"

    AcousticModel.

    "},"Structs/AcousticModels.html":{"name":"AcousticModels","abstract":"

    AcousticModels.

    "},"Structs/AudioDetails.html":{"name":"AudioDetails","abstract":"

    AudioDetails.

    "},"Structs/AudioListing.html":{"name":"AudioListing","abstract":"

    AudioListing.

    "},"Structs/AudioResource.html":{"name":"AudioResource","abstract":"

    AudioResource.

    "},"Structs/AudioResources.html":{"name":"AudioResources","abstract":"

    AudioResources.

    "},"Structs/Corpora.html":{"name":"Corpora","abstract":"

    Corpora.

    "},"Structs/Corpus.html":{"name":"Corpus","abstract":"

    Corpus.

    "},"Structs/CreateAcousticModel.html":{"name":"CreateAcousticModel","abstract":"

    CreateAcousticModel.

    "},"Structs/CreateLanguageModel.html":{"name":"CreateLanguageModel","abstract":"

    CreateLanguageModel.

    "},"Structs/CustomWord.html":{"name":"CustomWord","abstract":"

    CustomWord.

    "},"Structs/CustomWords.html":{"name":"CustomWords","abstract":"

    CustomWords.

    "},"Structs/KeywordResult.html":{"name":"KeywordResult","abstract":"

    KeywordResult.

    "},"Structs/LanguageModel.html":{"name":"LanguageModel","abstract":"

    LanguageModel.

    "},"Structs/LanguageModels.html":{"name":"LanguageModels","abstract":"

    LanguageModels.

    "},"Structs/RecognitionJob.html":{"name":"RecognitionJob","abstract":"

    RecognitionJob.

    "},"Structs/RecognitionJobs.html":{"name":"RecognitionJobs","abstract":"

    RecognitionJobs.

    "},"Structs/RegisterStatus.html":{"name":"RegisterStatus","abstract":"

    RegisterStatus.

    "},"Structs/SpeakerLabelsResult.html":{"name":"SpeakerLabelsResult","abstract":"

    SpeakerLabelsResult.

    "},"Structs/SpeechModel.html":{"name":"SpeechModel","abstract":"

    SpeechModel.

    "},"Structs/SpeechModels.html":{"name":"SpeechModels","abstract":"

    SpeechModels.

    "},"Structs/SpeechRecognitionAlternative.html":{"name":"SpeechRecognitionAlternative","abstract":"

    SpeechRecognitionAlternative.

    "},"Structs/SpeechRecognitionResult.html":{"name":"SpeechRecognitionResult","abstract":"

    SpeechRecognitionResult.

    "},"Structs/SpeechRecognitionResults.html":{"name":"SpeechRecognitionResults","abstract":"

    SpeechRecognitionResults.

    "},"Structs/SupportedFeatures.html":{"name":"SupportedFeatures","abstract":"

    SupportedFeatures.

    "},"Structs/Word.html":{"name":"Word","abstract":"

    Word.

    "},"Structs/WordAlternativeResult.html":{"name":"WordAlternativeResult","abstract":"

    WordAlternativeResult.

    "},"Structs/WordAlternativeResults.html":{"name":"WordAlternativeResults","abstract":"

    WordAlternativeResults.

    "},"Structs/WordConfidence.html":{"name":"WordConfidence","abstract":"

    The confidence of a word in a Speech to Text transcription.

    "},"Structs/WordError.html":{"name":"WordError","abstract":"

    WordError.

    "},"Structs/WordTimestamp.html":{"name":"WordTimestamp","abstract":"

    The timestamp of a word in a Speech to Text transcription.

    "},"Structs/Words.html":{"name":"Words","abstract":"

    Words.

    "},"Structs/RecognitionSettings.html":{"name":"RecognitionSettings","abstract":"

    The settings associated with a Speech to Text recognition request. Any nil parameters will"},"Structs/SpeechRecognitionResultsAccumulator.html":{"name":"SpeechRecognitionResultsAccumulator","abstract":"

    SpeechRecognitionResultsAccumulator.

    "},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

    No response was received from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

    No data was returned from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO013serializationF0A2CmF":{"name":"serializationError","abstract":"

    Failed to serialize value(s) to data.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO08encodingF0A2CmF":{"name":"encodingError","abstract":"

    Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO011fileManagerF0A2CmF":{"name":"fileManagerError","abstract":"

    FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

    Failed to load the given file.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

    An HTTP error with a status code and description.

    ","parent_name":"RestError"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO4nullA2CmF":{"name":"null","abstract":"

    A null value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

    A boolean value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO6stringACSScACmF":{"name":"string","abstract":"

    A string value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO3intACSicACmF":{"name":"int","abstract":"

    A number value, represented as an integer.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

    A number value, represented as a double.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

    An array value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

    An object value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Decode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

    Initialize a JSON value from an encodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

    Convert this JSON value to a decodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

    Encode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compare two JSON values for equality.

    ","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

    A JSON value (one of string, number, object, array, true, false, or null).

    "},"Enums/RestError.html":{"name":"RestError","abstract":"

    An error from processing a network request or response.

    "},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC10serviceURLSSvp":{"name":"serviceURL","abstract":"

    The base URL of the Speech to Text service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC8tokenURLSSvp":{"name":"tokenURL","abstract":"

    The URL that shall be used to obtain a token.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC13websocketsURLSSvp":{"name":"websocketsURL","abstract":"

    The URL that shall be used to stream audio for transcription.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

    The default HTTP headers for all requests to the service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC7resultsAA0A18RecognitionResultsVvp":{"name":"results","abstract":"

    The results of the most recent recognition request.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC9onConnectyycSgvp":{"name":"onConnect","abstract":"

    Invoked when the session connects to the Speech to Text service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC16onMicrophoneDatay10Foundation0H0VcSgvp":{"name":"onMicrophoneData","abstract":"

    Invoked with microphone audio when a recording audio queue buffer has been filled.","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC11onPowerDataySfcSgvp":{"name":"onPowerData","abstract":"

    Invoked every 0.025s when recording with the average dB power of the microphone.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC9onResultsyAA0a11RecognitionG0VcSgvp":{"name":"onResults","abstract":"

    Invoked when transcription results are received for a recognition request.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC7onErrorys0G0_pcSgvp":{"name":"onError","abstract":"

    Invoked when an error or warning occurs.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC12onDisconnectyycSgvp":{"name":"onDisconnect","abstract":"

    Invoked when the session disconnects from the Speech to Text service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionCACSS8username_SS8passwordSSSg5modelAF15customizationIDSbSg14learningOptOuttcfc":{"name":"init(username:password:model:customizationID:learningOptOut:)","abstract":"

    Create a SpeechToTextSession object.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC7connectyyF":{"name":"connect()","abstract":"

    Connect to the Speech to Text service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC12startRequestyAA19RecognitionSettingsV8settings_tF":{"name":"startRequest(settings:)","abstract":"

    Start a recognition request.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC9recognizey10Foundation3URLV5audio_tF":{"name":"recognize(audio:)","abstract":"

    Send an audio file to transcribe.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC9recognizey10Foundation4DataV5audio_tF":{"name":"recognize(audio:)","abstract":"

    Send audio data to transcribe.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC15startMicrophoneySb8compress_tF":{"name":"startMicrophone(compress:)","abstract":"

    Start streaming microphone audio data to transcribe.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC14stopMicrophoneyyF":{"name":"stopMicrophone()","abstract":"

    Stop streaming microphone audio data to transcribe.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC11stopRequestyyF":{"name":"stopRequest()","abstract":"

    Stop the recognition request.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC10disconnectyyF":{"name":"disconnect()","abstract":"

    Wait for any queued recognition requests to complete then disconnect from the service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

    The base URL to use when contacting the service.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8tokenURLSSvp":{"name":"tokenURL","abstract":"

    The URL that shall be used to obtain a token.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C13websocketsURLSSvp":{"name":"websocketsURL","abstract":"

    The URL that shall be used to stream audio for transcription.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

    The default HTTP headers for all requests to the service.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0CACSS8username_SS8passwordtcfc":{"name":"init(username:password:)","abstract":"

    Create a SpeechToText object.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

    Create a SpeechToText object.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

    Create a SpeechToText object.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

    Undocumented

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C10listModelsys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA0aF0Vc7successtF":{"name":"listModels(headers:failure:success:)","abstract":"

    List models.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8getModelySS7modelID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0aF0Vc7successtF":{"name":"getModel(modelID:headers:failure:success:)","abstract":"

    Get a model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C20recognizeSessionlessySSSg5model_AE15customizationIDAE021acousticCustomizationI0AE16baseModelVersionSdSg0H6Weight10Foundation4DataVSg5audioAE11contentTypeSiSg17inactivityTimeoutSaySSGSg8keywordsAJ0W9ThresholdAR15maxAlternativesAJ04wordzX0SbSg14wordConfidenceAZ10timestampsAZ15profanityFilterAZ15smartFormattingAZ13speakerLabelss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0A18RecognitionResultsVc7successtF":{"name":"recognizeSessionless(model:customizationID:acousticCustomizationID:baseModelVersion:customizationWeight:audio:contentType:inactivityTimeout:keywords:keywordsThreshold:maxAlternatives:wordAlternativesThreshold:wordConfidence:timestamps:profanityFilter:smartFormatting:speakerLabels:headers:failure:success:)","abstract":"

    Recognize audio.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C16registerCallbackySS11callbackUrl_SSSg10userSecrets10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA14RegisterStatusVc7successtF":{"name":"registerCallback(callbackUrl:userSecret:headers:failure:success:)","abstract":"

    Register a callback.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18unregisterCallbackySS11callbackUrl_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"unregisterCallback(callbackUrl:headers:failure:success:)","abstract":"

    Unregister a callback.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9createJoby10Foundation4DataV5audio_SS11contentTypeSSSg5modelAJ11callbackUrlAJ6eventsAJ9userTokenSiSg10resultsTtlAJ15customizationIDAJ021acousticCustomizationU0AJ16baseModelVersionSdSg0T6WeightAO17inactivityTimeoutSaySSGSg8keywordsAT17keywordsThresholdAO15maxAlternativesAT25wordAlternativesThresholdSbSg14wordConfidenceA1_10timestampsA1_15profanityFilterA1_15smartFormattingA1_13speakerLabelss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA011RecognitionF0Vc7successtF":{"name":"createJob(audio:contentType:model:callbackUrl:events:userToken:resultsTtl:customizationID:acousticCustomizationID:baseModelVersion:customizationWeight:inactivityTimeout:keywords:keywordsThreshold:maxAlternatives:wordAlternativesThreshold:wordConfidence:timestamps:profanityFilter:smartFormatting:speakerLabels:headers:failure:success:)","abstract":"

    Create a job.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9checkJobsys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA011RecognitionF0Vc7successtF":{"name":"checkJobs(headers:failure:success:)","abstract":"

    Check jobs.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8checkJobySS2id_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA011RecognitionF0Vc7successtF":{"name":"checkJob(id:headers:failure:success:)","abstract":"

    Check a job.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9deleteJobySS2id_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteJob(id:headers:failure:success:)","abstract":"

    Delete a job.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C19createLanguageModelyAA06CreatefG0VAD_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"createLanguageModel(createLanguageModel:headers:failure:success:)","abstract":"

    Create a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18listLanguageModelsySSSg8language_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"listLanguageModels(language:headers:failure:success:)","abstract":"

    List custom language models.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C16getLanguageModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"getLanguageModel(customizationID:headers:failure:success:)","abstract":"

    Get a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C19deleteLanguageModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteLanguageModel(customizationID:headers:failure:success:)","abstract":"

    Delete a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18trainLanguageModelySS15customizationID_SSSg08wordTypeB3AddSdSg0H6Weights10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"trainLanguageModel(customizationID:wordTypeToAdd:customizationWeight:headers:failure:success:)","abstract":"

    Train a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18resetLanguageModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"resetLanguageModel(customizationID:headers:failure:success:)","abstract":"

    Reset a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C20upgradeLanguageModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"upgradeLanguageModel(customizationID:headers:failure:success:)","abstract":"

    Upgrade a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C11listCorporaySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"listCorpora(customizationID:headers:failure:success:)","abstract":"

    List corpora.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9addCorpusySS15customizationID_SS10corpusName10Foundation3URLV0I4FileSbSg14allowOverwriteSSSg0iM11ContentTypes10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addCorpus(customizationID:corpusName:corpusFile:allowOverwrite:corpusFileContentType:headers:failure:success:)","abstract":"

    Add a corpus.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9getCorpusySS15customizationID_SS10corpusNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"getCorpus(customizationID:corpusName:headers:failure:success:)","abstract":"

    Get a corpus.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C12deleteCorpusySS15customizationID_SS10corpusNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteCorpus(customizationID:corpusName:headers:failure:success:)","abstract":"

    Delete a corpus.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9listWordsySS15customizationID_SSSg8wordTypeAF4sorts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"listWords(customizationID:wordType:sort:headers:failure:success:)","abstract":"

    List custom words.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8addWordsySS15customizationID_SayAA10CustomWordVG5wordss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addWords(customizationID:words:headers:failure:success:)","abstract":"

    Add custom words.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C7addWordySS15customizationID_SS8wordNameSSSg0I0SaySSGSg10soundsLikeAG9displayAss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addWord(customizationID:wordName:word:soundsLike:displayAs:headers:failure:success:)","abstract":"

    Add a custom word.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C7getWordySS15customizationID_SS8wordNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"getWord(customizationID:wordName:headers:failure:success:)","abstract":"

    Get a custom word.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C10deleteWordySS15customizationID_SS8wordNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteWord(customizationID:wordName:headers:failure:success:)","abstract":"

    Delete a custom word.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C19createAcousticModelySS4name_SS04baseG4NameSSSg11descriptions10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"createAcousticModel(name:baseModelName:description:headers:failure:success:)","abstract":"

    Create a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18listAcousticModelsySSSg8language_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"listAcousticModels(language:headers:failure:success:)","abstract":"

    List custom acoustic models.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C16getAcousticModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"getAcousticModel(customizationID:headers:failure:success:)","abstract":"

    Get a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C19deleteAcousticModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteAcousticModel(customizationID:headers:failure:success:)","abstract":"

    Delete a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18trainAcousticModelySS15customizationID_SSSg014customLanguagegI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"trainAcousticModel(customizationID:customLanguageModelID:headers:failure:success:)","abstract":"

    Train a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18resetAcousticModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"resetAcousticModel(customizationID:headers:failure:success:)","abstract":"

    Reset a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C20upgradeAcousticModelySS15customizationID_SSSg014customLanguagegI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"upgradeAcousticModel(customizationID:customLanguageModelID:headers:failure:success:)","abstract":"

    Upgrade a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9listAudioySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F9ResourcesVc7successtF":{"name":"listAudio(customizationID:headers:failure:success:)","abstract":"

    List audio resources.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8addAudioySS15customizationID_SS9audioName10Foundation4DataV0I8ResourceSS11contentTypeSSSg016containedContentO0SbSg14allowOverwrites10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addAudio(customizationID:audioName:audioResource:contentType:containedContentType:allowOverwrite:headers:failure:success:)","abstract":"

    Add an audio resource.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8getAudioySS15customizationID_SS9audioNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F7ListingVc7successtF":{"name":"getAudio(customizationID:audioName:headers:failure:success:)","abstract":"

    Get an audio resource.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C11deleteAudioySS15customizationID_SS9audioNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteAudio(customizationID:audioName:headers:failure:success:)","abstract":"

    Delete an audio resource.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

    Delete labeled data.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9recognizey10Foundation3URLV5audio_AA19RecognitionSettingsV8settingsSSSg5modelAL15customizationIDSbSg14learningOptOutys5Error_pcSg7failureyAA0aI7ResultsVc7successtF":{"name":"recognize(audio:settings:model:customizationID:learningOptOut:failure:success:)","abstract":"

    Perform speech recognition for an audio file.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9recognizey10Foundation4DataV5audio_AA19RecognitionSettingsV8settingsSSSg5modelAL15customizationIDSbSg14learningOptOutys5Error_pcSg7failureyAA0aI7ResultsVc7successtF":{"name":"recognize(audio:settings:model:customizationID:learningOptOut:failure:success:)","abstract":"

    Perform speech recognition for audio data.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C19recognizeMicrophoneyAA19RecognitionSettingsV8settings_SSSg5modelAH15customizationIDSbSg14learningOptOutSb8compressys5Error_pcSg7failureyAA0aG7ResultsVc7successtF":{"name":"recognizeMicrophone(settings:model:customizationID:learningOptOut:compress:failure:success:)","abstract":"

    Perform speech recognition for microphone audio. To stop the microphone, invoke","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C23stopRecognizeMicrophoneyyF":{"name":"stopRecognizeMicrophone()","abstract":"

    Stop performing speech recognition for microphone audio.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html":{"name":"SpeechToText","abstract":"

    The IBM® Speech to Text service provides an API that uses IBM’s speech-recognition capabilities to produce"},"Classes/SpeechToTextSession.html":{"name":"SpeechToTextSession","abstract":"

    The IBM Watson Speech to Text service enables you to add speech transcription capabilities to"},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "}} \ No newline at end of file diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/docSet.dsidx b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/docSet.dsidx index a9a145962..ef3995ceb 100644 Binary files a/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/docSet.dsidx and b/docs/swift-api/services/SpeechToTextV1/docsets/.docset/Contents/Resources/docSet.dsidx differ diff --git a/docs/swift-api/services/SpeechToTextV1/docsets/.tgz b/docs/swift-api/services/SpeechToTextV1/docsets/.tgz index 8cc9d31e3..a67017f65 100644 Binary files a/docs/swift-api/services/SpeechToTextV1/docsets/.tgz and b/docs/swift-api/services/SpeechToTextV1/docsets/.tgz differ diff --git a/docs/swift-api/services/SpeechToTextV1/index.html b/docs/swift-api/services/SpeechToTextV1/index.html index adbe47327..3fad4d4e4 100644 --- a/docs/swift-api/services/SpeechToTextV1/index.html +++ b/docs/swift-api/services/SpeechToTextV1/index.html @@ -112,9 +112,6 @@ - @@ -238,7 +235,8 @@

    Services

    • Assistant
    • Discovery
    • -
    • Language Translator
    • +
    • Language Translator V2
    • +
    • Language Translator V3
    • Natural Language Classifier
    • Natural Language Understanding
    • Personality Insights
    • @@ -283,7 +281,7 @@

      Swift Package Manager

      Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

      dependencies: [
      -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
      +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
       ]
       

      Service Instances

      @@ -326,7 +324,7 @@

      Username and Password

      API Key

      -

      Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

      +

      Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

      let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
       

      Using IAM

      @@ -561,7 +559,12 @@

      Private Data Collections

    • IBM Discovery - Documentation
    • IBM Discovery - Demo
    -

    Language Translator

    +

    Language Translator V2

    + +

    Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

    The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

    @@ -572,6 +575,25 @@

    Language Translator

    let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} +
    +

    Language Translator V3

    + +

    The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

    + +

    The following example demonstrates how to use the Language Translator service:

    +
    import LanguageTranslatorV3
    +
    +let username = "your-username-here"
    +let password = "your-password-here"
    +let version = "yyyy-mm-dd" // use today's date for the most recent version
    +let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
    +
     let failure = { (error: Error) in print(error) }
     let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
     languageTranslator.translate(request: request, failure: failure) {
    @@ -962,7 +984,7 @@ 

    Visual Recognition

    let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -970,6 +992,10 @@

    Visual Recognition

    print(classifiedImages) }
    + +

    Note: a different initializer is used for authentication with instances created before May 23, 2018:

    +
    let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
    +

    Using Core ML

    The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

    @@ -1021,7 +1047,7 @@

    Bundlin diff --git a/docs/swift-api/services/SpeechToTextV1/search.json b/docs/swift-api/services/SpeechToTextV1/search.json index 6a81b9b90..28371ba0b 100644 --- a/docs/swift-api/services/SpeechToTextV1/search.json +++ b/docs/swift-api/services/SpeechToTextV1/search.json @@ -1 +1 @@ -{"Structs/SpeechRecognitionResultsAccumulator.html#/s:14SpeechToTextV10A29RecognitionResultsAccumulatorV7resultsSayAA0aE6ResultVGvp":{"name":"results","abstract":"

    All accumulated recognition results.

    ","parent_name":"SpeechRecognitionResultsAccumulator"},"Structs/SpeechRecognitionResultsAccumulator.html#/s:14SpeechToTextV10A29RecognitionResultsAccumulatorV13speakerLabelsSayAA07SpeakerI6ResultVGvp":{"name":"speakerLabels","abstract":"

    All accumulated speaker labels.

    ","parent_name":"SpeechRecognitionResultsAccumulator"},"Structs/SpeechRecognitionResultsAccumulator.html#/s:14SpeechToTextV10A29RecognitionResultsAccumulatorV14bestTranscriptSSvp":{"name":"bestTranscript","abstract":"

    A concatenation of transcripts with the greatest confidence.

    ","parent_name":"SpeechRecognitionResultsAccumulator"},"Structs/SpeechRecognitionResultsAccumulator.html#/s:14SpeechToTextV10A29RecognitionResultsAccumulatorVACycfc":{"name":"init()","abstract":"

    Initialize a SpeechRecognitionResultsAccumulator to accumulate recognition results.

    ","parent_name":"SpeechRecognitionResultsAccumulator"},"Structs/SpeechRecognitionResultsAccumulator.html#/s:14SpeechToTextV10A29RecognitionResultsAccumulatorV3addyAA0aeF0V7results_tF":{"name":"add(results:)","abstract":"

    Add recognition results to be accumulated.

    ","parent_name":"SpeechRecognitionResultsAccumulator"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV11contentTypeSSvp":{"name":"contentType","abstract":"

    The format of the audio data. Endianness is automatically detected by the Speech to Text","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV17inactivityTimeoutSiSgvp":{"name":"inactivityTimeout","abstract":"

    The number of seconds after which the connection is to time out due to inactivity.","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV8keywordsSaySSGSgvp":{"name":"keywords","abstract":"

    An array of keyword strings to be matched in the input audio. By default, the service","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV17keywordsThresholdSdSgvp":{"name":"keywordsThreshold","abstract":"

    A minimum level of confidence that the service must have to report a matching keyword","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV15maxAlternativesSiSgvp":{"name":"maxAlternatives","abstract":"

    The maximum number of alternative transcriptions to receive. The default is 1.

    ","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV14interimResultsSbSgvp":{"name":"interimResults","abstract":"

    If true, then interim results (i.e. results that are not final) will be received","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV25wordAlternativesThresholdSdSgvp":{"name":"wordAlternativesThreshold","abstract":"

    A minimum level of confidence that the service must have to report a hypothesis for a","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV14wordConfidenceSbSgvp":{"name":"wordConfidence","abstract":"

    If true, then a confidence score will be received for each word of the transcription.","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV10timestampsSbSgvp":{"name":"timestamps","abstract":"

    If true, then per-word start and end times relative to the beginning of the audio will","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV15filterProfanitySbSgvp":{"name":"filterProfanity","abstract":"

    If true, then profanity will be censored from the service’s output, obscuring each","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV15smartFormattingSbSgvp":{"name":"smartFormatting","abstract":"

    Indicates whether dates, times, series of digits and numbers, phone numbers, currency values,","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV13speakerLabelsSbSgvp":{"name":"speakerLabels","abstract":"

    If true, then speaker labels will be returned for each timestamp. The default is false.

    ","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsVACSS11contentType_tcfc":{"name":"init(contentType:)","abstract":"

    Initialize a RecognitionSettings object to set the parameters of a Watson Speech to","parent_name":"RecognitionSettings"},"Structs/Words.html#/s:14SpeechToTextV15WordsV5wordsSayAA4WordVGvp":{"name":"words","abstract":"

    Information about each word in the custom model’s words resource. The array is empty if the custom model has no words.

    ","parent_name":"Words"},"Structs/WordTimestamp.html#/s:14SpeechToTextV113WordTimestampV4wordSSvp":{"name":"word","abstract":"

    A particular word from the transcription.

    ","parent_name":"WordTimestamp"},"Structs/WordTimestamp.html#/s:14SpeechToTextV113WordTimestampV9startTimeSdvp":{"name":"startTime","abstract":"

    The start time, in seconds, of the given word in the audio input.

    ","parent_name":"WordTimestamp"},"Structs/WordTimestamp.html#/s:14SpeechToTextV113WordTimestampV7endTimeSdvp":{"name":"endTime","abstract":"

    The end time, in seconds, of the given word in the audio input.

    ","parent_name":"WordTimestamp"},"Structs/WordTimestamp.html#/s:14SpeechToTextV113WordTimestampVACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Used internally to initialize a WordTimestamp model from JSON.

    ","parent_name":"WordTimestamp"},"Structs/WordError.html#/s:14SpeechToTextV19WordErrorV7elementSSvp":{"name":"element","abstract":"

    A key-value pair that describes an error associated with the definition of a word in the words resource. Each pair has the format "element": "message", where element is the aspect of the definition that caused the problem and message describes the problem. The following example describes a problem with one of the word’s sounds-like definitions: "{sounds_like_string}": "Numbers are not allowed in sounds-like. You can try for example '{suggested_string}'." You must correct the error before you can train the model.

    ","parent_name":"WordError"},"Structs/WordConfidence.html#/s:14SpeechToTextV114WordConfidenceV4wordSSvp":{"name":"word","abstract":"

    A particular word from the transcription.

    ","parent_name":"WordConfidence"},"Structs/WordConfidence.html#/s:14SpeechToTextV114WordConfidenceV10confidenceSdvp":{"name":"confidence","abstract":"

    The confidence of the given word, between 0 and 1.

    ","parent_name":"WordConfidence"},"Structs/WordConfidence.html#/s:14SpeechToTextV114WordConfidenceVACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Used internally to initialize a WordConfidence model from JSON.

    ","parent_name":"WordConfidence"},"Structs/WordAlternativeResults.html#/s:14SpeechToTextV122WordAlternativeResultsV9startTimeSdvp":{"name":"startTime","abstract":"

    The start time in seconds of the word from the input audio that corresponds to the word alternatives.

    ","parent_name":"WordAlternativeResults"},"Structs/WordAlternativeResults.html#/s:14SpeechToTextV122WordAlternativeResultsV7endTimeSdvp":{"name":"endTime","abstract":"

    The end time in seconds of the word from the input audio that corresponds to the word alternatives.

    ","parent_name":"WordAlternativeResults"},"Structs/WordAlternativeResults.html#/s:14SpeechToTextV122WordAlternativeResultsV12alternativesSayAA0eF6ResultVGvp":{"name":"alternatives","abstract":"

    An array of alternative hypotheses for a word from the input audio.

    ","parent_name":"WordAlternativeResults"},"Structs/WordAlternativeResult.html#/s:14SpeechToTextV121WordAlternativeResultV10confidenceSdvp":{"name":"confidence","abstract":"

    A confidence score for the word alternative hypothesis in the range of 0 to 1.

    ","parent_name":"WordAlternativeResult"},"Structs/WordAlternativeResult.html#/s:14SpeechToTextV121WordAlternativeResultV4wordSSvp":{"name":"word","abstract":"

    An alternative hypothesis for a word from the input audio.

    ","parent_name":"WordAlternativeResult"},"Structs/Word.html#/s:14SpeechToTextV14WordV4wordSSvp":{"name":"word","abstract":"

    A word from the custom model’s words resource. The spelling of the word is used to train the model.

    ","parent_name":"Word"},"Structs/Word.html#/s:14SpeechToTextV14WordV10soundsLikeSaySSGvp":{"name":"soundsLike","abstract":"

    An array of pronunciations for the word. The array can include the sounds-like pronunciation automatically generated by the service if none is provided for the word; the service adds this pronunciation when it finishes processing the word.

    ","parent_name":"Word"},"Structs/Word.html#/s:14SpeechToTextV14WordV9displayAsSSvp":{"name":"displayAs","abstract":"

    The spelling of the word that the service uses to display the word in a transcript. The field contains an empty string if no display-as value is provided for the word, in which case the word is displayed as it is spelled.

    ","parent_name":"Word"},"Structs/Word.html#/s:14SpeechToTextV14WordV5countSivp":{"name":"count","abstract":"

    A sum of the number of times the word is found across all corpora. For example, if the word occurs five times in one corpus and seven times in another, its count is 12. If you add a custom word to a model before it is added by any corpora, the count begins at 1; if the word is added from a corpus first and later modified, the count reflects only the number of times it is found in corpora.

    ","parent_name":"Word"},"Structs/Word.html#/s:14SpeechToTextV14WordV6sourceSaySSGvp":{"name":"source","abstract":"

    An array of sources that describes how the word was added to the custom model’s words resource. For OOV words added from a corpus, includes the name of the corpus; if the word was added by multiple corpora, the names of all corpora are listed. If the word was modified or added by the user directly, the field includes the string user.

    ","parent_name":"Word"},"Structs/Word.html#/s:14SpeechToTextV14WordV5errorSayAA0E5ErrorVGSgvp":{"name":"error","abstract":"

    If the service discovered one or more problems that you need to correct for the word’s definition, an array that describes each of the errors.

    ","parent_name":"Word"},"Structs/SupportedFeatures.html#/s:14SpeechToTextV117SupportedFeaturesV19customLanguageModelSbvp":{"name":"customLanguageModel","abstract":"

    Indicates whether the customization interface can be used to create a custom language model based on the language model.

    ","parent_name":"SupportedFeatures"},"Structs/SupportedFeatures.html#/s:14SpeechToTextV117SupportedFeaturesV13speakerLabelsSbvp":{"name":"speakerLabels","abstract":"

    Indicates whether the speaker_labels parameter can be used with the language model.

    ","parent_name":"SupportedFeatures"},"Structs/SpeechRecognitionResults.html#/s:14SpeechToTextV10A18RecognitionResultsV7resultsSayAA0aE6ResultVGSgvp":{"name":"results","abstract":"

    An array that can include interim and final results (interim results are returned only if supported by the method). Final results are guaranteed not to change; interim results might be replaced by further interim results and final results. The service periodically sends updates to the results list; the result_index is set to the lowest index in the array that has changed; it is incremented for new results.

    ","parent_name":"SpeechRecognitionResults"},"Structs/SpeechRecognitionResults.html#/s:14SpeechToTextV10A18RecognitionResultsV11resultIndexSiSgvp":{"name":"resultIndex","abstract":"

    An index that indicates a change point in the results array. The service increments the index only for additional results that it sends for new audio for the same request.

    ","parent_name":"SpeechRecognitionResults"},"Structs/SpeechRecognitionResults.html#/s:14SpeechToTextV10A18RecognitionResultsV13speakerLabelsSayAA07SpeakerH6ResultVGSgvp":{"name":"speakerLabels","abstract":"

    An array that identifies which words were spoken by which speakers in a multi-person exchange. Returned in the response only if speaker_labels is true. When interim results are also requested for methods that support them, it is possible for a SpeechRecognitionResults object to include only the speaker_labels field.

    ","parent_name":"SpeechRecognitionResults"},"Structs/SpeechRecognitionResults.html#/s:14SpeechToTextV10A18RecognitionResultsV8warningsSaySSGSgvp":{"name":"warnings","abstract":"

    An array of warning messages associated with the request: * Warnings for invalid parameters or fields can include a descriptive message and a list of invalid argument strings, for example, "Unknown arguments:" or "Unknown url query arguments:" followed by a list of the form "invalid_arg_1, invalid_arg_2." * The following warning is returned if the request passes a custom model that is based on an older version of a base model for which an updated version is available: "Using previous version of base model, because your custom model has been built with it. Please note that this version will be supported only for a limited time. Consider updating your custom model to the new base model. If you do not do that you will be automatically switched to base model when you used the non-updated custom model." In both cases, the request succeeds despite the warnings.

    ","parent_name":"SpeechRecognitionResults"},"Structs/SpeechRecognitionResult.html#/s:14SpeechToTextV10A17RecognitionResultV12finalResultsSbvp":{"name":"finalResults","abstract":"

    An indication of whether the transcription results are final. If true, the results for this utterance are not updated further; no additional results are sent for a result_index once its results are indicated as final.

    ","parent_name":"SpeechRecognitionResult"},"Structs/SpeechRecognitionResult.html#/s:14SpeechToTextV10A17RecognitionResultV12alternativesSayAA0aE11AlternativeVGvp":{"name":"alternatives","abstract":"

    An array of alternative transcripts. The alternatives array can include additional requested output such as word confidence or timestamps.

    ","parent_name":"SpeechRecognitionResult"},"Structs/SpeechRecognitionResult.html#/s:14SpeechToTextV10A17RecognitionResultV08keywordsF0s10DictionaryVySSSayAA07KeywordF0VGGSgvp":{"name":"keywordsResult","abstract":"

    A dictionary (or associative array) whose keys are the strings specified for keywords if both that parameter and keywords_threshold are specified. A keyword for which no matches are found is omitted from the array. The array is omitted if no matches are found for any keywords.

    ","parent_name":"SpeechRecognitionResult"},"Structs/SpeechRecognitionResult.html#/s:14SpeechToTextV10A17RecognitionResultV16wordAlternativesSayAA22WordAlternativeResultsVGSgvp":{"name":"wordAlternatives","abstract":"

    An array of alternative hypotheses found for words of the input audio if a word_alternatives_threshold is specified.

    ","parent_name":"SpeechRecognitionResult"},"Structs/SpeechRecognitionAlternative.html#/s:14SpeechToTextV10A22RecognitionAlternativeV10transcriptSSvp":{"name":"transcript","abstract":"

    A transcription of the audio.

    ","parent_name":"SpeechRecognitionAlternative"},"Structs/SpeechRecognitionAlternative.html#/s:14SpeechToTextV10A22RecognitionAlternativeV10confidenceSdSgvp":{"name":"confidence","abstract":"

    A score that indicates the service’s confidence in the transcript in the range of 0 to 1. Returned only for the best alternative and only with results marked as final.

    ","parent_name":"SpeechRecognitionAlternative"},"Structs/SpeechRecognitionAlternative.html#/s:14SpeechToTextV10A22RecognitionAlternativeV10timestampsSayAA13WordTimestampVGSgvp":{"name":"timestamps","abstract":"

    Time alignments for each word from the transcript as a list of lists. Each inner list consists of three elements: the word followed by its start and end time in seconds. Example: [["hello",0.0,1.2],["world",1.2,2.5]]. Returned only for the best alternative.

    ","parent_name":"SpeechRecognitionAlternative"},"Structs/SpeechRecognitionAlternative.html#/s:14SpeechToTextV10A22RecognitionAlternativeV14wordConfidenceSayAA04WordH0VGSgvp":{"name":"wordConfidence","abstract":"

    A confidence score for each word of the transcript as a list of lists. Each inner list consists of two elements: the word and its confidence score in the range of 0 to 1. Example: [["hello",0.95],["world",0.866]]. Returned only for the best alternative and only with results marked as final.

    ","parent_name":"SpeechRecognitionAlternative"},"Structs/SpeechModels.html#/s:14SpeechToTextV10A6ModelsV6modelsSayAA0A5ModelVGvp":{"name":"models","abstract":"

    Information about each available model.

    ","parent_name":"SpeechModels"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV4nameSSvp":{"name":"name","abstract":"

    The name of the model for use as an identifier in calls to the service (for example, en-US_BroadbandModel).

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV8languageSSvp":{"name":"language","abstract":"

    The language identifier of the model (for example, en-US).

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV4rateSivp":{"name":"rate","abstract":"

    The sampling rate (minimum acceptable rate for audio) used by the model in Hertz.

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV3urlSSvp":{"name":"url","abstract":"

    The URI for the model.

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV17supportedFeaturesAA09SupportedG0Vvp":{"name":"supportedFeatures","abstract":"

    Describes the additional service features supported with the model.

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV11descriptionSSvp":{"name":"description","abstract":"

    Brief description of the model.

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV8sessionsSSSgvp":{"name":"sessions","abstract":"

    The URI for the model for use with the Create a session method. This field is returned only by the Get a model method.

    ","parent_name":"SpeechModel"},"Structs/SpeakerLabelsResult.html#/s:14SpeechToTextV119SpeakerLabelsResultV4fromSdvp":{"name":"from","abstract":"

    The start time of a word from the transcript. The value matches the start time of a word from the timestamps array.

    ","parent_name":"SpeakerLabelsResult"},"Structs/SpeakerLabelsResult.html#/s:14SpeechToTextV119SpeakerLabelsResultV2toSdvp":{"name":"to","abstract":"

    The end time of a word from the transcript. The value matches the end time of a word from the timestamps array.

    ","parent_name":"SpeakerLabelsResult"},"Structs/SpeakerLabelsResult.html#/s:14SpeechToTextV119SpeakerLabelsResultV7speakerSivp":{"name":"speaker","abstract":"

    The numeric identifier that the service assigns to a speaker from the audio. Speaker IDs begin at 0 initially but can evolve and change across interim results (if supported by the method) and between interim and final results as the service processes the audio. They are not guaranteed to be sequential, contiguous, or ordered.

    ","parent_name":"SpeakerLabelsResult"},"Structs/SpeakerLabelsResult.html#/s:14SpeechToTextV119SpeakerLabelsResultV10confidenceSdvp":{"name":"confidence","abstract":"

    A score that indicates the service’s confidence in its identification of the speaker in the range of 0 to 1.

    ","parent_name":"SpeakerLabelsResult"},"Structs/SpeakerLabelsResult.html#/s:14SpeechToTextV119SpeakerLabelsResultV12finalResultsSbvp":{"name":"finalResults","abstract":"

    An indication of whether the service might further change word and speaker-label results. A value of true means that the service guarantees not to send any further updates for the current or any preceding results; false means that the service might send further updates to the results.

    ","parent_name":"SpeakerLabelsResult"},"Structs/RegisterStatus/Status.html#/s:14SpeechToTextV114RegisterStatusV0F0O7createdA2EmF":{"name":"created","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RegisterStatus/Status.html#/s:14SpeechToTextV114RegisterStatusV0F0O14alreadyCreatedA2EmF":{"name":"alreadyCreated","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RegisterStatus/Status.html":{"name":"Status","abstract":"

    The current status of the job: * created if the callback URL was successfully white-listed as a result of the call. * already created if the URL was already white-listed.

    ","parent_name":"RegisterStatus"},"Structs/RegisterStatus.html#/s:14SpeechToTextV114RegisterStatusV6statusSSvp":{"name":"status","abstract":"

    The current status of the job: * created if the callback URL was successfully white-listed as a result of the call. * already created if the URL was already white-listed.

    ","parent_name":"RegisterStatus"},"Structs/RegisterStatus.html#/s:14SpeechToTextV114RegisterStatusV3urlSSvp":{"name":"url","abstract":"

    The callback URL that is successfully registered.

    ","parent_name":"RegisterStatus"},"Structs/RecognitionJobs.html#/s:14SpeechToTextV115RecognitionJobsV12recognitionsSayAA0E3JobVGvp":{"name":"recognitions","abstract":"

    An array of objects that provides the status for each of the user’s current jobs. The array is empty if the user has no current jobs.

    ","parent_name":"RecognitionJobs"},"Structs/RecognitionJob/Status.html#/s:14SpeechToTextV114RecognitionJobV6StatusO7waitingA2EmF":{"name":"waiting","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RecognitionJob/Status.html#/s:14SpeechToTextV114RecognitionJobV6StatusO10processingA2EmF":{"name":"processing","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RecognitionJob/Status.html#/s:14SpeechToTextV114RecognitionJobV6StatusO9completedA2EmF":{"name":"completed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RecognitionJob/Status.html#/s:14SpeechToTextV114RecognitionJobV6StatusO6failedA2EmF":{"name":"failed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RecognitionJob/Status.html":{"name":"Status","abstract":"

    The current status of the job: * waiting: The service is preparing the job for processing. The service returns this status when the job is initially created or when it is waiting for capacity to process the job. The job remains in this state until the service has the capacity to begin processing it. * processing: The service is actively processing the job. * completed: The service has finished processing the job. If the job specified a callback URL and the event recognitions.completed_with_results, the service sent the results with the callback notification; otherwise, you must retrieve the results by checking the individual job. * failed: The job failed.

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV2idSSvp":{"name":"id","abstract":"

    The ID of the asynchronous job.

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV6statusSSvp":{"name":"status","abstract":"

    The current status of the job: * waiting: The service is preparing the job for processing. The service returns this status when the job is initially created or when it is waiting for capacity to process the job. The job remains in this state until the service has the capacity to begin processing it. * processing: The service is actively processing the job. * completed: The service has finished processing the job. If the job specified a callback URL and the event recognitions.completed_with_results, the service sent the results with the callback notification; otherwise, you must retrieve the results by checking the individual job. * failed: The job failed.

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV7createdSSvp":{"name":"created","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the job was created. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV7updatedSSSgvp":{"name":"updated","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the job was last updated by the service. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD). This field is returned only by the Check jobs and Check a job methods.

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV3urlSSSgvp":{"name":"url","abstract":"

    The URL to use to request information about the job with the Check a job method. This field is returned only by the Create a job method.

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV9userTokenSSSgvp":{"name":"userToken","abstract":"

    The user token associated with a job that was created with a callback URL and a user token. This field can be returned only by the Check jobs method.

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV7resultsSayAA0aE7ResultsVGSgvp":{"name":"results","abstract":"

    If the status is completed, the results of the recognition request as an array that includes a single instance of a SpeechRecognitionResults object. This field is returned only by the Check a job method.

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV8warningsSaySSGSgvp":{"name":"warnings","abstract":"

    An array of warning messages about invalid parameters included with the request. Each warning includes a descriptive message and a list of invalid argument strings, for example, "unexpected query parameter 'user_token', query parameter 'callback_url' was not specified". The request succeeds despite the warnings. This field can be returned only by the Create a job method.

    ","parent_name":"RecognitionJob"},"Structs/LanguageModels.html#/s:14SpeechToTextV114LanguageModelsV14customizationsSayAA0E5ModelVGvp":{"name":"customizations","abstract":"

    An array of objects that provides information about each available custom language model. The array is empty if the requesting service credentials own no custom language models (if no language is specified) or own no custom language models for the specified language.

    ","parent_name":"LanguageModels"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO7pendingA2EmF":{"name":"pending","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO5readyA2EmF":{"name":"ready","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO8trainingA2EmF":{"name":"training","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO9availableA2EmF":{"name":"available","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO9upgradingA2EmF":{"name":"upgrading","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO6failedA2EmF":{"name":"failed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html":{"name":"Status","abstract":"

    The current status of the custom language model: * pending indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * ready indicates that the model contains data and is ready to be trained. * training indicates that the model is currently being trained. * available indicates that the model is trained and ready to use. * upgrading indicates that the model is currently being upgraded. * failed indicates that training of the model failed.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV15customizationIDSSvp":{"name":"customizationID","abstract":"

    The customization ID (GUID) of the custom language model. The Create a custom language model method returns only this field of the object; it does not return the other fields.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV7createdSSSgvp":{"name":"created","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the custom language model was created. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV8languageSSSgvp":{"name":"language","abstract":"

    The language identifier of the custom language model (for example, en-US).

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV7dialectSSSgvp":{"name":"dialect","abstract":"

    The dialect of the language for the custom language model. By default, the dialect matches the language of the base model; for example, en-US for either of the US English language models. For Spanish models, the field indicates the dialect for which the model was created: * es-ES for Castilian Spanish (the default) * es-LA for Latin American Spanish * es-US for North American (Mexican) Spanish.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV8versionsSaySSGSgvp":{"name":"versions","abstract":"

    A list of the available versions of the custom language model. Each element of the array indicates a version of the base model with which the custom model can be used. Multiple versions exist only if the custom model has been upgraded; otherwise, only a single version is shown.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV5ownerSSSgvp":{"name":"owner","abstract":"

    The GUID of the service credentials for the instance of the service that owns the custom language model.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV4nameSSSgvp":{"name":"name","abstract":"

    The name of the custom language model.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV11descriptionSSSgvp":{"name":"description","abstract":"

    The description of the custom language model.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV04baseF4NameSSSgvp":{"name":"baseModelName","abstract":"

    The name of the language model for which the custom language model was created.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV6statusSSSgvp":{"name":"status","abstract":"

    The current status of the custom language model: * pending indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * ready indicates that the model contains data and is ready to be trained. * training indicates that the model is currently being trained. * available indicates that the model is trained and ready to use. * upgrading indicates that the model is currently being upgraded. * failed indicates that training of the model failed.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV8progressSiSgvp":{"name":"progress","abstract":"

    A percentage that indicates the progress of the custom language model’s current training. A value of 100 means that the model is fully trained. Note: The progress field does not currently reflect the progress of the training. The field changes from 0 to 100 when training is complete.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV8warningsSSSgvp":{"name":"warnings","abstract":"

    If the request included unknown parameters, the following message: Unexpected query parameter(s) ['parameters'] detected, where parameters is a list that includes a quoted string for each unknown parameter.

    ","parent_name":"LanguageModel"},"Structs/KeywordResult.html#/s:14SpeechToTextV113KeywordResultV010normalizedC0SSvp":{"name":"normalizedText","abstract":"

    A specified keyword normalized to the spoken phrase that matched in the audio input.

    ","parent_name":"KeywordResult"},"Structs/KeywordResult.html#/s:14SpeechToTextV113KeywordResultV9startTimeSdvp":{"name":"startTime","abstract":"

    The start time in seconds of the keyword match.

    ","parent_name":"KeywordResult"},"Structs/KeywordResult.html#/s:14SpeechToTextV113KeywordResultV7endTimeSdvp":{"name":"endTime","abstract":"

    The end time in seconds of the keyword match.

    ","parent_name":"KeywordResult"},"Structs/KeywordResult.html#/s:14SpeechToTextV113KeywordResultV10confidenceSdvp":{"name":"confidence","abstract":"

    A confidence score for the keyword match in the range of 0 to 1.

    ","parent_name":"KeywordResult"},"Structs/CustomWords.html#/s:14SpeechToTextV111CustomWordsV5wordsSayAA0E4WordVGvp":{"name":"words","abstract":"

    An array of objects that provides information about each custom word that is to be added to or updated in the custom language model.

    ","parent_name":"CustomWords"},"Structs/CustomWords.html#/s:14SpeechToTextV111CustomWordsVACSayAA0E4WordVG5words_tcfc":{"name":"init(words:)","abstract":"

    Initialize a CustomWords with member variables.

    ","parent_name":"CustomWords"},"Structs/CustomWord.html#/s:14SpeechToTextV110CustomWordV4wordSSSgvp":{"name":"word","abstract":"

    For the Add custom words method, you must specify the custom word that is to be added to or updated in the custom model. Do not include spaces in the word. Use a - (dash) or _ (underscore) to connect the tokens of compound words. Omit this field for the Add a custom word method.

    ","parent_name":"CustomWord"},"Structs/CustomWord.html#/s:14SpeechToTextV110CustomWordV10soundsLikeSaySSGSgvp":{"name":"soundsLike","abstract":"

    An array of sounds-like pronunciations for the custom word. Specify how words that are difficult to pronounce, foreign words, acronyms, and so on can be pronounced by users. For a word that is not in the service’s base vocabulary, omit the parameter to have the service automatically generate a sounds-like pronunciation for the word. For a word that is in the service’s base vocabulary, use the parameter to specify additional pronunciations for the word. You cannot override the default pronunciation of a word; pronunciations you add augment the pronunciation from the base vocabulary. A word can have at most five sounds-like pronunciations, and a pronunciation can include at most 40 characters not including spaces.

    ","parent_name":"CustomWord"},"Structs/CustomWord.html#/s:14SpeechToTextV110CustomWordV9displayAsSSSgvp":{"name":"displayAs","abstract":"

    An alternative spelling for the custom word when it appears in a transcript. Use the parameter when you want the word to have a spelling that is different from its usual representation or from its spelling in corpora training data.

    ","parent_name":"CustomWord"},"Structs/CustomWord.html#/s:14SpeechToTextV110CustomWordVACSSSg4word_SaySSGSg10soundsLikeAD9displayAstcfc":{"name":"init(word:soundsLike:displayAs:)","abstract":"

    Initialize a CustomWord with member variables.

    ","parent_name":"CustomWord"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18enGbBroadbandmodelA2EmF":{"name":"enGbBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO19enGbNarrowbandmodelA2EmF":{"name":"enGbNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18enUsBroadbandmodelA2EmF":{"name":"enUsBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO19enUsNarrowbandmodelA2EmF":{"name":"enUsNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18esEsBroadbandmodelA2EmF":{"name":"esEsBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO19esEsNarrowbandmodelA2EmF":{"name":"esEsNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18frFrBroadbandmodelA2EmF":{"name":"frFrBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18jaJpBroadbandmodelA2EmF":{"name":"jaJpBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO19jaJpNarrowbandmodelA2EmF":{"name":"jaJpNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18koKrBroadbandmodelA2EmF":{"name":"koKrBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO19koKrNarrowbandmodelA2EmF":{"name":"koKrNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html":{"name":"BaseModelName","abstract":"

    The name of the base language model that is to be customized by the new custom language model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports language model customization, request information about the base model and check that the attribute custom_language_model is set to true, or refer to Language support for customization.

    ","parent_name":"CreateLanguageModel"},"Structs/CreateLanguageModel.html#/s:14SpeechToTextV119CreateLanguageModelV4nameSSvp":{"name":"name","abstract":"

    A user-defined name for the new custom language model. Use a name that is unique among all custom language models that you own. Use a localized name that matches the language of the custom model. Use a name that describes the domain of the custom model, such as Medical custom model or Legal custom model.

    ","parent_name":"CreateLanguageModel"},"Structs/CreateLanguageModel.html#/s:14SpeechToTextV119CreateLanguageModelV04baseG4NameSSvp":{"name":"baseModelName","abstract":"

    The name of the base language model that is to be customized by the new custom language model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports language model customization, request information about the base model and check that the attribute custom_language_model is set to true, or refer to Language support for customization.

    ","parent_name":"CreateLanguageModel"},"Structs/CreateLanguageModel.html#/s:14SpeechToTextV119CreateLanguageModelV7dialectSSSgvp":{"name":"dialect","abstract":"

    The dialect of the specified language that is to be used with the custom language model. The parameter is meaningful only for Spanish models, for which the service creates a custom language model that is suited for speech in one of the following dialects: * es-ES for Castilian Spanish (the default) * es-LA for Latin American Spanish * es-US for North American (Mexican) Spanish A specified dialect must be valid for the base model. By default, the dialect matches the language of the base model; for example, en-US for either of the US English language models.

    ","parent_name":"CreateLanguageModel"},"Structs/CreateLanguageModel.html#/s:14SpeechToTextV119CreateLanguageModelV11descriptionSSSgvp":{"name":"description","abstract":"

    A description of the new custom language model. Use a localized description that matches the language of the custom model.

    ","parent_name":"CreateLanguageModel"},"Structs/CreateLanguageModel.html#/s:14SpeechToTextV119CreateLanguageModelVACSS4name_SS04baseG4NameSSSg7dialectAF11descriptiontcfc":{"name":"init(name:baseModelName:dialect:description:)","abstract":"

    Initialize a CreateLanguageModel with member variables.

    ","parent_name":"CreateLanguageModel"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18arArBroadbandmodelA2EmF":{"name":"arArBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18enGbBroadbandmodelA2EmF":{"name":"enGbBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19enGbNarrowbandmodelA2EmF":{"name":"enGbNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18enUsBroadbandmodelA2EmF":{"name":"enUsBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19enUsNarrowbandmodelA2EmF":{"name":"enUsNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18esEsBroadbandmodelA2EmF":{"name":"esEsBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19esEsNarrowbandmodelA2EmF":{"name":"esEsNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18frFrBroadbandmodelA2EmF":{"name":"frFrBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18jaJpBroadbandmodelA2EmF":{"name":"jaJpBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19jaJpNarrowbandmodelA2EmF":{"name":"jaJpNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18koKrBroadbandmodelA2EmF":{"name":"koKrBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19koKrNarrowbandmodelA2EmF":{"name":"koKrNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18ptBrBroadbandmodelA2EmF":{"name":"ptBrBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19ptBrNarrowbandmodelA2EmF":{"name":"ptBrNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18zhCnBroadbandmodelA2EmF":{"name":"zhCnBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19zhCnNarrowbandmodelA2EmF":{"name":"zhCnNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html":{"name":"BaseModelName","abstract":"

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports acoustic model customization, refer to Language support for customization.

    ","parent_name":"CreateAcousticModel"},"Structs/CreateAcousticModel.html#/s:14SpeechToTextV119CreateAcousticModelV4nameSSvp":{"name":"name","abstract":"

    A user-defined name for the new custom acoustic model. Use a name that is unique among all custom acoustic models that you own. Use a localized name that matches the language of the custom model. Use a name that describes the acoustic environment of the custom model, such as Mobile custom model or Noisy car custom model.

    ","parent_name":"CreateAcousticModel"},"Structs/CreateAcousticModel.html#/s:14SpeechToTextV119CreateAcousticModelV04baseG4NameSSvp":{"name":"baseModelName","abstract":"

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model can be used only with the base model that it customizes. To determine whether a base model supports acoustic model customization, refer to Language support for customization.

    ","parent_name":"CreateAcousticModel"},"Structs/CreateAcousticModel.html#/s:14SpeechToTextV119CreateAcousticModelV11descriptionSSSgvp":{"name":"description","abstract":"

    A description of the new custom acoustic model. Use a localized description that matches the language of the custom model.

    ","parent_name":"CreateAcousticModel"},"Structs/CreateAcousticModel.html#/s:14SpeechToTextV119CreateAcousticModelVACSS4name_SS04baseG4NameSSSg11descriptiontcfc":{"name":"init(name:baseModelName:description:)","abstract":"

    Initialize a CreateAcousticModel with member variables.

    ","parent_name":"CreateAcousticModel"},"Structs/Corpus/Status.html#/s:14SpeechToTextV16CorpusV6StatusO8analyzedA2EmF":{"name":"analyzed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Corpus/Status.html#/s:14SpeechToTextV16CorpusV6StatusO14beingProcessedA2EmF":{"name":"beingProcessed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Corpus/Status.html#/s:14SpeechToTextV16CorpusV6StatusO12undeterminedA2EmF":{"name":"undetermined","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Corpus/Status.html":{"name":"Status","abstract":"

    The status of the corpus: * analyzed indicates that the service has successfully analyzed the corpus; the custom model can be trained with data from the corpus. * being_processed indicates that the service is still analyzing the corpus; the service cannot accept requests to add new corpora or words, or to train the custom model. * undetermined indicates that the service encountered an error while processing the corpus.

    ","parent_name":"Corpus"},"Structs/Corpus.html#/s:14SpeechToTextV16CorpusV4nameSSvp":{"name":"name","abstract":"

    The name of the corpus.

    ","parent_name":"Corpus"},"Structs/Corpus.html#/s:14SpeechToTextV16CorpusV10totalWordsSivp":{"name":"totalWords","abstract":"

    The total number of words in the corpus. The value is 0 while the corpus is being processed.

    ","parent_name":"Corpus"},"Structs/Corpus.html#/s:14SpeechToTextV16CorpusV20outOfVocabularyWordsSivp":{"name":"outOfVocabularyWords","abstract":"

    The number of OOV words in the corpus. The value is 0 while the corpus is being processed.

    ","parent_name":"Corpus"},"Structs/Corpus.html#/s:14SpeechToTextV16CorpusV6statusSSvp":{"name":"status","abstract":"

    The status of the corpus: * analyzed indicates that the service has successfully analyzed the corpus; the custom model can be trained with data from the corpus. * being_processed indicates that the service is still analyzing the corpus; the service cannot accept requests to add new corpora or words, or to train the custom model. * undetermined indicates that the service encountered an error while processing the corpus.

    ","parent_name":"Corpus"},"Structs/Corpus.html#/s:14SpeechToTextV16CorpusV5errorSSSgvp":{"name":"error","abstract":"

    If the status of the corpus is undetermined, the following message: Analysis of corpus 'name' failed. Please try adding the corpus again by setting the 'allow_overwrite' flag to 'true'.

    ","parent_name":"Corpus"},"Structs/Corpora.html#/s:14SpeechToTextV17CorporaV7corporaSayAA6CorpusVGvp":{"name":"corpora","abstract":"

    Information about corpora of the custom model. The array is empty if the custom model has no corpora.

    ","parent_name":"Corpora"},"Structs/AudioResources.html#/s:14SpeechToTextV114AudioResourcesV014totalMinutesOfE0Sdvp":{"name":"totalMinutesOfAudio","abstract":"

    The total minutes of accumulated audio summed over all of the valid audio resources for the custom acoustic model. You can use this value to determine whether the custom model has too little or too much audio to begin training.

    ","parent_name":"AudioResources"},"Structs/AudioResources.html#/s:14SpeechToTextV114AudioResourcesV5audioSayAA0E8ResourceVGvp":{"name":"audio","abstract":"

    An array of AudioResource objects that provides information about the audio resources of the custom acoustic model. The array is empty if the custom model has no audio resources.

    ","parent_name":"AudioResources"},"Structs/AudioResource/Status.html#/s:14SpeechToTextV113AudioResourceV6StatusO2okA2EmF":{"name":"ok","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioResource/Status.html#/s:14SpeechToTextV113AudioResourceV6StatusO14beingProcessedA2EmF":{"name":"beingProcessed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioResource/Status.html#/s:14SpeechToTextV113AudioResourceV6StatusO7invalidA2EmF":{"name":"invalid","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioResource/Status.html":{"name":"Status","abstract":"

    The status of the audio resource: * ok indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * being_processed indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * invalid indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if any of its audio files are invalid.

    ","parent_name":"AudioResource"},"Structs/AudioResource.html#/s:14SpeechToTextV113AudioResourceV8durationSdvp":{"name":"duration","abstract":"

    The total seconds of audio in the audio resource.

    ","parent_name":"AudioResource"},"Structs/AudioResource.html#/s:14SpeechToTextV113AudioResourceV4nameSSvp":{"name":"name","abstract":"

    The name of the audio resource.

    ","parent_name":"AudioResource"},"Structs/AudioResource.html#/s:14SpeechToTextV113AudioResourceV7detailsAA0E7DetailsVvp":{"name":"details","abstract":"

    An AudioDetails object that provides detailed information about the audio resource. The object is empty until the service finishes processing the audio.

    ","parent_name":"AudioResource"},"Structs/AudioResource.html#/s:14SpeechToTextV113AudioResourceV6statusSSvp":{"name":"status","abstract":"

    The status of the audio resource: * ok indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * being_processed indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * invalid indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). For an archive file, the entire archive is invalid if any of its audio files are invalid.

    ","parent_name":"AudioResource"},"Structs/AudioListing/Status.html#/s:14SpeechToTextV112AudioListingV6StatusO2okA2EmF":{"name":"ok","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioListing/Status.html#/s:14SpeechToTextV112AudioListingV6StatusO14beingProcessedA2EmF":{"name":"beingProcessed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioListing/Status.html#/s:14SpeechToTextV112AudioListingV6StatusO7invalidA2EmF":{"name":"invalid","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioListing/Status.html":{"name":"Status","abstract":"

    For an audio-type resource,** the status of the resource: * ok indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * being_processed indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * invalid indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). Omitted for an archive-type resource.

    ","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV8durationSdSgvp":{"name":"duration","abstract":"

    For an audio-type resource,** the total seconds of audio in the resource. Omitted for an archive-type resource.

    ","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV4nameSSSgvp":{"name":"name","abstract":"

    For an audio-type resource,** the name of the resource. Omitted for an archive-type resource.

    ","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV7detailsAA0E7DetailsVSgvp":{"name":"details","abstract":"

    For an audio-type resource,** an AudioDetails object that provides detailed information about the resource. The object is empty until the service finishes processing the audio. Omitted for an archive-type resource.

    ","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV6statusSSSgvp":{"name":"status","abstract":"

    For an audio-type resource,** the status of the resource: * ok indicates that the service has successfully analyzed the audio data. The data can be used to train the custom model. * being_processed indicates that the service is still analyzing the audio data. The service cannot accept requests to add new audio resources or to train the custom model until its analysis is complete. * invalid indicates that the audio data is not valid for training the custom model (possibly because it has the wrong format or sampling rate, or because it is corrupted). Omitted for an archive-type resource.

    ","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV9containerAA0E8ResourceVSgvp":{"name":"container","abstract":"

    For an archive-type resource,** an object of type AudioResource that provides information about the resource. Omitted for an audio-type resource.

    ","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV5audioSayAA0E8ResourceVGSgvp":{"name":"audio","abstract":"

    For an archive-type resource,** an array of AudioResource objects that provides information about the audio-type resources that are contained in the resource. Omitted for an audio-type resource.

    ","parent_name":"AudioListing"},"Structs/AudioDetails/Compression.html#/s:14SpeechToTextV112AudioDetailsV11CompressionO3zipA2EmF":{"name":"zip","abstract":"

    Undocumented

    ","parent_name":"Compression"},"Structs/AudioDetails/Compression.html#/s:14SpeechToTextV112AudioDetailsV11CompressionO4gzipA2EmF":{"name":"gzip","abstract":"

    Undocumented

    ","parent_name":"Compression"},"Structs/AudioDetails/ModelType.html#/s:14SpeechToTextV112AudioDetailsV9ModelTypeO5audioA2EmF":{"name":"audio","abstract":"

    Undocumented

    ","parent_name":"ModelType"},"Structs/AudioDetails/ModelType.html#/s:14SpeechToTextV112AudioDetailsV9ModelTypeO7archiveA2EmF":{"name":"archive","abstract":"

    Undocumented

    ","parent_name":"ModelType"},"Structs/AudioDetails/ModelType.html":{"name":"ModelType","abstract":"

    The type of the audio resource: * audio for an individual audio file * archive for an archive (.zip or .tar.gz) file that contains audio files.

    ","parent_name":"AudioDetails"},"Structs/AudioDetails/Compression.html":{"name":"Compression","abstract":"

    For an archive-type resource,** the format of the compressed archive: * zip for a .zip file * gzip for a .tar.gz file Omitted for an audio-type resource.

    ","parent_name":"AudioDetails"},"Structs/AudioDetails.html#/s:14SpeechToTextV112AudioDetailsV4typeSSSgvp":{"name":"type","abstract":"

    The type of the audio resource: * audio for an individual audio file * archive for an archive (.zip or .tar.gz) file that contains audio files.

    ","parent_name":"AudioDetails"},"Structs/AudioDetails.html#/s:14SpeechToTextV112AudioDetailsV5codecSSSgvp":{"name":"codec","abstract":"

    For an audio-type resource,** the codec in which the audio is encoded. Omitted for an archive-type resource.

    ","parent_name":"AudioDetails"},"Structs/AudioDetails.html#/s:14SpeechToTextV112AudioDetailsV9frequencySiSgvp":{"name":"frequency","abstract":"

    For an audio-type resource,** the sampling rate of the audio in Hertz (samples per second). Omitted for an archive-type resource.

    ","parent_name":"AudioDetails"},"Structs/AudioDetails.html#/s:14SpeechToTextV112AudioDetailsV11compressionSSSgvp":{"name":"compression","abstract":"

    For an archive-type resource,** the format of the compressed archive: * zip for a .zip file * gzip for a .tar.gz file Omitted for an audio-type resource.

    ","parent_name":"AudioDetails"},"Structs/AcousticModels.html#/s:14SpeechToTextV114AcousticModelsV14customizationsSayAA0E5ModelVGvp":{"name":"customizations","abstract":"

    An array of objects that provides information about each available custom acoustic model. The array is empty if the requesting service credentials own no custom acoustic models (if no language is specified) or own no custom acoustic models for the specified language.

    ","parent_name":"AcousticModels"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO7pendingA2EmF":{"name":"pending","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO5readyA2EmF":{"name":"ready","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO8trainingA2EmF":{"name":"training","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO9availableA2EmF":{"name":"available","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO9upgradingA2EmF":{"name":"upgrading","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO6failedA2EmF":{"name":"failed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html":{"name":"Status","abstract":"

    The current status of the custom acoustic model: * pending indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * ready indicates that the model contains data and is ready to be trained. * training indicates that the model is currently being trained. * available indicates that the model is trained and ready to use. * upgrading indicates that the model is currently being upgraded. * failed indicates that training of the model failed.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV15customizationIDSSvp":{"name":"customizationID","abstract":"

    The customization ID (GUID) of the custom acoustic model. The Create a custom acoustic model method returns only this field of the object; it does not return the other fields.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV7createdSSSgvp":{"name":"created","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the custom acoustic model was created. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV8languageSSSgvp":{"name":"language","abstract":"

    The language identifier of the custom acoustic model (for example, en-US).

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV8versionsSaySSGSgvp":{"name":"versions","abstract":"

    A list of the available versions of the custom acoustic model. Each element of the array indicates a version of the base model with which the custom model can be used. Multiple versions exist only if the custom model has been upgraded; otherwise, only a single version is shown.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV5ownerSSSgvp":{"name":"owner","abstract":"

    The GUID of the service credentials for the instance of the service that owns the custom acoustic model.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV4nameSSSgvp":{"name":"name","abstract":"

    The name of the custom acoustic model.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV11descriptionSSSgvp":{"name":"description","abstract":"

    The description of the custom acoustic model.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV04baseF4NameSSSgvp":{"name":"baseModelName","abstract":"

    The name of the language model for which the custom acoustic model was created.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV6statusSSSgvp":{"name":"status","abstract":"

    The current status of the custom acoustic model: * pending indicates that the model was created but is waiting either for training data to be added or for the service to finish analyzing added data. * ready indicates that the model contains data and is ready to be trained. * training indicates that the model is currently being trained. * available indicates that the model is trained and ready to use. * upgrading indicates that the model is currently being upgraded. * failed indicates that training of the model failed.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV8progressSiSgvp":{"name":"progress","abstract":"

    A percentage that indicates the progress of the custom acoustic model’s current training. A value of 100 means that the model is fully trained. Note: The progress field does not currently reflect the progress of the training. The field changes from 0 to 100 when training is complete.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV8warningsSSSgvp":{"name":"warnings","abstract":"

    If the request included unknown parameters, the following message: Unexpected query parameter(s) ['parameters'] detected, where parameters is a list that includes a quoted string for each unknown parameter.

    ","parent_name":"AcousticModel"},"Structs.html#/s:14SpeechToTextV111JSONWrapperV":{"name":"JSONWrapper","abstract":"

    Used internally to serialize and deserialize JSON."},"Structs/AcousticModel.html":{"name":"AcousticModel","abstract":"

    AcousticModel.

    "},"Structs/AcousticModels.html":{"name":"AcousticModels","abstract":"

    AcousticModels.

    "},"Structs/AudioDetails.html":{"name":"AudioDetails","abstract":"

    AudioDetails.

    "},"Structs/AudioListing.html":{"name":"AudioListing","abstract":"

    AudioListing.

    "},"Structs/AudioResource.html":{"name":"AudioResource","abstract":"

    AudioResource.

    "},"Structs/AudioResources.html":{"name":"AudioResources","abstract":"

    AudioResources.

    "},"Structs/Corpora.html":{"name":"Corpora","abstract":"

    Corpora.

    "},"Structs/Corpus.html":{"name":"Corpus","abstract":"

    Corpus.

    "},"Structs/CreateAcousticModel.html":{"name":"CreateAcousticModel","abstract":"

    CreateAcousticModel.

    "},"Structs/CreateLanguageModel.html":{"name":"CreateLanguageModel","abstract":"

    CreateLanguageModel.

    "},"Structs/CustomWord.html":{"name":"CustomWord","abstract":"

    CustomWord.

    "},"Structs/CustomWords.html":{"name":"CustomWords","abstract":"

    CustomWords.

    "},"Structs/KeywordResult.html":{"name":"KeywordResult","abstract":"

    KeywordResult.

    "},"Structs/LanguageModel.html":{"name":"LanguageModel","abstract":"

    LanguageModel.

    "},"Structs/LanguageModels.html":{"name":"LanguageModels","abstract":"

    LanguageModels.

    "},"Structs/RecognitionJob.html":{"name":"RecognitionJob","abstract":"

    RecognitionJob.

    "},"Structs/RecognitionJobs.html":{"name":"RecognitionJobs","abstract":"

    RecognitionJobs.

    "},"Structs/RegisterStatus.html":{"name":"RegisterStatus","abstract":"

    RegisterStatus.

    "},"Structs/SpeakerLabelsResult.html":{"name":"SpeakerLabelsResult","abstract":"

    SpeakerLabelsResult.

    "},"Structs/SpeechModel.html":{"name":"SpeechModel","abstract":"

    SpeechModel.

    "},"Structs/SpeechModels.html":{"name":"SpeechModels","abstract":"

    SpeechModels.

    "},"Structs/SpeechRecognitionAlternative.html":{"name":"SpeechRecognitionAlternative","abstract":"

    SpeechRecognitionAlternative.

    "},"Structs/SpeechRecognitionResult.html":{"name":"SpeechRecognitionResult","abstract":"

    SpeechRecognitionResult.

    "},"Structs/SpeechRecognitionResults.html":{"name":"SpeechRecognitionResults","abstract":"

    SpeechRecognitionResults.

    "},"Structs/SupportedFeatures.html":{"name":"SupportedFeatures","abstract":"

    SupportedFeatures.

    "},"Structs/Word.html":{"name":"Word","abstract":"

    Word.

    "},"Structs/WordAlternativeResult.html":{"name":"WordAlternativeResult","abstract":"

    WordAlternativeResult.

    "},"Structs/WordAlternativeResults.html":{"name":"WordAlternativeResults","abstract":"

    WordAlternativeResults.

    "},"Structs/WordConfidence.html":{"name":"WordConfidence","abstract":"

    The confidence of a word in a Speech to Text transcription.

    "},"Structs/WordError.html":{"name":"WordError","abstract":"

    WordError.

    "},"Structs/WordTimestamp.html":{"name":"WordTimestamp","abstract":"

    The timestamp of a word in a Speech to Text transcription.

    "},"Structs/Words.html":{"name":"Words","abstract":"

    Words.

    "},"Structs/RecognitionSettings.html":{"name":"RecognitionSettings","abstract":"

    The settings associated with a Speech to Text recognition request. Any nil parameters will"},"Structs/SpeechRecognitionResultsAccumulator.html":{"name":"SpeechRecognitionResultsAccumulator","abstract":"

    SpeechRecognitionResultsAccumulator.

    "},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

    No response was received from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

    No data was returned from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO013serializationF0A2CmF":{"name":"serializationError","abstract":"

    Failed to serialize value(s) to data.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO08encodingF0A2CmF":{"name":"encodingError","abstract":"

    Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO011fileManagerF0A2CmF":{"name":"fileManagerError","abstract":"

    FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

    Failed to load the given file.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

    An HTTP error with a status code and description.

    ","parent_name":"RestError"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO4nullA2CmF":{"name":"null","abstract":"

    A null value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

    A boolean value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO6stringACSScACmF":{"name":"string","abstract":"

    A string value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO3intACSicACmF":{"name":"int","abstract":"

    A number value, represented as an integer.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

    A number value, represented as a double.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

    An array value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

    An object value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Decode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

    Initialize a JSON value from an encodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

    Convert this JSON value to a decodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

    Encode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compare two JSON values for equality.

    ","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

    A JSON value (one of string, number, object, array, true, false, or null).

    "},"Enums/RestError.html":{"name":"RestError","abstract":"

    An error from processing a network request or response.

    "},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC10serviceURLSSvp":{"name":"serviceURL","abstract":"

    The base URL of the Speech to Text service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC8tokenURLSSvp":{"name":"tokenURL","abstract":"

    The URL that shall be used to obtain a token.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC13websocketsURLSSvp":{"name":"websocketsURL","abstract":"

    The URL that shall be used to stream audio for transcription.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

    The default HTTP headers for all requests to the service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC7resultsAA0A18RecognitionResultsVvp":{"name":"results","abstract":"

    The results of the most recent recognition request.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC9onConnectyycSgvp":{"name":"onConnect","abstract":"

    Invoked when the session connects to the Speech to Text service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC16onMicrophoneDatay10Foundation0H0VcSgvp":{"name":"onMicrophoneData","abstract":"

    Invoked with microphone audio when a recording audio queue buffer has been filled.","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC11onPowerDataySfcSgvp":{"name":"onPowerData","abstract":"

    Invoked every 0.025s when recording with the average dB power of the microphone.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC9onResultsyAA0a11RecognitionG0VcSgvp":{"name":"onResults","abstract":"

    Invoked when transcription results are received for a recognition request.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC7onErrorys0G0_pcSgvp":{"name":"onError","abstract":"

    Invoked when an error or warning occurs.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC12onDisconnectyycSgvp":{"name":"onDisconnect","abstract":"

    Invoked when the session disconnects from the Speech to Text service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionCACSS8username_SS8passwordSSSg5modelAF15customizationIDSbSg14learningOptOuttcfc":{"name":"init(username:password:model:customizationID:learningOptOut:)","abstract":"

    Create a SpeechToTextSession object.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC7connectyyF":{"name":"connect()","abstract":"

    Connect to the Speech to Text service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC12startRequestyAA19RecognitionSettingsV8settings_tF":{"name":"startRequest(settings:)","abstract":"

    Start a recognition request.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC9recognizey10Foundation3URLV5audio_tF":{"name":"recognize(audio:)","abstract":"

    Send an audio file to transcribe.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC9recognizey10Foundation4DataV5audio_tF":{"name":"recognize(audio:)","abstract":"

    Send audio data to transcribe.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC15startMicrophoneySb8compress_tF":{"name":"startMicrophone(compress:)","abstract":"

    Start streaming microphone audio data to transcribe.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC14stopMicrophoneyyF":{"name":"stopMicrophone()","abstract":"

    Stop streaming microphone audio data to transcribe.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC11stopRequestyyF":{"name":"stopRequest()","abstract":"

    Stop the recognition request.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC10disconnectyyF":{"name":"disconnect()","abstract":"

    Wait for any queued recognition requests to complete then disconnect from the service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

    The base URL to use when contacting the service.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8tokenURLSSvp":{"name":"tokenURL","abstract":"

    The URL that shall be used to obtain a token.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C13websocketsURLSSvp":{"name":"websocketsURL","abstract":"

    The URL that shall be used to stream audio for transcription.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

    The default HTTP headers for all requests to the service.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0CACSS8username_SS8passwordtcfc":{"name":"init(username:password:)","abstract":"

    Create a SpeechToText object.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

    Create a SpeechToText object.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

    Create a SpeechToText object.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

    Undocumented

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C10listModelsys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA0aF0Vc7successtF":{"name":"listModels(headers:failure:success:)","abstract":"

    Get models.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8getModelySS7modelID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0aF0Vc7successtF":{"name":"getModel(modelID:headers:failure:success:)","abstract":"

    Get a model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C20recognizeSessionlessySSSg5model_AE15customizationIDAE021acousticCustomizationI0AE16baseModelVersionSdSg0H6Weight10Foundation4DataVSg5audioAE11contentTypeSiSg17inactivityTimeoutSaySSGSg8keywordsAJ0W9ThresholdAR15maxAlternativesAJ04wordzX0SbSg14wordConfidenceAZ10timestampsAZ15profanityFilterAZ15smartFormattingAZ13speakerLabelss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0A18RecognitionResultsVc7successtF":{"name":"recognizeSessionless(model:customizationID:acousticCustomizationID:baseModelVersion:customizationWeight:audio:contentType:inactivityTimeout:keywords:keywordsThreshold:maxAlternatives:wordAlternativesThreshold:wordConfidence:timestamps:profanityFilter:smartFormatting:speakerLabels:headers:failure:success:)","abstract":"

    Sends audio for speech recognition in sessionless mode.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C16registerCallbackySS11callbackUrl_SSSg10userSecrets10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA14RegisterStatusVc7successtF":{"name":"registerCallback(callbackUrl:userSecret:headers:failure:success:)","abstract":"

    Register a callback.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18unregisterCallbackySS11callbackUrl_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"unregisterCallback(callbackUrl:headers:failure:success:)","abstract":"

    Unregister a callback.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9createJoby10Foundation4DataV5audio_SS11contentTypeSSSg5modelAJ11callbackUrlAJ6eventsAJ9userTokenSiSg10resultsTtlAJ15customizationIDAJ021acousticCustomizationU0AJ16baseModelVersionSdSg0T6WeightAO17inactivityTimeoutSaySSGSg8keywordsAT17keywordsThresholdAO15maxAlternativesAT25wordAlternativesThresholdSbSg14wordConfidenceA1_10timestampsA1_15profanityFilterA1_15smartFormattingA1_13speakerLabelss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA011RecognitionF0Vc7successtF":{"name":"createJob(audio:contentType:model:callbackUrl:events:userToken:resultsTtl:customizationID:acousticCustomizationID:baseModelVersion:customizationWeight:inactivityTimeout:keywords:keywordsThreshold:maxAlternatives:wordAlternativesThreshold:wordConfidence:timestamps:profanityFilter:smartFormatting:speakerLabels:headers:failure:success:)","abstract":"

    Create a job.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9checkJobsys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA011RecognitionF0Vc7successtF":{"name":"checkJobs(headers:failure:success:)","abstract":"

    Check jobs.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8checkJobySS2id_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA011RecognitionF0Vc7successtF":{"name":"checkJob(id:headers:failure:success:)","abstract":"

    Check a job.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9deleteJobySS2id_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteJob(id:headers:failure:success:)","abstract":"

    Delete a job.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C19createLanguageModelyAA06CreatefG0VAD_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"createLanguageModel(createLanguageModel:headers:failure:success:)","abstract":"

    Create a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18listLanguageModelsySSSg8language_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"listLanguageModels(language:headers:failure:success:)","abstract":"

    List custom language models.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C16getLanguageModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"getLanguageModel(customizationID:headers:failure:success:)","abstract":"

    List a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C19deleteLanguageModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteLanguageModel(customizationID:headers:failure:success:)","abstract":"

    Delete a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18trainLanguageModelySS15customizationID_SSSg08wordTypeB3AddSdSg0H6Weights10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"trainLanguageModel(customizationID:wordTypeToAdd:customizationWeight:headers:failure:success:)","abstract":"

    Train a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18resetLanguageModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"resetLanguageModel(customizationID:headers:failure:success:)","abstract":"

    Reset a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C20upgradeLanguageModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"upgradeLanguageModel(customizationID:headers:failure:success:)","abstract":"

    Upgrade a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C11listCorporaySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"listCorpora(customizationID:headers:failure:success:)","abstract":"

    List corpora.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9addCorpusySS15customizationID_SS10corpusName10Foundation3URLV0I4FileSbSg14allowOverwriteSSSg0iM11ContentTypes10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addCorpus(customizationID:corpusName:corpusFile:allowOverwrite:corpusFileContentType:headers:failure:success:)","abstract":"

    Add a corpus.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9getCorpusySS15customizationID_SS10corpusNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"getCorpus(customizationID:corpusName:headers:failure:success:)","abstract":"

    List a corpus.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C12deleteCorpusySS15customizationID_SS10corpusNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteCorpus(customizationID:corpusName:headers:failure:success:)","abstract":"

    Delete a corpus.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9listWordsySS15customizationID_SSSg8wordTypeAF4sorts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"listWords(customizationID:wordType:sort:headers:failure:success:)","abstract":"

    List custom words.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8addWordsySS15customizationID_SayAA10CustomWordVG5wordss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addWords(customizationID:words:headers:failure:success:)","abstract":"

    Add custom words.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C7addWordySS15customizationID_SS8wordNameSSSg0I0SaySSGSg10soundsLikeAG9displayAss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addWord(customizationID:wordName:word:soundsLike:displayAs:headers:failure:success:)","abstract":"

    Add a custom word.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C7getWordySS15customizationID_SS8wordNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"getWord(customizationID:wordName:headers:failure:success:)","abstract":"

    List a custom word.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C10deleteWordySS15customizationID_SS8wordNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteWord(customizationID:wordName:headers:failure:success:)","abstract":"

    Delete a custom word.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C19createAcousticModelySS4name_SS04baseG4NameSSSg11descriptions10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"createAcousticModel(name:baseModelName:description:headers:failure:success:)","abstract":"

    Create a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18listAcousticModelsySSSg8language_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"listAcousticModels(language:headers:failure:success:)","abstract":"

    List custom acoustic models.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C16getAcousticModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"getAcousticModel(customizationID:headers:failure:success:)","abstract":"

    List a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C19deleteAcousticModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteAcousticModel(customizationID:headers:failure:success:)","abstract":"

    Delete a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18trainAcousticModelySS15customizationID_SSSg014customLanguagegI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"trainAcousticModel(customizationID:customLanguageModelID:headers:failure:success:)","abstract":"

    Train a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18resetAcousticModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"resetAcousticModel(customizationID:headers:failure:success:)","abstract":"

    Reset a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C20upgradeAcousticModelySS15customizationID_SSSg014customLanguagegI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"upgradeAcousticModel(customizationID:customLanguageModelID:headers:failure:success:)","abstract":"

    Upgrade a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9listAudioySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F9ResourcesVc7successtF":{"name":"listAudio(customizationID:headers:failure:success:)","abstract":"

    List audio resources.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8addAudioySS15customizationID_SS9audioName10Foundation4DataV0I8ResourceSS11contentTypeSSSg016containedContentO0SbSg14allowOverwrites10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addAudio(customizationID:audioName:audioResource:contentType:containedContentType:allowOverwrite:headers:failure:success:)","abstract":"

    Add an audio resource.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8getAudioySS15customizationID_SS9audioNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F7ListingVc7successtF":{"name":"getAudio(customizationID:audioName:headers:failure:success:)","abstract":"

    List an audio resource.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C11deleteAudioySS15customizationID_SS9audioNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteAudio(customizationID:audioName:headers:failure:success:)","abstract":"

    Delete an audio resource.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

    Delete labeled data.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9recognizey10Foundation3URLV5audio_AA19RecognitionSettingsV8settingsSSSg5modelAL15customizationIDSbSg14learningOptOutys5Error_pcSg7failureyAA0aI7ResultsVc7successtF":{"name":"recognize(audio:settings:model:customizationID:learningOptOut:failure:success:)","abstract":"

    Perform speech recognition for an audio file.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9recognizey10Foundation4DataV5audio_AA19RecognitionSettingsV8settingsSSSg5modelAL15customizationIDSbSg14learningOptOutys5Error_pcSg7failureyAA0aI7ResultsVc7successtF":{"name":"recognize(audio:settings:model:customizationID:learningOptOut:failure:success:)","abstract":"

    Perform speech recognition for audio data.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C19recognizeMicrophoneyAA19RecognitionSettingsV8settings_SSSg5modelAH15customizationIDSbSg14learningOptOutSb8compressys5Error_pcSg7failureyAA0aG7ResultsVc7successtF":{"name":"recognizeMicrophone(settings:model:customizationID:learningOptOut:compress:failure:success:)","abstract":"

    Perform speech recognition for microphone audio. To stop the microphone, invoke","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C23stopRecognizeMicrophoneyyF":{"name":"stopRecognizeMicrophone()","abstract":"

    Stop performing speech recognition for microphone audio.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html":{"name":"SpeechToText","abstract":"

    The IBM® Speech to Text service provides an API that uses IBM’s speech-recognition capabilities to produce"},"Classes/SpeechToTextSession.html":{"name":"SpeechToTextSession","abstract":"

    The IBM Watson Speech to Text service enables you to add speech transcription capabilities to"},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "}} \ No newline at end of file +{"Structs/SpeechRecognitionResultsAccumulator.html#/s:14SpeechToTextV10A29RecognitionResultsAccumulatorV7resultsSayAA0aE6ResultVGvp":{"name":"results","abstract":"

    All accumulated recognition results.

    ","parent_name":"SpeechRecognitionResultsAccumulator"},"Structs/SpeechRecognitionResultsAccumulator.html#/s:14SpeechToTextV10A29RecognitionResultsAccumulatorV13speakerLabelsSayAA07SpeakerI6ResultVGvp":{"name":"speakerLabels","abstract":"

    All accumulated speaker labels.

    ","parent_name":"SpeechRecognitionResultsAccumulator"},"Structs/SpeechRecognitionResultsAccumulator.html#/s:14SpeechToTextV10A29RecognitionResultsAccumulatorV14bestTranscriptSSvp":{"name":"bestTranscript","abstract":"

    A concatenation of transcripts with the greatest confidence.

    ","parent_name":"SpeechRecognitionResultsAccumulator"},"Structs/SpeechRecognitionResultsAccumulator.html#/s:14SpeechToTextV10A29RecognitionResultsAccumulatorVACycfc":{"name":"init()","abstract":"

    Initialize a SpeechRecognitionResultsAccumulator to accumulate recognition results.

    ","parent_name":"SpeechRecognitionResultsAccumulator"},"Structs/SpeechRecognitionResultsAccumulator.html#/s:14SpeechToTextV10A29RecognitionResultsAccumulatorV3addyAA0aeF0V7results_tF":{"name":"add(results:)","abstract":"

    Add recognition results to be accumulated.

    ","parent_name":"SpeechRecognitionResultsAccumulator"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV11contentTypeSSvp":{"name":"contentType","abstract":"

    The format of the audio data. Endianness is automatically detected by the Speech to Text","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV17inactivityTimeoutSiSgvp":{"name":"inactivityTimeout","abstract":"

    The number of seconds after which the connection is to time out due to inactivity.","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV8keywordsSaySSGSgvp":{"name":"keywords","abstract":"

    An array of keyword strings to be matched in the input audio. By default, the service","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV17keywordsThresholdSdSgvp":{"name":"keywordsThreshold","abstract":"

    A minimum level of confidence that the service must have to report a matching keyword","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV15maxAlternativesSiSgvp":{"name":"maxAlternatives","abstract":"

    The maximum number of alternative transcriptions to receive. The default is 1.

    ","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV14interimResultsSbSgvp":{"name":"interimResults","abstract":"

    If true, then interim results (i.e. results that are not final) will be received","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV25wordAlternativesThresholdSdSgvp":{"name":"wordAlternativesThreshold","abstract":"

    A minimum level of confidence that the service must have to report a hypothesis for a","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV14wordConfidenceSbSgvp":{"name":"wordConfidence","abstract":"

    If true, then a confidence score will be received for each word of the transcription.","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV10timestampsSbSgvp":{"name":"timestamps","abstract":"

    If true, then per-word start and end times relative to the beginning of the audio will","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV15filterProfanitySbSgvp":{"name":"filterProfanity","abstract":"

    If true, then profanity will be censored from the service’s output, obscuring each","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV15smartFormattingSbSgvp":{"name":"smartFormatting","abstract":"

    Indicates whether dates, times, series of digits and numbers, phone numbers, currency values,","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsV13speakerLabelsSbSgvp":{"name":"speakerLabels","abstract":"

    If true, then speaker labels will be returned for each timestamp. The default is false.

    ","parent_name":"RecognitionSettings"},"Structs/RecognitionSettings.html#/s:14SpeechToTextV119RecognitionSettingsVACSS11contentType_tcfc":{"name":"init(contentType:)","abstract":"

    Initialize a RecognitionSettings object to set the parameters of a Watson Speech to","parent_name":"RecognitionSettings"},"Structs/Words.html#/s:14SpeechToTextV15WordsV5wordsSayAA4WordVGvp":{"name":"words","abstract":"

    An array of objects that provides information about each word in the custom model’s words resource. The array is","parent_name":"Words"},"Structs/WordTimestamp.html#/s:14SpeechToTextV113WordTimestampV4wordSSvp":{"name":"word","abstract":"

    A particular word from the transcription.

    ","parent_name":"WordTimestamp"},"Structs/WordTimestamp.html#/s:14SpeechToTextV113WordTimestampV9startTimeSdvp":{"name":"startTime","abstract":"

    The start time, in seconds, of the given word in the audio input.

    ","parent_name":"WordTimestamp"},"Structs/WordTimestamp.html#/s:14SpeechToTextV113WordTimestampV7endTimeSdvp":{"name":"endTime","abstract":"

    The end time, in seconds, of the given word in the audio input.

    ","parent_name":"WordTimestamp"},"Structs/WordTimestamp.html#/s:14SpeechToTextV113WordTimestampVACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Used internally to initialize a WordTimestamp model from JSON.

    ","parent_name":"WordTimestamp"},"Structs/WordError.html#/s:14SpeechToTextV19WordErrorV7elementSSvp":{"name":"element","abstract":"

    A key-value pair that describes an error associated with the definition of a word in the words resource. Each pair","parent_name":"WordError"},"Structs/WordConfidence.html#/s:14SpeechToTextV114WordConfidenceV4wordSSvp":{"name":"word","abstract":"

    A particular word from the transcription.

    ","parent_name":"WordConfidence"},"Structs/WordConfidence.html#/s:14SpeechToTextV114WordConfidenceV10confidenceSdvp":{"name":"confidence","abstract":"

    The confidence of the given word, between 0 and 1.

    ","parent_name":"WordConfidence"},"Structs/WordConfidence.html#/s:14SpeechToTextV114WordConfidenceVACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Used internally to initialize a WordConfidence model from JSON.

    ","parent_name":"WordConfidence"},"Structs/WordAlternativeResults.html#/s:14SpeechToTextV122WordAlternativeResultsV9startTimeSdvp":{"name":"startTime","abstract":"

    The start time in seconds of the word from the input audio that corresponds to the word alternatives.

    ","parent_name":"WordAlternativeResults"},"Structs/WordAlternativeResults.html#/s:14SpeechToTextV122WordAlternativeResultsV7endTimeSdvp":{"name":"endTime","abstract":"

    The end time in seconds of the word from the input audio that corresponds to the word alternatives.

    ","parent_name":"WordAlternativeResults"},"Structs/WordAlternativeResults.html#/s:14SpeechToTextV122WordAlternativeResultsV12alternativesSayAA0eF6ResultVGvp":{"name":"alternatives","abstract":"

    An array of alternative hypotheses for a word from the input audio.

    ","parent_name":"WordAlternativeResults"},"Structs/WordAlternativeResult.html#/s:14SpeechToTextV121WordAlternativeResultV10confidenceSdvp":{"name":"confidence","abstract":"

    A confidence score for the word alternative hypothesis in the range of 0 to 1.

    ","parent_name":"WordAlternativeResult"},"Structs/WordAlternativeResult.html#/s:14SpeechToTextV121WordAlternativeResultV4wordSSvp":{"name":"word","abstract":"

    An alternative hypothesis for a word from the input audio.

    ","parent_name":"WordAlternativeResult"},"Structs/Word.html#/s:14SpeechToTextV14WordV4wordSSvp":{"name":"word","abstract":"

    A word from the custom model’s words resource. The spelling of the word is used to train the model.

    ","parent_name":"Word"},"Structs/Word.html#/s:14SpeechToTextV14WordV10soundsLikeSaySSGvp":{"name":"soundsLike","abstract":"

    An array of pronunciations for the word. The array can include the sounds-like pronunciation automatically","parent_name":"Word"},"Structs/Word.html#/s:14SpeechToTextV14WordV9displayAsSSvp":{"name":"displayAs","abstract":"

    The spelling of the word that the service uses to display the word in a transcript. The field contains an empty","parent_name":"Word"},"Structs/Word.html#/s:14SpeechToTextV14WordV5countSivp":{"name":"count","abstract":"

    A sum of the number of times the word is found across all corpora. For example, if the word occurs five times in","parent_name":"Word"},"Structs/Word.html#/s:14SpeechToTextV14WordV6sourceSaySSGvp":{"name":"source","abstract":"

    An array of sources that describes how the word was added to the custom model’s words resource. For OOV words added","parent_name":"Word"},"Structs/Word.html#/s:14SpeechToTextV14WordV5errorSayAA0E5ErrorVGSgvp":{"name":"error","abstract":"

    If the service discovered one or more problems that you need to correct for the word’s definition, an array that","parent_name":"Word"},"Structs/SupportedFeatures.html#/s:14SpeechToTextV117SupportedFeaturesV19customLanguageModelSbvp":{"name":"customLanguageModel","abstract":"

    Indicates whether the customization interface can be used to create a custom language model based on the language","parent_name":"SupportedFeatures"},"Structs/SupportedFeatures.html#/s:14SpeechToTextV117SupportedFeaturesV13speakerLabelsSbvp":{"name":"speakerLabels","abstract":"

    Indicates whether the speaker_labels parameter can be used with the language model.

    ","parent_name":"SupportedFeatures"},"Structs/SpeechRecognitionResults.html#/s:14SpeechToTextV10A18RecognitionResultsV7resultsSayAA0aE6ResultVGSgvp":{"name":"results","abstract":"

    An array that can include interim and final results (interim results are returned only if supported by the method).","parent_name":"SpeechRecognitionResults"},"Structs/SpeechRecognitionResults.html#/s:14SpeechToTextV10A18RecognitionResultsV11resultIndexSiSgvp":{"name":"resultIndex","abstract":"

    An index that indicates a change point in the results array. The service increments the index only for additional","parent_name":"SpeechRecognitionResults"},"Structs/SpeechRecognitionResults.html#/s:14SpeechToTextV10A18RecognitionResultsV13speakerLabelsSayAA07SpeakerH6ResultVGSgvp":{"name":"speakerLabels","abstract":"

    An array that identifies which words were spoken by which speakers in a multi-person exchange. Returned in the","parent_name":"SpeechRecognitionResults"},"Structs/SpeechRecognitionResults.html#/s:14SpeechToTextV10A18RecognitionResultsV8warningsSaySSGSgvp":{"name":"warnings","abstract":"

    An array of warning messages associated with the request:

    ","parent_name":"SpeechRecognitionResults"},"Structs/SpeechRecognitionResult.html#/s:14SpeechToTextV10A17RecognitionResultV12finalResultsSbvp":{"name":"finalResults","abstract":"

    An indication of whether the transcription results are final. If true, the results for this utterance are not","parent_name":"SpeechRecognitionResult"},"Structs/SpeechRecognitionResult.html#/s:14SpeechToTextV10A17RecognitionResultV12alternativesSayAA0aE11AlternativeVGvp":{"name":"alternatives","abstract":"

    An array of alternative transcripts. The alternatives array can include additional requested output such as word","parent_name":"SpeechRecognitionResult"},"Structs/SpeechRecognitionResult.html#/s:14SpeechToTextV10A17RecognitionResultV08keywordsF0s10DictionaryVySSSayAA07KeywordF0VGGSgvp":{"name":"keywordsResult","abstract":"

    A dictionary (or associative array) whose keys are the strings specified for keywords if both that parameter and","parent_name":"SpeechRecognitionResult"},"Structs/SpeechRecognitionResult.html#/s:14SpeechToTextV10A17RecognitionResultV16wordAlternativesSayAA22WordAlternativeResultsVGSgvp":{"name":"wordAlternatives","abstract":"

    An array of alternative hypotheses found for words of the input audio if a word_alternatives_threshold is","parent_name":"SpeechRecognitionResult"},"Structs/SpeechRecognitionAlternative.html#/s:14SpeechToTextV10A22RecognitionAlternativeV10transcriptSSvp":{"name":"transcript","abstract":"

    A transcription of the audio.

    ","parent_name":"SpeechRecognitionAlternative"},"Structs/SpeechRecognitionAlternative.html#/s:14SpeechToTextV10A22RecognitionAlternativeV10confidenceSdSgvp":{"name":"confidence","abstract":"

    A score that indicates the service’s confidence in the transcript in the range of 0 to 1. Returned only for the","parent_name":"SpeechRecognitionAlternative"},"Structs/SpeechRecognitionAlternative.html#/s:14SpeechToTextV10A22RecognitionAlternativeV10timestampsSayAA13WordTimestampVGSgvp":{"name":"timestamps","abstract":"

    Time alignments for each word from the transcript as a list of lists. Each inner list consists of three elements:","parent_name":"SpeechRecognitionAlternative"},"Structs/SpeechRecognitionAlternative.html#/s:14SpeechToTextV10A22RecognitionAlternativeV14wordConfidenceSayAA04WordH0VGSgvp":{"name":"wordConfidence","abstract":"

    A confidence score for each word of the transcript as a list of lists. Each inner list consists of two elements:","parent_name":"SpeechRecognitionAlternative"},"Structs/SpeechModels.html#/s:14SpeechToTextV10A6ModelsV6modelsSayAA0A5ModelVGvp":{"name":"models","abstract":"

    An array of objects that provides information about each available model.

    ","parent_name":"SpeechModels"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV4nameSSvp":{"name":"name","abstract":"

    The name of the model for use as an identifier in calls to the service (for example, en-US_BroadbandModel).

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV8languageSSvp":{"name":"language","abstract":"

    The language identifier of the model (for example, en-US).

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV4rateSivp":{"name":"rate","abstract":"

    The sampling rate (minimum acceptable rate for audio) used by the model in Hertz.

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV3urlSSvp":{"name":"url","abstract":"

    The URI for the model.

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV17supportedFeaturesAA09SupportedG0Vvp":{"name":"supportedFeatures","abstract":"

    Describes the additional service features supported with the model.

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV11descriptionSSvp":{"name":"description","abstract":"

    Brief description of the model.

    ","parent_name":"SpeechModel"},"Structs/SpeechModel.html#/s:14SpeechToTextV10A5ModelV8sessionsSSSgvp":{"name":"sessions","abstract":"

    The URI for the model for use with the Create a session method. This field is returned only by the Get a","parent_name":"SpeechModel"},"Structs/SpeakerLabelsResult.html#/s:14SpeechToTextV119SpeakerLabelsResultV4fromSdvp":{"name":"from","abstract":"

    The start time of a word from the transcript. The value matches the start time of a word from the timestamps","parent_name":"SpeakerLabelsResult"},"Structs/SpeakerLabelsResult.html#/s:14SpeechToTextV119SpeakerLabelsResultV2toSdvp":{"name":"to","abstract":"

    The end time of a word from the transcript. The value matches the end time of a word from the timestamps array.

    ","parent_name":"SpeakerLabelsResult"},"Structs/SpeakerLabelsResult.html#/s:14SpeechToTextV119SpeakerLabelsResultV7speakerSivp":{"name":"speaker","abstract":"

    The numeric identifier that the service assigns to a speaker from the audio. Speaker IDs begin at 0 initially but","parent_name":"SpeakerLabelsResult"},"Structs/SpeakerLabelsResult.html#/s:14SpeechToTextV119SpeakerLabelsResultV10confidenceSdvp":{"name":"confidence","abstract":"

    A score that indicates the service’s confidence in its identification of the speaker in the range of 0 to 1.

    ","parent_name":"SpeakerLabelsResult"},"Structs/SpeakerLabelsResult.html#/s:14SpeechToTextV119SpeakerLabelsResultV12finalResultsSbvp":{"name":"finalResults","abstract":"

    An indication of whether the service might further change word and speaker-label results. A value of true means","parent_name":"SpeakerLabelsResult"},"Structs/RegisterStatus/Status.html#/s:14SpeechToTextV114RegisterStatusV0F0O7createdA2EmF":{"name":"created","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RegisterStatus/Status.html#/s:14SpeechToTextV114RegisterStatusV0F0O14alreadyCreatedA2EmF":{"name":"alreadyCreated","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RegisterStatus/Status.html":{"name":"Status","abstract":"

    The current status of the job:

    ","parent_name":"RegisterStatus"},"Structs/RegisterStatus.html#/s:14SpeechToTextV114RegisterStatusV6statusSSvp":{"name":"status","abstract":"

    The current status of the job:

    ","parent_name":"RegisterStatus"},"Structs/RegisterStatus.html#/s:14SpeechToTextV114RegisterStatusV3urlSSvp":{"name":"url","abstract":"

    The callback URL that is successfully registered.

    ","parent_name":"RegisterStatus"},"Structs/RecognitionJobs.html#/s:14SpeechToTextV115RecognitionJobsV12recognitionsSayAA0E3JobVGvp":{"name":"recognitions","abstract":"

    An array of objects that provides the status for each of the user’s current jobs. The array is empty if the user","parent_name":"RecognitionJobs"},"Structs/RecognitionJob/Status.html#/s:14SpeechToTextV114RecognitionJobV6StatusO7waitingA2EmF":{"name":"waiting","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RecognitionJob/Status.html#/s:14SpeechToTextV114RecognitionJobV6StatusO10processingA2EmF":{"name":"processing","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RecognitionJob/Status.html#/s:14SpeechToTextV114RecognitionJobV6StatusO9completedA2EmF":{"name":"completed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RecognitionJob/Status.html#/s:14SpeechToTextV114RecognitionJobV6StatusO6failedA2EmF":{"name":"failed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/RecognitionJob/Status.html":{"name":"Status","abstract":"

    The current status of the job:

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV2idSSvp":{"name":"id","abstract":"

    The ID of the asynchronous job.

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV6statusSSvp":{"name":"status","abstract":"

    The current status of the job:

    ","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV7createdSSvp":{"name":"created","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the job was created. The value is provided in full","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV7updatedSSSgvp":{"name":"updated","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the job was last updated by the service. The value","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV3urlSSSgvp":{"name":"url","abstract":"

    The URL to use to request information about the job with the Check a job method. This field is returned only by","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV9userTokenSSSgvp":{"name":"userToken","abstract":"

    The user token associated with a job that was created with a callback URL and a user token. This field can be","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV7resultsSayAA0aE7ResultsVGSgvp":{"name":"results","abstract":"

    If the status is completed, the results of the recognition request as an array that includes a single instance of","parent_name":"RecognitionJob"},"Structs/RecognitionJob.html#/s:14SpeechToTextV114RecognitionJobV8warningsSaySSGSgvp":{"name":"warnings","abstract":"

    An array of warning messages about invalid parameters included with the request. Each warning includes a","parent_name":"RecognitionJob"},"Structs/LanguageModels.html#/s:14SpeechToTextV114LanguageModelsV14customizationsSayAA0E5ModelVGvp":{"name":"customizations","abstract":"

    An array of objects that provides information about each available custom language model. The array is empty if the","parent_name":"LanguageModels"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO7pendingA2EmF":{"name":"pending","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO5readyA2EmF":{"name":"ready","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO8trainingA2EmF":{"name":"training","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO9availableA2EmF":{"name":"available","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO9upgradingA2EmF":{"name":"upgrading","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html#/s:14SpeechToTextV113LanguageModelV6StatusO6failedA2EmF":{"name":"failed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/LanguageModel/Status.html":{"name":"Status","abstract":"

    The current status of the custom language model:

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV15customizationIDSSvp":{"name":"customizationID","abstract":"

    The customization ID (GUID) of the custom language model. The Create a custom language model method returns","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV7createdSSSgvp":{"name":"created","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the custom language model was created. The value is","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV8languageSSSgvp":{"name":"language","abstract":"

    The language identifier of the custom language model (for example, en-US).

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV7dialectSSSgvp":{"name":"dialect","abstract":"

    The dialect of the language for the custom language model. By default, the dialect matches the language of the base","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV8versionsSaySSGSgvp":{"name":"versions","abstract":"

    A list of the available versions of the custom language model. Each element of the array indicates a version of the","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV5ownerSSSgvp":{"name":"owner","abstract":"

    The GUID of the service credentials for the instance of the service that owns the custom language model.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV4nameSSSgvp":{"name":"name","abstract":"

    The name of the custom language model.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV11descriptionSSSgvp":{"name":"description","abstract":"

    The description of the custom language model.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV04baseF4NameSSSgvp":{"name":"baseModelName","abstract":"

    The name of the language model for which the custom language model was created.

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV6statusSSSgvp":{"name":"status","abstract":"

    The current status of the custom language model:

    ","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV8progressSiSgvp":{"name":"progress","abstract":"

    A percentage that indicates the progress of the custom language model’s current training. A value of 100 means","parent_name":"LanguageModel"},"Structs/LanguageModel.html#/s:14SpeechToTextV113LanguageModelV8warningsSSSgvp":{"name":"warnings","abstract":"

    If the request included unknown parameters, the following message: Unexpected query parameter(s) ['parameters']","parent_name":"LanguageModel"},"Structs/KeywordResult.html#/s:14SpeechToTextV113KeywordResultV010normalizedC0SSvp":{"name":"normalizedText","abstract":"

    A specified keyword normalized to the spoken phrase that matched in the audio input.

    ","parent_name":"KeywordResult"},"Structs/KeywordResult.html#/s:14SpeechToTextV113KeywordResultV9startTimeSdvp":{"name":"startTime","abstract":"

    The start time in seconds of the keyword match.

    ","parent_name":"KeywordResult"},"Structs/KeywordResult.html#/s:14SpeechToTextV113KeywordResultV7endTimeSdvp":{"name":"endTime","abstract":"

    The end time in seconds of the keyword match.

    ","parent_name":"KeywordResult"},"Structs/KeywordResult.html#/s:14SpeechToTextV113KeywordResultV10confidenceSdvp":{"name":"confidence","abstract":"

    A confidence score for the keyword match in the range of 0 to 1.

    ","parent_name":"KeywordResult"},"Structs/CustomWords.html#/s:14SpeechToTextV111CustomWordsV5wordsSayAA0E4WordVGvp":{"name":"words","abstract":"

    An array of objects that provides information about each custom word that is to be added to or updated in the","parent_name":"CustomWords"},"Structs/CustomWords.html#/s:14SpeechToTextV111CustomWordsVACSayAA0E4WordVG5words_tcfc":{"name":"init(words:)","abstract":"

    Initialize a CustomWords with member variables.

    ","parent_name":"CustomWords"},"Structs/CustomWord.html#/s:14SpeechToTextV110CustomWordV4wordSSSgvp":{"name":"word","abstract":"

    For the Add custom words method, you must specify the custom word that is to be added to or updated in the","parent_name":"CustomWord"},"Structs/CustomWord.html#/s:14SpeechToTextV110CustomWordV10soundsLikeSaySSGSgvp":{"name":"soundsLike","abstract":"

    An array of sounds-like pronunciations for the custom word. Specify how words that are difficult to pronounce,","parent_name":"CustomWord"},"Structs/CustomWord.html#/s:14SpeechToTextV110CustomWordV9displayAsSSSgvp":{"name":"displayAs","abstract":"

    An alternative spelling for the custom word when it appears in a transcript. Use the parameter when you want the","parent_name":"CustomWord"},"Structs/CustomWord.html#/s:14SpeechToTextV110CustomWordVACSSSg4word_SaySSGSg10soundsLikeAD9displayAstcfc":{"name":"init(word:soundsLike:displayAs:)","abstract":"

    Initialize a CustomWord with member variables.

    ","parent_name":"CustomWord"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18enGbBroadbandmodelA2EmF":{"name":"enGbBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO19enGbNarrowbandmodelA2EmF":{"name":"enGbNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18enUsBroadbandmodelA2EmF":{"name":"enUsBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO19enUsNarrowbandmodelA2EmF":{"name":"enUsNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18esEsBroadbandmodelA2EmF":{"name":"esEsBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO19esEsNarrowbandmodelA2EmF":{"name":"esEsNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18frFrBroadbandmodelA2EmF":{"name":"frFrBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18jaJpBroadbandmodelA2EmF":{"name":"jaJpBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO19jaJpNarrowbandmodelA2EmF":{"name":"jaJpNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO18koKrBroadbandmodelA2EmF":{"name":"koKrBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html#/s:14SpeechToTextV119CreateLanguageModelV04BaseG4NameO19koKrNarrowbandmodelA2EmF":{"name":"koKrNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateLanguageModel/BaseModelName.html":{"name":"BaseModelName","abstract":"

    The name of the base language model that is to be customized by the new custom language model. The new custom model","parent_name":"CreateLanguageModel"},"Structs/CreateLanguageModel.html#/s:14SpeechToTextV119CreateLanguageModelV4nameSSvp":{"name":"name","abstract":"

    A user-defined name for the new custom language model. Use a name that is unique among all custom language models","parent_name":"CreateLanguageModel"},"Structs/CreateLanguageModel.html#/s:14SpeechToTextV119CreateLanguageModelV04baseG4NameSSvp":{"name":"baseModelName","abstract":"

    The name of the base language model that is to be customized by the new custom language model. The new custom model","parent_name":"CreateLanguageModel"},"Structs/CreateLanguageModel.html#/s:14SpeechToTextV119CreateLanguageModelV7dialectSSSgvp":{"name":"dialect","abstract":"

    The dialect of the specified language that is to be used with the custom language model. The parameter is","parent_name":"CreateLanguageModel"},"Structs/CreateLanguageModel.html#/s:14SpeechToTextV119CreateLanguageModelV11descriptionSSSgvp":{"name":"description","abstract":"

    A description of the new custom language model. Use a localized description that matches the language of the custom","parent_name":"CreateLanguageModel"},"Structs/CreateLanguageModel.html#/s:14SpeechToTextV119CreateLanguageModelVACSS4name_SS04baseG4NameSSSg7dialectAF11descriptiontcfc":{"name":"init(name:baseModelName:dialect:description:)","abstract":"

    Initialize a CreateLanguageModel with member variables.

    ","parent_name":"CreateLanguageModel"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18arArBroadbandmodelA2EmF":{"name":"arArBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18enGbBroadbandmodelA2EmF":{"name":"enGbBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19enGbNarrowbandmodelA2EmF":{"name":"enGbNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18enUsBroadbandmodelA2EmF":{"name":"enUsBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19enUsNarrowbandmodelA2EmF":{"name":"enUsNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18esEsBroadbandmodelA2EmF":{"name":"esEsBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19esEsNarrowbandmodelA2EmF":{"name":"esEsNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18frFrBroadbandmodelA2EmF":{"name":"frFrBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18jaJpBroadbandmodelA2EmF":{"name":"jaJpBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19jaJpNarrowbandmodelA2EmF":{"name":"jaJpNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18koKrBroadbandmodelA2EmF":{"name":"koKrBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19koKrNarrowbandmodelA2EmF":{"name":"koKrNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18ptBrBroadbandmodelA2EmF":{"name":"ptBrBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19ptBrNarrowbandmodelA2EmF":{"name":"ptBrNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO18zhCnBroadbandmodelA2EmF":{"name":"zhCnBroadbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html#/s:14SpeechToTextV119CreateAcousticModelV04BaseG4NameO19zhCnNarrowbandmodelA2EmF":{"name":"zhCnNarrowbandmodel","abstract":"

    Undocumented

    ","parent_name":"BaseModelName"},"Structs/CreateAcousticModel/BaseModelName.html":{"name":"BaseModelName","abstract":"

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model","parent_name":"CreateAcousticModel"},"Structs/CreateAcousticModel.html#/s:14SpeechToTextV119CreateAcousticModelV4nameSSvp":{"name":"name","abstract":"

    A user-defined name for the new custom acoustic model. Use a name that is unique among all custom acoustic models","parent_name":"CreateAcousticModel"},"Structs/CreateAcousticModel.html#/s:14SpeechToTextV119CreateAcousticModelV04baseG4NameSSvp":{"name":"baseModelName","abstract":"

    The name of the base language model that is to be customized by the new custom acoustic model. The new custom model","parent_name":"CreateAcousticModel"},"Structs/CreateAcousticModel.html#/s:14SpeechToTextV119CreateAcousticModelV11descriptionSSSgvp":{"name":"description","abstract":"

    A description of the new custom acoustic model. Use a localized description that matches the language of the custom","parent_name":"CreateAcousticModel"},"Structs/CreateAcousticModel.html#/s:14SpeechToTextV119CreateAcousticModelVACSS4name_SS04baseG4NameSSSg11descriptiontcfc":{"name":"init(name:baseModelName:description:)","abstract":"

    Initialize a CreateAcousticModel with member variables.

    ","parent_name":"CreateAcousticModel"},"Structs/Corpus/Status.html#/s:14SpeechToTextV16CorpusV6StatusO8analyzedA2EmF":{"name":"analyzed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Corpus/Status.html#/s:14SpeechToTextV16CorpusV6StatusO14beingProcessedA2EmF":{"name":"beingProcessed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Corpus/Status.html#/s:14SpeechToTextV16CorpusV6StatusO12undeterminedA2EmF":{"name":"undetermined","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Corpus/Status.html":{"name":"Status","abstract":"

    The status of the corpus:

    ","parent_name":"Corpus"},"Structs/Corpus.html#/s:14SpeechToTextV16CorpusV4nameSSvp":{"name":"name","abstract":"

    The name of the corpus.

    ","parent_name":"Corpus"},"Structs/Corpus.html#/s:14SpeechToTextV16CorpusV10totalWordsSivp":{"name":"totalWords","abstract":"

    The total number of words in the corpus. The value is 0 while the corpus is being processed.

    ","parent_name":"Corpus"},"Structs/Corpus.html#/s:14SpeechToTextV16CorpusV20outOfVocabularyWordsSivp":{"name":"outOfVocabularyWords","abstract":"

    The number of OOV words in the corpus. The value is 0 while the corpus is being processed.

    ","parent_name":"Corpus"},"Structs/Corpus.html#/s:14SpeechToTextV16CorpusV6statusSSvp":{"name":"status","abstract":"

    The status of the corpus:

    ","parent_name":"Corpus"},"Structs/Corpus.html#/s:14SpeechToTextV16CorpusV5errorSSSgvp":{"name":"error","abstract":"

    If the status of the corpus is undetermined, the following message: Analysis of corpus 'name' failed. Please try","parent_name":"Corpus"},"Structs/Corpora.html#/s:14SpeechToTextV17CorporaV7corporaSayAA6CorpusVGvp":{"name":"corpora","abstract":"

    An array of objects that provides information about the corpora for the custom model. The array is empty if the","parent_name":"Corpora"},"Structs/AudioResources.html#/s:14SpeechToTextV114AudioResourcesV014totalMinutesOfE0Sdvp":{"name":"totalMinutesOfAudio","abstract":"

    The total minutes of accumulated audio summed over all of the valid audio resources for the custom acoustic model.","parent_name":"AudioResources"},"Structs/AudioResources.html#/s:14SpeechToTextV114AudioResourcesV5audioSayAA0E8ResourceVGvp":{"name":"audio","abstract":"

    An array of objects that provides information about the audio resources of the custom acoustic model. The array is","parent_name":"AudioResources"},"Structs/AudioResource/Status.html#/s:14SpeechToTextV113AudioResourceV6StatusO2okA2EmF":{"name":"ok","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioResource/Status.html#/s:14SpeechToTextV113AudioResourceV6StatusO14beingProcessedA2EmF":{"name":"beingProcessed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioResource/Status.html#/s:14SpeechToTextV113AudioResourceV6StatusO7invalidA2EmF":{"name":"invalid","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioResource/Status.html":{"name":"Status","abstract":"

    The status of the audio resource:

    ","parent_name":"AudioResource"},"Structs/AudioResource.html#/s:14SpeechToTextV113AudioResourceV8durationSdvp":{"name":"duration","abstract":"

    The total seconds of audio in the audio resource. The value is always a whole number.

    ","parent_name":"AudioResource"},"Structs/AudioResource.html#/s:14SpeechToTextV113AudioResourceV4nameSSvp":{"name":"name","abstract":"

    For an archive-type resource, the user-specified name of the resource.","parent_name":"AudioResource"},"Structs/AudioResource.html#/s:14SpeechToTextV113AudioResourceV7detailsAA0E7DetailsVvp":{"name":"details","abstract":"

    An AudioDetails object that provides detailed information about the audio resource. The object is empty until the","parent_name":"AudioResource"},"Structs/AudioResource.html#/s:14SpeechToTextV113AudioResourceV6statusSSvp":{"name":"status","abstract":"

    The status of the audio resource:

    ","parent_name":"AudioResource"},"Structs/AudioListing/Status.html#/s:14SpeechToTextV112AudioListingV6StatusO2okA2EmF":{"name":"ok","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioListing/Status.html#/s:14SpeechToTextV112AudioListingV6StatusO14beingProcessedA2EmF":{"name":"beingProcessed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioListing/Status.html#/s:14SpeechToTextV112AudioListingV6StatusO7invalidA2EmF":{"name":"invalid","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AudioListing/Status.html":{"name":"Status","abstract":"

    For an audio-type resource, the status of the resource:

    ","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV8durationSdSgvp":{"name":"duration","abstract":"

    For an audio-type resource, the total seconds of audio in the resource. The value is always a whole number.","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV4nameSSSgvp":{"name":"name","abstract":"

    For an audio-type resource,** the user-specified name of the resource. Omitted for an archive-type resource.

    ","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV7detailsAA0E7DetailsVSgvp":{"name":"details","abstract":"

    For an audio-type resource, an AudioDetails object that provides detailed information about the resource. The","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV6statusSSSgvp":{"name":"status","abstract":"

    For an audio-type resource, the status of the resource:

    ","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV9containerAA0E8ResourceVSgvp":{"name":"container","abstract":"

    For an archive-type resource, an object of type AudioResource that provides information about the resource.","parent_name":"AudioListing"},"Structs/AudioListing.html#/s:14SpeechToTextV112AudioListingV5audioSayAA0E8ResourceVGSgvp":{"name":"audio","abstract":"

    For an archive-type resource, an array of AudioResource objects that provides information about the","parent_name":"AudioListing"},"Structs/AudioDetails/Compression.html#/s:14SpeechToTextV112AudioDetailsV11CompressionO3zipA2EmF":{"name":"zip","abstract":"

    Undocumented

    ","parent_name":"Compression"},"Structs/AudioDetails/Compression.html#/s:14SpeechToTextV112AudioDetailsV11CompressionO4gzipA2EmF":{"name":"gzip","abstract":"

    Undocumented

    ","parent_name":"Compression"},"Structs/AudioDetails/ModelType.html#/s:14SpeechToTextV112AudioDetailsV9ModelTypeO5audioA2EmF":{"name":"audio","abstract":"

    Undocumented

    ","parent_name":"ModelType"},"Structs/AudioDetails/ModelType.html#/s:14SpeechToTextV112AudioDetailsV9ModelTypeO7archiveA2EmF":{"name":"archive","abstract":"

    Undocumented

    ","parent_name":"ModelType"},"Structs/AudioDetails/ModelType.html#/s:14SpeechToTextV112AudioDetailsV9ModelTypeO12undeterminedA2EmF":{"name":"undetermined","abstract":"

    Undocumented

    ","parent_name":"ModelType"},"Structs/AudioDetails/ModelType.html":{"name":"ModelType","abstract":"

    The type of the audio resource:

    ","parent_name":"AudioDetails"},"Structs/AudioDetails/Compression.html":{"name":"Compression","abstract":"

    For an archive-type resource, the format of the compressed archive:

    ","parent_name":"AudioDetails"},"Structs/AudioDetails.html#/s:14SpeechToTextV112AudioDetailsV4typeSSSgvp":{"name":"type","abstract":"

    The type of the audio resource:

    ","parent_name":"AudioDetails"},"Structs/AudioDetails.html#/s:14SpeechToTextV112AudioDetailsV5codecSSSgvp":{"name":"codec","abstract":"

    For an audio-type resource,** the codec in which the audio is encoded. Omitted for an archive-type resource.

    ","parent_name":"AudioDetails"},"Structs/AudioDetails.html#/s:14SpeechToTextV112AudioDetailsV9frequencySiSgvp":{"name":"frequency","abstract":"

    For an audio-type resource, the sampling rate of the audio in Hertz (samples per second). Omitted for an","parent_name":"AudioDetails"},"Structs/AudioDetails.html#/s:14SpeechToTextV112AudioDetailsV11compressionSSSgvp":{"name":"compression","abstract":"

    For an archive-type resource, the format of the compressed archive:

    ","parent_name":"AudioDetails"},"Structs/AcousticModels.html#/s:14SpeechToTextV114AcousticModelsV14customizationsSayAA0E5ModelVGvp":{"name":"customizations","abstract":"

    An array of objects that provides information about each available custom acoustic model. The array is empty if the","parent_name":"AcousticModels"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO7pendingA2EmF":{"name":"pending","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO5readyA2EmF":{"name":"ready","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO8trainingA2EmF":{"name":"training","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO9availableA2EmF":{"name":"available","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO9upgradingA2EmF":{"name":"upgrading","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html#/s:14SpeechToTextV113AcousticModelV6StatusO6failedA2EmF":{"name":"failed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/AcousticModel/Status.html":{"name":"Status","abstract":"

    The current status of the custom acoustic model:

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV15customizationIDSSvp":{"name":"customizationID","abstract":"

    The customization ID (GUID) of the custom acoustic model. The Create a custom acoustic model method returns","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV7createdSSSgvp":{"name":"created","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the custom acoustic model was created. The value is","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV8languageSSSgvp":{"name":"language","abstract":"

    The language identifier of the custom acoustic model (for example, en-US).

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV8versionsSaySSGSgvp":{"name":"versions","abstract":"

    A list of the available versions of the custom acoustic model. Each element of the array indicates a version of the","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV5ownerSSSgvp":{"name":"owner","abstract":"

    The GUID of the service credentials for the instance of the service that owns the custom acoustic model.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV4nameSSSgvp":{"name":"name","abstract":"

    The name of the custom acoustic model.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV11descriptionSSSgvp":{"name":"description","abstract":"

    The description of the custom acoustic model.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV04baseF4NameSSSgvp":{"name":"baseModelName","abstract":"

    The name of the language model for which the custom acoustic model was created.

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV6statusSSSgvp":{"name":"status","abstract":"

    The current status of the custom acoustic model:

    ","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV8progressSiSgvp":{"name":"progress","abstract":"

    A percentage that indicates the progress of the custom acoustic model’s current training. A value of 100 means","parent_name":"AcousticModel"},"Structs/AcousticModel.html#/s:14SpeechToTextV113AcousticModelV8warningsSSSgvp":{"name":"warnings","abstract":"

    If the request included unknown parameters, the following message: Unexpected query parameter(s) ['parameters']","parent_name":"AcousticModel"},"Structs/AcousticModel.html":{"name":"AcousticModel","abstract":"

    AcousticModel.

    "},"Structs/AcousticModels.html":{"name":"AcousticModels","abstract":"

    AcousticModels.

    "},"Structs/AudioDetails.html":{"name":"AudioDetails","abstract":"

    AudioDetails.

    "},"Structs/AudioListing.html":{"name":"AudioListing","abstract":"

    AudioListing.

    "},"Structs/AudioResource.html":{"name":"AudioResource","abstract":"

    AudioResource.

    "},"Structs/AudioResources.html":{"name":"AudioResources","abstract":"

    AudioResources.

    "},"Structs/Corpora.html":{"name":"Corpora","abstract":"

    Corpora.

    "},"Structs/Corpus.html":{"name":"Corpus","abstract":"

    Corpus.

    "},"Structs/CreateAcousticModel.html":{"name":"CreateAcousticModel","abstract":"

    CreateAcousticModel.

    "},"Structs/CreateLanguageModel.html":{"name":"CreateLanguageModel","abstract":"

    CreateLanguageModel.

    "},"Structs/CustomWord.html":{"name":"CustomWord","abstract":"

    CustomWord.

    "},"Structs/CustomWords.html":{"name":"CustomWords","abstract":"

    CustomWords.

    "},"Structs/KeywordResult.html":{"name":"KeywordResult","abstract":"

    KeywordResult.

    "},"Structs/LanguageModel.html":{"name":"LanguageModel","abstract":"

    LanguageModel.

    "},"Structs/LanguageModels.html":{"name":"LanguageModels","abstract":"

    LanguageModels.

    "},"Structs/RecognitionJob.html":{"name":"RecognitionJob","abstract":"

    RecognitionJob.

    "},"Structs/RecognitionJobs.html":{"name":"RecognitionJobs","abstract":"

    RecognitionJobs.

    "},"Structs/RegisterStatus.html":{"name":"RegisterStatus","abstract":"

    RegisterStatus.

    "},"Structs/SpeakerLabelsResult.html":{"name":"SpeakerLabelsResult","abstract":"

    SpeakerLabelsResult.

    "},"Structs/SpeechModel.html":{"name":"SpeechModel","abstract":"

    SpeechModel.

    "},"Structs/SpeechModels.html":{"name":"SpeechModels","abstract":"

    SpeechModels.

    "},"Structs/SpeechRecognitionAlternative.html":{"name":"SpeechRecognitionAlternative","abstract":"

    SpeechRecognitionAlternative.

    "},"Structs/SpeechRecognitionResult.html":{"name":"SpeechRecognitionResult","abstract":"

    SpeechRecognitionResult.

    "},"Structs/SpeechRecognitionResults.html":{"name":"SpeechRecognitionResults","abstract":"

    SpeechRecognitionResults.

    "},"Structs/SupportedFeatures.html":{"name":"SupportedFeatures","abstract":"

    SupportedFeatures.

    "},"Structs/Word.html":{"name":"Word","abstract":"

    Word.

    "},"Structs/WordAlternativeResult.html":{"name":"WordAlternativeResult","abstract":"

    WordAlternativeResult.

    "},"Structs/WordAlternativeResults.html":{"name":"WordAlternativeResults","abstract":"

    WordAlternativeResults.

    "},"Structs/WordConfidence.html":{"name":"WordConfidence","abstract":"

    The confidence of a word in a Speech to Text transcription.

    "},"Structs/WordError.html":{"name":"WordError","abstract":"

    WordError.

    "},"Structs/WordTimestamp.html":{"name":"WordTimestamp","abstract":"

    The timestamp of a word in a Speech to Text transcription.

    "},"Structs/Words.html":{"name":"Words","abstract":"

    Words.

    "},"Structs/RecognitionSettings.html":{"name":"RecognitionSettings","abstract":"

    The settings associated with a Speech to Text recognition request. Any nil parameters will"},"Structs/SpeechRecognitionResultsAccumulator.html":{"name":"SpeechRecognitionResultsAccumulator","abstract":"

    SpeechRecognitionResultsAccumulator.

    "},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

    No response was received from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

    No data was returned from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO013serializationF0A2CmF":{"name":"serializationError","abstract":"

    Failed to serialize value(s) to data.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO08encodingF0A2CmF":{"name":"encodingError","abstract":"

    Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO011fileManagerF0A2CmF":{"name":"fileManagerError","abstract":"

    FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

    Failed to load the given file.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14SpeechToTextV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

    An HTTP error with a status code and description.

    ","parent_name":"RestError"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO4nullA2CmF":{"name":"null","abstract":"

    A null value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

    A boolean value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO6stringACSScACmF":{"name":"string","abstract":"

    A string value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO3intACSicACmF":{"name":"int","abstract":"

    A number value, represented as an integer.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

    A number value, represented as a double.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

    An array value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

    An object value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Decode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

    Initialize a JSON value from an encodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

    Convert this JSON value to a decodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

    Encode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14SpeechToTextV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compare two JSON values for equality.

    ","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

    A JSON value (one of string, number, object, array, true, false, or null).

    "},"Enums/RestError.html":{"name":"RestError","abstract":"

    An error from processing a network request or response.

    "},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC10serviceURLSSvp":{"name":"serviceURL","abstract":"

    The base URL of the Speech to Text service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC8tokenURLSSvp":{"name":"tokenURL","abstract":"

    The URL that shall be used to obtain a token.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC13websocketsURLSSvp":{"name":"websocketsURL","abstract":"

    The URL that shall be used to stream audio for transcription.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

    The default HTTP headers for all requests to the service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC7resultsAA0A18RecognitionResultsVvp":{"name":"results","abstract":"

    The results of the most recent recognition request.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC9onConnectyycSgvp":{"name":"onConnect","abstract":"

    Invoked when the session connects to the Speech to Text service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC16onMicrophoneDatay10Foundation0H0VcSgvp":{"name":"onMicrophoneData","abstract":"

    Invoked with microphone audio when a recording audio queue buffer has been filled.","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC11onPowerDataySfcSgvp":{"name":"onPowerData","abstract":"

    Invoked every 0.025s when recording with the average dB power of the microphone.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC9onResultsyAA0a11RecognitionG0VcSgvp":{"name":"onResults","abstract":"

    Invoked when transcription results are received for a recognition request.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC7onErrorys0G0_pcSgvp":{"name":"onError","abstract":"

    Invoked when an error or warning occurs.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC12onDisconnectyycSgvp":{"name":"onDisconnect","abstract":"

    Invoked when the session disconnects from the Speech to Text service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionCACSS8username_SS8passwordSSSg5modelAF15customizationIDSbSg14learningOptOuttcfc":{"name":"init(username:password:model:customizationID:learningOptOut:)","abstract":"

    Create a SpeechToTextSession object.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC7connectyyF":{"name":"connect()","abstract":"

    Connect to the Speech to Text service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC12startRequestyAA19RecognitionSettingsV8settings_tF":{"name":"startRequest(settings:)","abstract":"

    Start a recognition request.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC9recognizey10Foundation3URLV5audio_tF":{"name":"recognize(audio:)","abstract":"

    Send an audio file to transcribe.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC9recognizey10Foundation4DataV5audio_tF":{"name":"recognize(audio:)","abstract":"

    Send audio data to transcribe.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC15startMicrophoneySb8compress_tF":{"name":"startMicrophone(compress:)","abstract":"

    Start streaming microphone audio data to transcribe.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC14stopMicrophoneyyF":{"name":"stopMicrophone()","abstract":"

    Stop streaming microphone audio data to transcribe.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC11stopRequestyyF":{"name":"stopRequest()","abstract":"

    Stop the recognition request.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToTextSession.html#/s:14SpeechToTextV10abC7SessionC10disconnectyyF":{"name":"disconnect()","abstract":"

    Wait for any queued recognition requests to complete then disconnect from the service.

    ","parent_name":"SpeechToTextSession"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

    The base URL to use when contacting the service.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8tokenURLSSvp":{"name":"tokenURL","abstract":"

    The URL that shall be used to obtain a token.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C13websocketsURLSSvp":{"name":"websocketsURL","abstract":"

    The URL that shall be used to stream audio for transcription.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

    The default HTTP headers for all requests to the service.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0CACSS8username_SS8passwordtcfc":{"name":"init(username:password:)","abstract":"

    Create a SpeechToText object.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

    Create a SpeechToText object.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

    Create a SpeechToText object.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

    Undocumented

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C10listModelsys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA0aF0Vc7successtF":{"name":"listModels(headers:failure:success:)","abstract":"

    List models.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8getModelySS7modelID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0aF0Vc7successtF":{"name":"getModel(modelID:headers:failure:success:)","abstract":"

    Get a model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C20recognizeSessionlessySSSg5model_AE15customizationIDAE021acousticCustomizationI0AE16baseModelVersionSdSg0H6Weight10Foundation4DataVSg5audioAE11contentTypeSiSg17inactivityTimeoutSaySSGSg8keywordsAJ0W9ThresholdAR15maxAlternativesAJ04wordzX0SbSg14wordConfidenceAZ10timestampsAZ15profanityFilterAZ15smartFormattingAZ13speakerLabelss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0A18RecognitionResultsVc7successtF":{"name":"recognizeSessionless(model:customizationID:acousticCustomizationID:baseModelVersion:customizationWeight:audio:contentType:inactivityTimeout:keywords:keywordsThreshold:maxAlternatives:wordAlternativesThreshold:wordConfidence:timestamps:profanityFilter:smartFormatting:speakerLabels:headers:failure:success:)","abstract":"

    Recognize audio.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C16registerCallbackySS11callbackUrl_SSSg10userSecrets10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA14RegisterStatusVc7successtF":{"name":"registerCallback(callbackUrl:userSecret:headers:failure:success:)","abstract":"

    Register a callback.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18unregisterCallbackySS11callbackUrl_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"unregisterCallback(callbackUrl:headers:failure:success:)","abstract":"

    Unregister a callback.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9createJoby10Foundation4DataV5audio_SS11contentTypeSSSg5modelAJ11callbackUrlAJ6eventsAJ9userTokenSiSg10resultsTtlAJ15customizationIDAJ021acousticCustomizationU0AJ16baseModelVersionSdSg0T6WeightAO17inactivityTimeoutSaySSGSg8keywordsAT17keywordsThresholdAO15maxAlternativesAT25wordAlternativesThresholdSbSg14wordConfidenceA1_10timestampsA1_15profanityFilterA1_15smartFormattingA1_13speakerLabelss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA011RecognitionF0Vc7successtF":{"name":"createJob(audio:contentType:model:callbackUrl:events:userToken:resultsTtl:customizationID:acousticCustomizationID:baseModelVersion:customizationWeight:inactivityTimeout:keywords:keywordsThreshold:maxAlternatives:wordAlternativesThreshold:wordConfidence:timestamps:profanityFilter:smartFormatting:speakerLabels:headers:failure:success:)","abstract":"

    Create a job.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9checkJobsys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA011RecognitionF0Vc7successtF":{"name":"checkJobs(headers:failure:success:)","abstract":"

    Check jobs.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8checkJobySS2id_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA011RecognitionF0Vc7successtF":{"name":"checkJob(id:headers:failure:success:)","abstract":"

    Check a job.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9deleteJobySS2id_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteJob(id:headers:failure:success:)","abstract":"

    Delete a job.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C19createLanguageModelyAA06CreatefG0VAD_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"createLanguageModel(createLanguageModel:headers:failure:success:)","abstract":"

    Create a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18listLanguageModelsySSSg8language_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"listLanguageModels(language:headers:failure:success:)","abstract":"

    List custom language models.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C16getLanguageModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"getLanguageModel(customizationID:headers:failure:success:)","abstract":"

    Get a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C19deleteLanguageModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteLanguageModel(customizationID:headers:failure:success:)","abstract":"

    Delete a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18trainLanguageModelySS15customizationID_SSSg08wordTypeB3AddSdSg0H6Weights10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"trainLanguageModel(customizationID:wordTypeToAdd:customizationWeight:headers:failure:success:)","abstract":"

    Train a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18resetLanguageModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"resetLanguageModel(customizationID:headers:failure:success:)","abstract":"

    Reset a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C20upgradeLanguageModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"upgradeLanguageModel(customizationID:headers:failure:success:)","abstract":"

    Upgrade a custom language model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C11listCorporaySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"listCorpora(customizationID:headers:failure:success:)","abstract":"

    List corpora.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9addCorpusySS15customizationID_SS10corpusName10Foundation3URLV0I4FileSbSg14allowOverwriteSSSg0iM11ContentTypes10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addCorpus(customizationID:corpusName:corpusFile:allowOverwrite:corpusFileContentType:headers:failure:success:)","abstract":"

    Add a corpus.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9getCorpusySS15customizationID_SS10corpusNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"getCorpus(customizationID:corpusName:headers:failure:success:)","abstract":"

    Get a corpus.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C12deleteCorpusySS15customizationID_SS10corpusNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteCorpus(customizationID:corpusName:headers:failure:success:)","abstract":"

    Delete a corpus.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9listWordsySS15customizationID_SSSg8wordTypeAF4sorts10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"listWords(customizationID:wordType:sort:headers:failure:success:)","abstract":"

    List custom words.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8addWordsySS15customizationID_SayAA10CustomWordVG5wordss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addWords(customizationID:words:headers:failure:success:)","abstract":"

    Add custom words.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C7addWordySS15customizationID_SS8wordNameSSSg0I0SaySSGSg10soundsLikeAG9displayAss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addWord(customizationID:wordName:word:soundsLike:displayAs:headers:failure:success:)","abstract":"

    Add a custom word.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C7getWordySS15customizationID_SS8wordNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"getWord(customizationID:wordName:headers:failure:success:)","abstract":"

    Get a custom word.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C10deleteWordySS15customizationID_SS8wordNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteWord(customizationID:wordName:headers:failure:success:)","abstract":"

    Delete a custom word.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C19createAcousticModelySS4name_SS04baseG4NameSSSg11descriptions10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"createAcousticModel(name:baseModelName:description:headers:failure:success:)","abstract":"

    Create a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18listAcousticModelsySSSg8language_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"listAcousticModels(language:headers:failure:success:)","abstract":"

    List custom acoustic models.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C16getAcousticModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"getAcousticModel(customizationID:headers:failure:success:)","abstract":"

    Get a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C19deleteAcousticModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteAcousticModel(customizationID:headers:failure:success:)","abstract":"

    Delete a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18trainAcousticModelySS15customizationID_SSSg014customLanguagegI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"trainAcousticModel(customizationID:customLanguageModelID:headers:failure:success:)","abstract":"

    Train a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C18resetAcousticModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"resetAcousticModel(customizationID:headers:failure:success:)","abstract":"

    Reset a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C20upgradeAcousticModelySS15customizationID_SSSg014customLanguagegI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"upgradeAcousticModel(customizationID:customLanguageModelID:headers:failure:success:)","abstract":"

    Upgrade a custom acoustic model.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9listAudioySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F9ResourcesVc7successtF":{"name":"listAudio(customizationID:headers:failure:success:)","abstract":"

    List audio resources.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8addAudioySS15customizationID_SS9audioName10Foundation4DataV0I8ResourceSS11contentTypeSSSg016containedContentO0SbSg14allowOverwrites10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addAudio(customizationID:audioName:audioResource:contentType:containedContentType:allowOverwrite:headers:failure:success:)","abstract":"

    Add an audio resource.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C8getAudioySS15customizationID_SS9audioNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F7ListingVc7successtF":{"name":"getAudio(customizationID:audioName:headers:failure:success:)","abstract":"

    Get an audio resource.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C11deleteAudioySS15customizationID_SS9audioNames10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteAudio(customizationID:audioName:headers:failure:success:)","abstract":"

    Delete an audio resource.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

    Delete labeled data.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9recognizey10Foundation3URLV5audio_AA19RecognitionSettingsV8settingsSSSg5modelAL15customizationIDSbSg14learningOptOutys5Error_pcSg7failureyAA0aI7ResultsVc7successtF":{"name":"recognize(audio:settings:model:customizationID:learningOptOut:failure:success:)","abstract":"

    Perform speech recognition for an audio file.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C9recognizey10Foundation4DataV5audio_AA19RecognitionSettingsV8settingsSSSg5modelAL15customizationIDSbSg14learningOptOutys5Error_pcSg7failureyAA0aI7ResultsVc7successtF":{"name":"recognize(audio:settings:model:customizationID:learningOptOut:failure:success:)","abstract":"

    Perform speech recognition for audio data.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C19recognizeMicrophoneyAA19RecognitionSettingsV8settings_SSSg5modelAH15customizationIDSbSg14learningOptOutSb8compressys5Error_pcSg7failureyAA0aG7ResultsVc7successtF":{"name":"recognizeMicrophone(settings:model:customizationID:learningOptOut:compress:failure:success:)","abstract":"

    Perform speech recognition for microphone audio. To stop the microphone, invoke","parent_name":"SpeechToText"},"Classes/SpeechToText.html#/s:14SpeechToTextV10abC0C23stopRecognizeMicrophoneyyF":{"name":"stopRecognizeMicrophone()","abstract":"

    Stop performing speech recognition for microphone audio.

    ","parent_name":"SpeechToText"},"Classes/SpeechToText.html":{"name":"SpeechToText","abstract":"

    The IBM® Speech to Text service provides an API that uses IBM’s speech-recognition capabilities to produce"},"Classes/SpeechToTextSession.html":{"name":"SpeechToTextSession","abstract":"

    The IBM Watson Speech to Text service enables you to add speech transcription capabilities to"},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "}} \ No newline at end of file diff --git a/docs/swift-api/services/SpeechToTextV1/undocumented.json b/docs/swift-api/services/SpeechToTextV1/undocumented.json index 15bddb38b..70d2c5b18 100644 --- a/docs/swift-api/services/SpeechToTextV1/undocumented.json +++ b/docs/swift-api/services/SpeechToTextV1/undocumented.json @@ -2,406 +2,413 @@ "warnings": [ { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AcousticModel.swift", - "line": 24, + "line": 33, "symbol": "AcousticModel.Status.pending", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AcousticModel.swift", - "line": 25, + "line": 34, "symbol": "AcousticModel.Status.ready", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AcousticModel.swift", - "line": 26, + "line": 35, "symbol": "AcousticModel.Status.training", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AcousticModel.swift", - "line": 27, + "line": 36, "symbol": "AcousticModel.Status.available", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AcousticModel.swift", - "line": 28, + "line": 37, "symbol": "AcousticModel.Status.upgrading", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AcousticModel.swift", - "line": 29, + "line": 38, "symbol": "AcousticModel.Status.failed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioDetails.swift", - "line": 24, + "line": 30, "symbol": "AudioDetails.ModelType.audio", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioDetails.swift", - "line": 25, + "line": 31, "symbol": "AudioDetails.ModelType.archive", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioDetails.swift", - "line": 30, + "line": 32, + "symbol": "AudioDetails.ModelType.undetermined", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioDetails.swift", + "line": 42, "symbol": "AudioDetails.Compression.zip", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioDetails.swift", - "line": 31, + "line": 43, "symbol": "AudioDetails.Compression.gzip", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioListing.swift", - "line": 24, + "line": 33, "symbol": "AudioListing.Status.ok", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioListing.swift", - "line": 25, + "line": 34, "symbol": "AudioListing.Status.beingProcessed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioListing.swift", - "line": 26, + "line": 35, "symbol": "AudioListing.Status.invalid", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioResource.swift", - "line": 24, + "line": 33, "symbol": "AudioResource.Status.ok", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioResource.swift", - "line": 25, + "line": 34, "symbol": "AudioResource.Status.beingProcessed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioResource.swift", - "line": 26, + "line": 35, "symbol": "AudioResource.Status.invalid", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/Corpus.swift", - "line": 24, + "line": 31, "symbol": "Corpus.Status.analyzed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/Corpus.swift", - "line": 25, + "line": 32, "symbol": "Corpus.Status.beingProcessed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/Corpus.swift", - "line": 26, + "line": 33, "symbol": "Corpus.Status.undetermined", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 24, + "line": 29, "symbol": "CreateAcousticModel.BaseModelName.arArBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 25, + "line": 30, "symbol": "CreateAcousticModel.BaseModelName.enGbBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 26, + "line": 31, "symbol": "CreateAcousticModel.BaseModelName.enGbNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 27, + "line": 32, "symbol": "CreateAcousticModel.BaseModelName.enUsBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 28, + "line": 33, "symbol": "CreateAcousticModel.BaseModelName.enUsNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 29, + "line": 34, "symbol": "CreateAcousticModel.BaseModelName.esEsBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 30, + "line": 35, "symbol": "CreateAcousticModel.BaseModelName.esEsNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 31, + "line": 36, "symbol": "CreateAcousticModel.BaseModelName.frFrBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 32, + "line": 37, "symbol": "CreateAcousticModel.BaseModelName.jaJpBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 33, + "line": 38, "symbol": "CreateAcousticModel.BaseModelName.jaJpNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 34, + "line": 39, "symbol": "CreateAcousticModel.BaseModelName.koKrBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 35, + "line": 40, "symbol": "CreateAcousticModel.BaseModelName.koKrNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 36, + "line": 41, "symbol": "CreateAcousticModel.BaseModelName.ptBrBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 37, + "line": 42, "symbol": "CreateAcousticModel.BaseModelName.ptBrNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 38, + "line": 43, "symbol": "CreateAcousticModel.BaseModelName.zhCnBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 39, + "line": 44, "symbol": "CreateAcousticModel.BaseModelName.zhCnNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 24, + "line": 30, "symbol": "CreateLanguageModel.BaseModelName.enGbBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 25, + "line": 31, "symbol": "CreateLanguageModel.BaseModelName.enGbNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 26, + "line": 32, "symbol": "CreateLanguageModel.BaseModelName.enUsBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 27, + "line": 33, "symbol": "CreateLanguageModel.BaseModelName.enUsNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 28, + "line": 34, "symbol": "CreateLanguageModel.BaseModelName.esEsBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 29, + "line": 35, "symbol": "CreateLanguageModel.BaseModelName.esEsNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 30, + "line": 36, "symbol": "CreateLanguageModel.BaseModelName.frFrBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 31, + "line": 37, "symbol": "CreateLanguageModel.BaseModelName.jaJpBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 32, + "line": 38, "symbol": "CreateLanguageModel.BaseModelName.jaJpNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 33, + "line": 39, "symbol": "CreateLanguageModel.BaseModelName.koKrBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 34, + "line": 40, "symbol": "CreateLanguageModel.BaseModelName.koKrNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/LanguageModel.swift", - "line": 24, + "line": 33, "symbol": "LanguageModel.Status.pending", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/LanguageModel.swift", - "line": 25, + "line": 34, "symbol": "LanguageModel.Status.ready", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/LanguageModel.swift", - "line": 26, + "line": 35, "symbol": "LanguageModel.Status.training", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/LanguageModel.swift", - "line": 27, + "line": 36, "symbol": "LanguageModel.Status.available", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/LanguageModel.swift", - "line": 28, + "line": 37, "symbol": "LanguageModel.Status.upgrading", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/LanguageModel.swift", - "line": 29, + "line": 38, "symbol": "LanguageModel.Status.failed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/RecognitionJob.swift", - "line": 24, + "line": 34, "symbol": "RecognitionJob.Status.waiting", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/RecognitionJob.swift", - "line": 25, + "line": 35, "symbol": "RecognitionJob.Status.processing", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/RecognitionJob.swift", - "line": 26, + "line": 36, "symbol": "RecognitionJob.Status.completed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/RecognitionJob.swift", - "line": 27, + "line": 37, "symbol": "RecognitionJob.Status.failed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/RegisterStatus.swift", - "line": 24, + "line": 28, "symbol": "RegisterStatus.Status.created", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/RegisterStatus.swift", - "line": 25, + "line": 29, "symbol": "RegisterStatus.Status.alreadyCreated", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" diff --git a/docs/swift-api/services/TextToSpeechV1/Classes.html b/docs/swift-api/services/TextToSpeechV1/Classes.html index 70e9d4dba..f5b03b5b6 100644 --- a/docs/swift-api/services/TextToSpeechV1/Classes.html +++ b/docs/swift-api/services/TextToSpeechV1/Classes.html @@ -56,9 +56,6 @@ - @@ -184,7 +181,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/Classes/TextToSpeech.html b/docs/swift-api/services/TextToSpeechV1/Classes/TextToSpeech.html index 3744227e6..f01c65fe5 100644 --- a/docs/swift-api/services/TextToSpeechV1/Classes/TextToSpeech.html +++ b/docs/swift-api/services/TextToSpeechV1/Classes/TextToSpeech.html @@ -56,9 +56,6 @@ - @@ -600,12 +597,11 @@

    Parameters

    maximum of 5 KB of text. Use the Accept header or the accept query parameter to specify the requested format (MIME type) of the response audio. By default, the service uses audio/ogg;codecs=opus. For detailed information about the supported audio formats and sampling rates, see Specifying an audio -format. Specify a value of -application/json for the Content-Type header. If a request includes invalid query parameters, the service -returns a Warnings response header that provides messages about the invalid parameters. The warning includes a -descriptive message and a list of invalid argument strings. For example, a message such as \"Unknown arguments:\" -or \"Unknown url query arguments:\" followed by a list of the form \"invalid_arg_1, invalid_arg_2.\" The -request succeeds despite the warnings.

    +format. +If a request includes invalid query parameters, the service returns a Warnings response header that provides +messages about the invalid parameters. The warning includes a descriptive message and a list of invalid argument +strings. For example, a message such as \"Unknown arguments:\" or \"Unknown url query arguments:\" followed by +a list of the form \"invalid_arg_1, invalid_arg_2.\" The request succeeds despite the warnings.

    @@ -647,9 +643,11 @@

    Parameters

    -

    The type of the response: audio/basic, audio/flac, audio/l16;rate=nnnn, audio/ogg, audio/ogg;codecs=opus, -audio/ogg;codecs=vorbis, audio/mp3, audio/mpeg, audio/mulaw;rate=nnnn, audio/wav, audio/webm, -audio/webm;codecs=opus, or audio/webm;codecs=vorbis.

    +

    The requested audio format (MIME type) of the audio. You can use the Accept header or the accept query +parameter to specify the audio format. (For the audio/l16 format, you can optionally specify +endianness=big-endian or endianness=little-endian; the default is little endian.) For detailed information +about the supported audio formats and sampling rates, see Specifying an audio +format.

    @@ -673,10 +671,10 @@

    Parameters

    -

    The customization ID (GUID) of a custom voice model to use for the synthesis. If a custom voice model is specified, -it is guaranteed to work only if it matches the language of the indicated voice. You must make the request with -service credentials created for the instance of the service that owns the custom model. Omit the parameter to use -the specified voice with no customization.

    +

    The customization ID (GUID) of a custom voice model to use for the synthesis. If a custom voice model is +specified, it is guaranteed to work only if it matches the language of the indicated voice. You must make the +request with service credentials created for the instance of the service that owns the custom model. Omit the +parameter to use the specified voice with no customization.

    @@ -739,8 +737,8 @@

    Parameters

    Gets the phonetic pronunciation for the specified word. You can request the pronunciation for a specific format. You can also request the pronunciation for a specific voice to see the default translation for the language of that -voice or for a specific custom voice model to see the translation for that voice model. Note: This method is -currently a beta release.

    +voice or for a specific custom voice model to see the translation for that voice model. +Note: This method is currently a beta release.

    @@ -782,8 +780,8 @@

    Parameters

    -

    A voice that specifies the language in which the pronunciation is to be returned. All voices for the same language -(for example, en-US) return the same translation.

    +

    A voice that specifies the language in which the pronunciation is to be returned. All voices for the same +language (for example, en-US) return the same translation.

    @@ -808,11 +806,11 @@

    Parameters

    -

    The customization ID (GUID) of a custom voice model for which the pronunciation is to be returned. The language of -a specified custom model must match the language of the specified voice. If the word is not defined in the -specified custom model, the service returns the default translation for the custom model’s language. You must make -the request with service credentials created for the instance of the service that owns the custom model. Omit the -parameter to see the translation for the specified voice with no customization.

    +

    The customization ID (GUID) of a custom voice model for which the pronunciation is to be returned. The language +of a specified custom model must match the language of the specified voice. If the word is not defined in the +specified custom model, the service returns the default translation for the custom model’s language. You must +make the request with service credentials created for the instance of the service that owns the custom model. +Omit the parameter to see the translation for the specified voice with no customization.

    @@ -874,8 +872,8 @@

    Parameters

    Create a custom model.

    Creates a new empty custom voice model. You must specify a name for the new custom model. You can optionally -specify the language and a description for the new model. Specify a value of application/json for the -Content-Type header. The model is owned by the instance of the service whose credentials are used to create it. +specify the language and a description for the new model. The model is owned by the instance of the service whose +credentials are used to create it. Note: This method is currently a beta release.

    @@ -993,8 +991,8 @@

    Parameters

    Lists metadata such as the name and description for all custom voice models that are owned by an instance of the service. Specify a language to list the voice models for that language only. To see the words in addition to the metadata for a specific voice model, use the List a custom model method. You must use credentials for the -instance of the service that owns a model to list information about it. Note: This method is currently a beta -release.

    +instance of the service that owns a model to list information about it. +Note: This method is currently a beta release.

    @@ -1021,8 +1019,8 @@

    Parameters

    -

    The language for which custom voice models that are owned by the requesting service credentials are to be returned. -Omit the parameter to see all custom voice models that are owned by the requester.

    +

    The language for which custom voice models that are owned by the requesting service credentials are to be +returned. Omit the parameter to see all custom voice models that are owned by the requester.

    @@ -1086,9 +1084,9 @@

    Parameters

    Updates information for the specified custom voice model. You can update metadata such as the name and description of the voice model. You can also update the words in the model and their translations. Adding a new translation for a word that already exists in a custom model overwrites the word’s existing translation. A custom model can contain -no more than 20,000 entries. Specify a value of application/json for the Content-Type header. You must use -credentials for the instance of the service that owns a model to update it. Note: This method is currently a -beta release.

    +no more than 20,000 entries. You must use credentials for the instance of the service that owns a model to update +it. +Note: This method is currently a beta release.

    @@ -1219,8 +1217,8 @@

    Parameters

    Gets all information about a specified custom voice model. In addition to metadata such as the name and description of the voice model, the output includes the words and their translations as defined in the model. To see just the -metadata for a voice model, use the List custom models method. Note: This method is currently a beta -release.

    +metadata for a voice model, use the List custom models method. +Note: This method is currently a beta release.

    @@ -1310,7 +1308,8 @@

    Parameters

    Delete a custom model.

    Deletes the specified custom voice model. You must use credentials for the instance of the service that owns a -model to delete it. Note: This method is currently a beta release.

    +model to delete it. +Note: This method is currently a beta release.

    @@ -1401,9 +1400,9 @@

    Parameters

    Adds one or more words and their translations to the specified custom voice model. Adding a new translation for a word that already exists in a custom model overwrites the word’s existing translation. A custom model can contain -no more than 20,000 entries. Specify a value of application/json for the Content-Type header. You must use -credentials for the instance of the service that owns a model to add words to it. Note: This method is -currently a beta release.

    +no more than 20,000 entries. You must use credentials for the instance of the service that owns a model to add +words to it. +Note: This method is currently a beta release.

    @@ -1444,11 +1443,11 @@

    Parameters

    -

    The Add custom words method accepts an array of Word objects. Each object provides a word that is to be added -or updated for the custom voice model and the word’s translation. The List custom words method returns an -array of Word objects. Each object shows a word and its translation from the custom voice model. The words are -listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if the -custom model contains no words.

    +

    The Add custom words method accepts an array of Word objects. Each object provides a word that is to be +added or updated for the custom voice model and the word’s translation. +The List custom words method returns an array of Word objects. Each object shows a word and its translation +from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before +lowercase letters. The array is empty if the custom model contains no words.

    @@ -1511,7 +1510,8 @@

    Parameters

    Lists all of the words and their translations for the specified custom voice model. The output shows the translations as they are defined in the model. You must use credentials for the instance of the service that owns a -model to list its words. Note: This method is currently a beta release.

    +model to list its words. +Note: This method is currently a beta release.

    @@ -1602,9 +1602,9 @@

    Parameters

    Adds a single word and its translation to the specified custom voice model. Adding a new translation for a word that already exists in a custom model overwrites the word’s existing translation. A custom model can contain no -more than 20,000 entries. Specify a value of application/json for the Content-Type header. You must use -credentials for the instance of the service that owns a model to add a word to it. Note: This method is -currently a beta release.

    +more than 20,000 entries. You must use credentials for the instance of the service that owns a model to add a word +to it. +Note: This method is currently a beta release.

    @@ -1660,8 +1660,8 @@

    Parameters

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for -representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A sounds-like -is one or more words that, when combined, sound like the word.

    +representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A +sounds-like is one or more words that, when combined, sound like the word.

    @@ -1674,9 +1674,10 @@

    Parameters

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation -for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot -create multiple entries with different parts of speech for the same word. For more information, see Working with -Japanese entries.

    +for the word. You can create only a single entry, with or without a single part of speech, for any word; you +cannot create multiple entries with different parts of speech for the same word. For more information, see +Working with Japanese +entries.

    @@ -1739,7 +1740,7 @@

    Parameters

    Gets the translation for a single word from the specified custom model. The output shows the translation as it is defined in the model. You must use credentials for the instance of the service that owns a model to list its words. - Note: This method is currently a beta release.

    +Note: This method is currently a beta release.

    @@ -1842,7 +1843,8 @@

    Parameters

    Delete a custom word.

    Deletes a single word from the specified custom voice model. You must use credentials for the instance of the -service that owns a model to delete its words. Note: This method is currently a beta release.

    +service that owns a model to delete its words. +Note: This method is currently a beta release.

    @@ -1947,9 +1949,10 @@

    Parameters

    Deletes all data that is associated with a specified customer ID. The method deletes all data for the customer ID, regardless of the method by which the information was added. The method has no effect if no data is associated with the customer ID. You must issue the request with credentials for the same instance of the service that was used to -associate the customer ID with the data. You associate a customer ID with data by passing the X-Watson-Metadata -header with a request that passes the data. For more information about customer IDs and about using this method, -see Information security.

    +associate the customer ID with the data. +You associate a customer ID with data by passing the X-Watson-Metadata header with a request that passes the +data. For more information about customer IDs and about using this method, see Information +security.

    @@ -2027,7 +2030,7 @@

    Parameters

    diff --git a/docs/swift-api/services/TextToSpeechV1/Enums.html b/docs/swift-api/services/TextToSpeechV1/Enums.html index 11702bdf0..ba888c068 100644 --- a/docs/swift-api/services/TextToSpeechV1/Enums.html +++ b/docs/swift-api/services/TextToSpeechV1/Enums.html @@ -56,9 +56,6 @@ - @@ -177,7 +174,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/Enums/JSON.html b/docs/swift-api/services/TextToSpeechV1/Enums/JSON.html index 4f23cdf8d..24fa3ffa8 100644 --- a/docs/swift-api/services/TextToSpeechV1/Enums/JSON.html +++ b/docs/swift-api/services/TextToSpeechV1/Enums/JSON.html @@ -56,9 +56,6 @@ - @@ -447,7 +444,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/Enums/RestError.html b/docs/swift-api/services/TextToSpeechV1/Enums/RestError.html index 094c5dc23..19d59157e 100644 --- a/docs/swift-api/services/TextToSpeechV1/Enums/RestError.html +++ b/docs/swift-api/services/TextToSpeechV1/Enums/RestError.html @@ -56,9 +56,6 @@ - @@ -314,7 +311,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/Structs.html b/docs/swift-api/services/TextToSpeechV1/Structs.html index 935b58724..189a8a9af 100644 --- a/docs/swift-api/services/TextToSpeechV1/Structs.html +++ b/docs/swift-api/services/TextToSpeechV1/Structs.html @@ -56,9 +56,6 @@ - @@ -110,45 +107,6 @@

    Structures

    -
    -
    - - - -

    JSON

    -
    -
    -
      -
    • -
      - - - - JSONWrapper - -
      -
      -
      -
      -
      -
      -

      Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public struct JSONWrapper
      - -
      -
      -
      -
      -
    • -
    -
    • @@ -536,7 +494,7 @@

      Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/Structs/CreateVoiceModel.html b/docs/swift-api/services/TextToSpeechV1/Structs/CreateVoiceModel.html index 1bb4b6b2c..56bf6faa9 100644 --- a/docs/swift-api/services/TextToSpeechV1/Structs/CreateVoiceModel.html +++ b/docs/swift-api/services/TextToSpeechV1/Structs/CreateVoiceModel.html @@ -56,9 +56,6 @@ - @@ -247,7 +244,11 @@

    Declaration

    Declaration

    Swift

    -
    public init(name: String, language: String? = nil, description: String? = nil)
    +
    public init(
    +    name: String,
    +    language: String? = nil,
    +    description: String? = nil
    +)
    @@ -306,7 +307,7 @@

    Return Value

    diff --git a/docs/swift-api/services/TextToSpeechV1/Structs/CreateVoiceModel/Language.html b/docs/swift-api/services/TextToSpeechV1/Structs/CreateVoiceModel/Language.html index 4e37126be..38f4d519a 100644 --- a/docs/swift-api/services/TextToSpeechV1/Structs/CreateVoiceModel/Language.html +++ b/docs/swift-api/services/TextToSpeechV1/Structs/CreateVoiceModel/Language.html @@ -56,9 +56,6 @@ - @@ -393,7 +390,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/Structs/Pronunciation.html b/docs/swift-api/services/TextToSpeechV1/Structs/Pronunciation.html index 436ae71dd..e3f41aba6 100644 --- a/docs/swift-api/services/TextToSpeechV1/Structs/Pronunciation.html +++ b/docs/swift-api/services/TextToSpeechV1/Structs/Pronunciation.html @@ -56,9 +56,6 @@ - @@ -131,7 +128,8 @@

    Pronunciation

    -

    The pronunciation of the specified text in the requested voice and format. If a custom voice model is specified, the pronunciation also reflects that custom voice.

    +

    The pronunciation of the specified text in the requested voice and format. If a custom voice model is specified, +the pronunciation also reflects that custom voice.

    @@ -150,7 +148,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/Structs/SupportedFeatures.html b/docs/swift-api/services/TextToSpeechV1/Structs/SupportedFeatures.html index cd1d1b20a..2804a0c78 100644 --- a/docs/swift-api/services/TextToSpeechV1/Structs/SupportedFeatures.html +++ b/docs/swift-api/services/TextToSpeechV1/Structs/SupportedFeatures.html @@ -56,9 +56,6 @@ - @@ -158,7 +155,8 @@

    Declaration

    -

    If true, the voice can be transformed by using the SSML <voice-transformation> element; if false, the voice cannot be transformed.

    +

    If true, the voice can be transformed by using the SSML <voice-transformation> element; if false, the +voice cannot be transformed.

    @@ -177,7 +175,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/Structs/Text.html b/docs/swift-api/services/TextToSpeechV1/Structs/Text.html index 06a0be9e0..610adb0b9 100644 --- a/docs/swift-api/services/TextToSpeechV1/Structs/Text.html +++ b/docs/swift-api/services/TextToSpeechV1/Structs/Text.html @@ -56,9 +56,6 @@ - @@ -165,7 +162,9 @@

    Declaration

    Declaration

    Swift

    -
    public init(text: String)
    +
    public init(
    +    text: String
    +)
    @@ -200,7 +199,7 @@

    Return Value

    diff --git a/docs/swift-api/services/TextToSpeechV1/Structs/Translation.html b/docs/swift-api/services/TextToSpeechV1/Structs/Translation.html index 20871d0f4..fa3d2dc01 100644 --- a/docs/swift-api/services/TextToSpeechV1/Structs/Translation.html +++ b/docs/swift-api/services/TextToSpeechV1/Structs/Translation.html @@ -56,9 +56,6 @@ - @@ -131,7 +128,10 @@

    Translation

    -

    Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    +

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation +for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot +create multiple entries with different parts of speech for the same word. For more information, see Working with +Japanese entries.

    See more
    @@ -159,7 +159,9 @@

    Declaration

    -

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A sounds-like is one or more words that, when combined, sound like the word.

    +

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for +representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A sounds-like +is one or more words that, when combined, sound like the word.

    @@ -186,7 +188,10 @@

    Declaration

    -

    Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    +

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation +for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot +create multiple entries with different parts of speech for the same word. For more information, see Working with +Japanese entries.

    @@ -220,7 +225,10 @@

    Declaration

    Declaration

    Swift

    -
    public init(translation: String, partOfSpeech: String? = nil)
    +
    public init(
    +    translation: String,
    +    partOfSpeech: String? = nil
    +)
    @@ -236,7 +244,9 @@

    Parameters

    -

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A sounds-like is one or more words that, when combined, sound like the word.

    +

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for +representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A +sounds-like is one or more words that, when combined, sound like the word.

    @@ -248,7 +258,11 @@

    Parameters

    -

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    +

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation +for the word. You can create only a single entry, with or without a single part of speech, for any word; you +cannot create multiple entries with different parts of speech for the same word. For more information, see +Working with Japanese +entries.

    @@ -267,7 +281,7 @@

    Return Value

    diff --git a/docs/swift-api/services/TextToSpeechV1/Structs/Translation/PartOfSpeech.html b/docs/swift-api/services/TextToSpeechV1/Structs/Translation/PartOfSpeech.html index b8f994ed2..c285a5f5c 100644 --- a/docs/swift-api/services/TextToSpeechV1/Structs/Translation/PartOfSpeech.html +++ b/docs/swift-api/services/TextToSpeechV1/Structs/Translation/PartOfSpeech.html @@ -56,9 +56,6 @@ - @@ -112,7 +109,10 @@

    PartOfSpeech

    -

    Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    +

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation +for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot +create multiple entries with different parts of speech for the same word. For more information, see Working with +Japanese entries.

    @@ -582,7 +582,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/Structs/UpdateVoiceModel.html b/docs/swift-api/services/TextToSpeechV1/Structs/UpdateVoiceModel.html index bf6e0def5..0634df335 100644 --- a/docs/swift-api/services/TextToSpeechV1/Structs/UpdateVoiceModel.html +++ b/docs/swift-api/services/TextToSpeechV1/Structs/UpdateVoiceModel.html @@ -56,9 +56,6 @@ - @@ -185,7 +182,8 @@

    Declaration

    -

    An array of Word objects that provides the words and their translations that are to be added or updated for the custom voice model. Pass an empty array to make no additions or updates.

    +

    An array of Word objects that provides the words and their translations that are to be added or updated for the +custom voice model. Pass an empty array to make no additions or updates.

    @@ -219,7 +217,11 @@

    Declaration

    Declaration

    Swift

    -
    public init(name: String? = nil, description: String? = nil, words: [Word]? = nil)
    +
    public init(
    +    name: String? = nil,
    +    description: String? = nil,
    +    words: [Word]? = nil
    +)
    @@ -259,7 +261,8 @@

    Parameters

    -

    An array of Word objects that provides the words and their translations that are to be added or updated for the custom voice model. Pass an empty array to make no additions or updates.

    +

    An array of Word objects that provides the words and their translations that are to be added or updated for the +custom voice model. Pass an empty array to make no additions or updates.

    @@ -278,7 +281,7 @@

    Return Value

    diff --git a/docs/swift-api/services/TextToSpeechV1/Structs/Voice.html b/docs/swift-api/services/TextToSpeechV1/Structs/Voice.html index b7efbfc9d..284c2018a 100644 --- a/docs/swift-api/services/TextToSpeechV1/Structs/Voice.html +++ b/docs/swift-api/services/TextToSpeechV1/Structs/Voice.html @@ -56,9 +56,6 @@ - @@ -266,7 +263,8 @@

    Declaration

    -

    If true, the voice can be customized; if false, the voice cannot be customized. (Same as custom_pronunciation; maintained for backward compatibility.).

    +

    If true, the voice can be customized; if false, the voice cannot be customized. (Same as +custom_pronunciation; maintained for backward compatibility.).

    @@ -320,7 +318,8 @@

    Declaration

    -

    Returns information about a specified custom voice model. This field is returned only by the Get a voice method and only when you specify the customization ID of a custom voice model.

    +

    Returns information about a specified custom voice model. This field is returned only by the Get a voice method +and only when you specify the customization ID of a custom voice model.

    @@ -339,7 +338,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/Structs/VoiceModel.html b/docs/swift-api/services/TextToSpeechV1/Structs/VoiceModel.html index 33e867450..49357a923 100644 --- a/docs/swift-api/services/TextToSpeechV1/Structs/VoiceModel.html +++ b/docs/swift-api/services/TextToSpeechV1/Structs/VoiceModel.html @@ -56,9 +56,6 @@ - @@ -131,7 +128,8 @@

    VoiceModel

    -

    The customization ID (GUID) of the custom voice model. The Create a custom model method returns only this field. It does not not return the other fields of this object.

    +

    The customization ID (GUID) of the custom voice model. The Create a custom model method returns only this +field. It does not not return the other fields of this object.

    @@ -239,7 +237,8 @@

    Declaration

    -

    The date and time in Coordinated Universal Time (UTC) at which the custom voice model was created. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    +

    The date and time in Coordinated Universal Time (UTC) at which the custom voice model was created. The value is +provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    @@ -266,7 +265,9 @@

    Declaration

    -

    The date and time in Coordinated Universal Time (UTC) at which the custom voice model was last modified. Equals created when a new voice model is first added but has yet to be updated. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    +

    The date and time in Coordinated Universal Time (UTC) at which the custom voice model was last modified. Equals +created when a new voice model is first added but has yet to be updated. The value is provided in full ISO 8601 +format (YYYY-MM-DDThh:mm:ss.sTZD).

    @@ -320,7 +321,10 @@

    Declaration

    -

    An array of Word objects that lists the words and their translations from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if the custom model contains no words. This field is returned only by the Get a voice method and only when you specify the customization ID of a custom voice model.

    +

    An array of Word objects that lists the words and their translations from the custom voice model. The words are +listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if the +custom model contains no words. This field is returned only by the Get a voice method and only when you specify +the customization ID of a custom voice model.

    @@ -339,7 +343,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/Structs/VoiceModels.html b/docs/swift-api/services/TextToSpeechV1/Structs/VoiceModels.html index 1ee233eb3..6f7d2530a 100644 --- a/docs/swift-api/services/TextToSpeechV1/Structs/VoiceModels.html +++ b/docs/swift-api/services/TextToSpeechV1/Structs/VoiceModels.html @@ -56,9 +56,6 @@ - @@ -131,7 +128,9 @@

    VoiceModels

    -

    An array of VoiceModel objects that provides information about each available custom voice model. The array is empty if the requesting service credentials own no custom voice models (if no language is specified) or own no custom voice models for the specified language.

    +

    An array of VoiceModel objects that provides information about each available custom voice model. The array is +empty if the requesting service credentials own no custom voice models (if no language is specified) or own no +custom voice models for the specified language.

    @@ -150,7 +149,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/Structs/Voices.html b/docs/swift-api/services/TextToSpeechV1/Structs/Voices.html index 77cc6f615..7a32fb5bc 100644 --- a/docs/swift-api/services/TextToSpeechV1/Structs/Voices.html +++ b/docs/swift-api/services/TextToSpeechV1/Structs/Voices.html @@ -56,9 +56,6 @@ - @@ -150,7 +147,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/Structs/Word.html b/docs/swift-api/services/TextToSpeechV1/Structs/Word.html index 74d39f425..614c5038b 100644 --- a/docs/swift-api/services/TextToSpeechV1/Structs/Word.html +++ b/docs/swift-api/services/TextToSpeechV1/Structs/Word.html @@ -56,9 +56,6 @@ - @@ -131,7 +128,10 @@

    Word

    -

    Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    +

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation +for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot +create multiple entries with different parts of speech for the same word. For more information, see Working with +Japanese entries.

    See more
    @@ -186,7 +186,9 @@

    Declaration

    -

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for representing the phonetic string of a word either as an IPA or IBM SPR translation. A sounds-like translation consists of one or more words that, when combined, sound like the word.

    +

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for +representing the phonetic string of a word either as an IPA or IBM SPR translation. A sounds-like translation +consists of one or more words that, when combined, sound like the word.

    @@ -213,7 +215,10 @@

    Declaration

    -

    Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    +

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation +for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot +create multiple entries with different parts of speech for the same word. For more information, see Working with +Japanese entries.

    @@ -247,7 +252,11 @@

    Declaration

    Declaration

    Swift

    -
    public init(word: String, translation: String, partOfSpeech: String? = nil)
    +
    public init(
    +    word: String,
    +    translation: String,
    +    partOfSpeech: String? = nil
    +)
    @@ -275,7 +284,9 @@

    Parameters

    -

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for representing the phonetic string of a word either as an IPA or IBM SPR translation. A sounds-like translation consists of one or more words that, when combined, sound like the word.

    +

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for +representing the phonetic string of a word either as an IPA or IBM SPR translation. A sounds-like translation +consists of one or more words that, when combined, sound like the word.

    @@ -287,7 +298,11 @@

    Parameters

    -

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    +

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation +for the word. You can create only a single entry, with or without a single part of speech, for any word; you +cannot create multiple entries with different parts of speech for the same word. For more information, see +Working with Japanese +entries.

    @@ -306,7 +321,7 @@

    Return Value

    diff --git a/docs/swift-api/services/TextToSpeechV1/Structs/Word/PartOfSpeech.html b/docs/swift-api/services/TextToSpeechV1/Structs/Word/PartOfSpeech.html index 40787a896..134afaccf 100644 --- a/docs/swift-api/services/TextToSpeechV1/Structs/Word/PartOfSpeech.html +++ b/docs/swift-api/services/TextToSpeechV1/Structs/Word/PartOfSpeech.html @@ -56,9 +56,6 @@ - @@ -112,7 +109,10 @@

    PartOfSpeech

    -

    Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    +

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation +for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot +create multiple entries with different parts of speech for the same word. For more information, see Working with +Japanese entries.

    @@ -582,7 +582,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/Structs/Words.html b/docs/swift-api/services/TextToSpeechV1/Structs/Words.html index a0a91e58e..2febd0c8d 100644 --- a/docs/swift-api/services/TextToSpeechV1/Structs/Words.html +++ b/docs/swift-api/services/TextToSpeechV1/Structs/Words.html @@ -56,9 +56,6 @@ - @@ -131,7 +128,11 @@

    Words

    -

    The Add custom words method accepts an array of Word objects. Each object provides a word that is to be added or updated for the custom voice model and the word’s translation. The List custom words method returns an array of Word objects. Each object shows a word and its translation from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if the custom model contains no words.

    +

    The Add custom words method accepts an array of Word objects. Each object provides a word that is to be added +or updated for the custom voice model and the word’s translation. +The List custom words method returns an array of Word objects. Each object shows a word and its translation +from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before +lowercase letters. The array is empty if the custom model contains no words.

    @@ -165,7 +166,9 @@

    Declaration

    Declaration

    Swift

    -
    public init(words: [Word])
    +
    public init(
    +    words: [Word]
    +)
    @@ -181,7 +184,11 @@

    Parameters

    -

    The Add custom words method accepts an array of Word objects. Each object provides a word that is to be added or updated for the custom voice model and the word’s translation. The List custom words method returns an array of Word objects. Each object shows a word and its translation from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if the custom model contains no words.

    +

    The Add custom words method accepts an array of Word objects. Each object provides a word that is to be +added or updated for the custom voice model and the word’s translation. +The List custom words method returns an array of Word objects. Each object shows a word and its translation +from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before +lowercase letters. The array is empty if the custom model contains no words.

    @@ -200,7 +207,7 @@

    Return Value

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Classes.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Classes.html index 70e9d4dba..f5b03b5b6 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Classes.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Classes.html @@ -56,9 +56,6 @@ - @@ -184,7 +181,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Classes/TextToSpeech.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Classes/TextToSpeech.html index 3744227e6..f01c65fe5 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Classes/TextToSpeech.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Classes/TextToSpeech.html @@ -56,9 +56,6 @@ - @@ -600,12 +597,11 @@

    Parameters

    maximum of 5 KB of text. Use the Accept header or the accept query parameter to specify the requested format (MIME type) of the response audio. By default, the service uses audio/ogg;codecs=opus. For detailed information about the supported audio formats and sampling rates, see Specifying an audio -format. Specify a value of -application/json for the Content-Type header. If a request includes invalid query parameters, the service -returns a Warnings response header that provides messages about the invalid parameters. The warning includes a -descriptive message and a list of invalid argument strings. For example, a message such as \"Unknown arguments:\" -or \"Unknown url query arguments:\" followed by a list of the form \"invalid_arg_1, invalid_arg_2.\" The -request succeeds despite the warnings.

    +format. +If a request includes invalid query parameters, the service returns a Warnings response header that provides +messages about the invalid parameters. The warning includes a descriptive message and a list of invalid argument +strings. For example, a message such as \"Unknown arguments:\" or \"Unknown url query arguments:\" followed by +a list of the form \"invalid_arg_1, invalid_arg_2.\" The request succeeds despite the warnings.

    @@ -647,9 +643,11 @@

    Parameters

    -

    The type of the response: audio/basic, audio/flac, audio/l16;rate=nnnn, audio/ogg, audio/ogg;codecs=opus, -audio/ogg;codecs=vorbis, audio/mp3, audio/mpeg, audio/mulaw;rate=nnnn, audio/wav, audio/webm, -audio/webm;codecs=opus, or audio/webm;codecs=vorbis.

    +

    The requested audio format (MIME type) of the audio. You can use the Accept header or the accept query +parameter to specify the audio format. (For the audio/l16 format, you can optionally specify +endianness=big-endian or endianness=little-endian; the default is little endian.) For detailed information +about the supported audio formats and sampling rates, see Specifying an audio +format.

    @@ -673,10 +671,10 @@

    Parameters

    -

    The customization ID (GUID) of a custom voice model to use for the synthesis. If a custom voice model is specified, -it is guaranteed to work only if it matches the language of the indicated voice. You must make the request with -service credentials created for the instance of the service that owns the custom model. Omit the parameter to use -the specified voice with no customization.

    +

    The customization ID (GUID) of a custom voice model to use for the synthesis. If a custom voice model is +specified, it is guaranteed to work only if it matches the language of the indicated voice. You must make the +request with service credentials created for the instance of the service that owns the custom model. Omit the +parameter to use the specified voice with no customization.

    @@ -739,8 +737,8 @@

    Parameters

    Gets the phonetic pronunciation for the specified word. You can request the pronunciation for a specific format. You can also request the pronunciation for a specific voice to see the default translation for the language of that -voice or for a specific custom voice model to see the translation for that voice model. Note: This method is -currently a beta release.

    +voice or for a specific custom voice model to see the translation for that voice model. +Note: This method is currently a beta release.

    @@ -782,8 +780,8 @@

    Parameters

    -

    A voice that specifies the language in which the pronunciation is to be returned. All voices for the same language -(for example, en-US) return the same translation.

    +

    A voice that specifies the language in which the pronunciation is to be returned. All voices for the same +language (for example, en-US) return the same translation.

    @@ -808,11 +806,11 @@

    Parameters

    -

    The customization ID (GUID) of a custom voice model for which the pronunciation is to be returned. The language of -a specified custom model must match the language of the specified voice. If the word is not defined in the -specified custom model, the service returns the default translation for the custom model’s language. You must make -the request with service credentials created for the instance of the service that owns the custom model. Omit the -parameter to see the translation for the specified voice with no customization.

    +

    The customization ID (GUID) of a custom voice model for which the pronunciation is to be returned. The language +of a specified custom model must match the language of the specified voice. If the word is not defined in the +specified custom model, the service returns the default translation for the custom model’s language. You must +make the request with service credentials created for the instance of the service that owns the custom model. +Omit the parameter to see the translation for the specified voice with no customization.

    @@ -874,8 +872,8 @@

    Parameters

    Create a custom model.

    Creates a new empty custom voice model. You must specify a name for the new custom model. You can optionally -specify the language and a description for the new model. Specify a value of application/json for the -Content-Type header. The model is owned by the instance of the service whose credentials are used to create it. +specify the language and a description for the new model. The model is owned by the instance of the service whose +credentials are used to create it. Note: This method is currently a beta release.

    @@ -993,8 +991,8 @@

    Parameters

    Lists metadata such as the name and description for all custom voice models that are owned by an instance of the service. Specify a language to list the voice models for that language only. To see the words in addition to the metadata for a specific voice model, use the List a custom model method. You must use credentials for the -instance of the service that owns a model to list information about it. Note: This method is currently a beta -release.

    +instance of the service that owns a model to list information about it. +Note: This method is currently a beta release.

    @@ -1021,8 +1019,8 @@

    Parameters

    -

    The language for which custom voice models that are owned by the requesting service credentials are to be returned. -Omit the parameter to see all custom voice models that are owned by the requester.

    +

    The language for which custom voice models that are owned by the requesting service credentials are to be +returned. Omit the parameter to see all custom voice models that are owned by the requester.

    @@ -1086,9 +1084,9 @@

    Parameters

    Updates information for the specified custom voice model. You can update metadata such as the name and description of the voice model. You can also update the words in the model and their translations. Adding a new translation for a word that already exists in a custom model overwrites the word’s existing translation. A custom model can contain -no more than 20,000 entries. Specify a value of application/json for the Content-Type header. You must use -credentials for the instance of the service that owns a model to update it. Note: This method is currently a -beta release.

    +no more than 20,000 entries. You must use credentials for the instance of the service that owns a model to update +it. +Note: This method is currently a beta release.

    @@ -1219,8 +1217,8 @@

    Parameters

    Gets all information about a specified custom voice model. In addition to metadata such as the name and description of the voice model, the output includes the words and their translations as defined in the model. To see just the -metadata for a voice model, use the List custom models method. Note: This method is currently a beta -release.

    +metadata for a voice model, use the List custom models method. +Note: This method is currently a beta release.

    @@ -1310,7 +1308,8 @@

    Parameters

    Delete a custom model.

    Deletes the specified custom voice model. You must use credentials for the instance of the service that owns a -model to delete it. Note: This method is currently a beta release.

    +model to delete it. +Note: This method is currently a beta release.

    @@ -1401,9 +1400,9 @@

    Parameters

    Adds one or more words and their translations to the specified custom voice model. Adding a new translation for a word that already exists in a custom model overwrites the word’s existing translation. A custom model can contain -no more than 20,000 entries. Specify a value of application/json for the Content-Type header. You must use -credentials for the instance of the service that owns a model to add words to it. Note: This method is -currently a beta release.

    +no more than 20,000 entries. You must use credentials for the instance of the service that owns a model to add +words to it. +Note: This method is currently a beta release.

    @@ -1444,11 +1443,11 @@

    Parameters

    -

    The Add custom words method accepts an array of Word objects. Each object provides a word that is to be added -or updated for the custom voice model and the word’s translation. The List custom words method returns an -array of Word objects. Each object shows a word and its translation from the custom voice model. The words are -listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if the -custom model contains no words.

    +

    The Add custom words method accepts an array of Word objects. Each object provides a word that is to be +added or updated for the custom voice model and the word’s translation. +The List custom words method returns an array of Word objects. Each object shows a word and its translation +from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before +lowercase letters. The array is empty if the custom model contains no words.

    @@ -1511,7 +1510,8 @@

    Parameters

    Lists all of the words and their translations for the specified custom voice model. The output shows the translations as they are defined in the model. You must use credentials for the instance of the service that owns a -model to list its words. Note: This method is currently a beta release.

    +model to list its words. +Note: This method is currently a beta release.

    @@ -1602,9 +1602,9 @@

    Parameters

    Adds a single word and its translation to the specified custom voice model. Adding a new translation for a word that already exists in a custom model overwrites the word’s existing translation. A custom model can contain no -more than 20,000 entries. Specify a value of application/json for the Content-Type header. You must use -credentials for the instance of the service that owns a model to add a word to it. Note: This method is -currently a beta release.

    +more than 20,000 entries. You must use credentials for the instance of the service that owns a model to add a word +to it. +Note: This method is currently a beta release.

    @@ -1660,8 +1660,8 @@

    Parameters

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for -representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A sounds-like -is one or more words that, when combined, sound like the word.

    +representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A +sounds-like is one or more words that, when combined, sound like the word.

    @@ -1674,9 +1674,10 @@

    Parameters

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation -for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot -create multiple entries with different parts of speech for the same word. For more information, see Working with -Japanese entries.

    +for the word. You can create only a single entry, with or without a single part of speech, for any word; you +cannot create multiple entries with different parts of speech for the same word. For more information, see +Working with Japanese +entries.

    @@ -1739,7 +1740,7 @@

    Parameters

    Gets the translation for a single word from the specified custom model. The output shows the translation as it is defined in the model. You must use credentials for the instance of the service that owns a model to list its words. - Note: This method is currently a beta release.

    +Note: This method is currently a beta release.

    @@ -1842,7 +1843,8 @@

    Parameters

    Delete a custom word.

    Deletes a single word from the specified custom voice model. You must use credentials for the instance of the -service that owns a model to delete its words. Note: This method is currently a beta release.

    +service that owns a model to delete its words. +Note: This method is currently a beta release.

    @@ -1947,9 +1949,10 @@

    Parameters

    Deletes all data that is associated with a specified customer ID. The method deletes all data for the customer ID, regardless of the method by which the information was added. The method has no effect if no data is associated with the customer ID. You must issue the request with credentials for the same instance of the service that was used to -associate the customer ID with the data. You associate a customer ID with data by passing the X-Watson-Metadata -header with a request that passes the data. For more information about customer IDs and about using this method, -see Information security.

    +associate the customer ID with the data. +You associate a customer ID with data by passing the X-Watson-Metadata header with a request that passes the +data. For more information about customer IDs and about using this method, see Information +security.

    @@ -2027,7 +2030,7 @@

    Parameters

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Enums.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Enums.html index 11702bdf0..ba888c068 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Enums.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Enums.html @@ -56,9 +56,6 @@ - @@ -177,7 +174,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html index 4f23cdf8d..24fa3ffa8 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html @@ -56,9 +56,6 @@ - @@ -447,7 +444,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html index 094c5dc23..19d59157e 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html @@ -56,9 +56,6 @@ - @@ -314,7 +311,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs.html index 935b58724..189a8a9af 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs.html @@ -56,9 +56,6 @@ - @@ -110,45 +107,6 @@

    Structures

    -
    -
    - - - -

    JSON

    -
    -
    -
      -
    • -
      - - - - JSONWrapper - -
      -
      -
      -
      -
      -
      -

      Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public struct JSONWrapper
      - -
      -
      -
      -
      -
    • -
    -
    • @@ -536,7 +494,7 @@

      Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateVoiceModel.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateVoiceModel.html index 1bb4b6b2c..56bf6faa9 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateVoiceModel.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateVoiceModel.html @@ -56,9 +56,6 @@ - @@ -247,7 +244,11 @@

    Declaration

    Declaration

    Swift

    -
    public init(name: String, language: String? = nil, description: String? = nil)
    +
    public init(
    +    name: String,
    +    language: String? = nil,
    +    description: String? = nil
    +)
    @@ -306,7 +307,7 @@

    Return Value

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateVoiceModel/Language.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateVoiceModel/Language.html index 4e37126be..38f4d519a 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateVoiceModel/Language.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/CreateVoiceModel/Language.html @@ -56,9 +56,6 @@ - @@ -393,7 +390,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Pronunciation.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Pronunciation.html index 436ae71dd..e3f41aba6 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Pronunciation.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Pronunciation.html @@ -56,9 +56,6 @@ - @@ -131,7 +128,8 @@

    Pronunciation

    -

    The pronunciation of the specified text in the requested voice and format. If a custom voice model is specified, the pronunciation also reflects that custom voice.

    +

    The pronunciation of the specified text in the requested voice and format. If a custom voice model is specified, +the pronunciation also reflects that custom voice.

    @@ -150,7 +148,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/SupportedFeatures.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/SupportedFeatures.html index cd1d1b20a..2804a0c78 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/SupportedFeatures.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/SupportedFeatures.html @@ -56,9 +56,6 @@ - @@ -158,7 +155,8 @@

    Declaration

    -

    If true, the voice can be transformed by using the SSML <voice-transformation> element; if false, the voice cannot be transformed.

    +

    If true, the voice can be transformed by using the SSML <voice-transformation> element; if false, the +voice cannot be transformed.

    @@ -177,7 +175,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Text.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Text.html index 06a0be9e0..610adb0b9 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Text.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Text.html @@ -56,9 +56,6 @@ - @@ -165,7 +162,9 @@

    Declaration

    Declaration

    Swift

    -
    public init(text: String)
    +
    public init(
    +    text: String
    +)
    @@ -200,7 +199,7 @@

    Return Value

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Translation.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Translation.html index 20871d0f4..fa3d2dc01 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Translation.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Translation.html @@ -56,9 +56,6 @@ - @@ -131,7 +128,10 @@

    Translation

    -

    Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    +

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation +for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot +create multiple entries with different parts of speech for the same word. For more information, see Working with +Japanese entries.

    See more
    @@ -159,7 +159,9 @@

    Declaration

    -

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A sounds-like is one or more words that, when combined, sound like the word.

    +

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for +representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A sounds-like +is one or more words that, when combined, sound like the word.

    @@ -186,7 +188,10 @@

    Declaration

    -

    Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    +

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation +for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot +create multiple entries with different parts of speech for the same word. For more information, see Working with +Japanese entries.

    @@ -220,7 +225,10 @@

    Declaration

    Declaration

    Swift

    -
    public init(translation: String, partOfSpeech: String? = nil)
    +
    public init(
    +    translation: String,
    +    partOfSpeech: String? = nil
    +)
    @@ -236,7 +244,9 @@

    Parameters

    -

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A sounds-like is one or more words that, when combined, sound like the word.

    +

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for +representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A +sounds-like is one or more words that, when combined, sound like the word.

    @@ -248,7 +258,11 @@

    Parameters

    -

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    +

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation +for the word. You can create only a single entry, with or without a single part of speech, for any word; you +cannot create multiple entries with different parts of speech for the same word. For more information, see +Working with Japanese +entries.

    @@ -267,7 +281,7 @@

    Return Value

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Translation/PartOfSpeech.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Translation/PartOfSpeech.html index b8f994ed2..c285a5f5c 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Translation/PartOfSpeech.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Translation/PartOfSpeech.html @@ -56,9 +56,6 @@ - @@ -112,7 +109,10 @@

    PartOfSpeech

    -

    Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    +

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation +for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot +create multiple entries with different parts of speech for the same word. For more information, see Working with +Japanese entries.

    @@ -582,7 +582,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateVoiceModel.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateVoiceModel.html index bf6e0def5..0634df335 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateVoiceModel.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/UpdateVoiceModel.html @@ -56,9 +56,6 @@ - @@ -185,7 +182,8 @@

    Declaration

    -

    An array of Word objects that provides the words and their translations that are to be added or updated for the custom voice model. Pass an empty array to make no additions or updates.

    +

    An array of Word objects that provides the words and their translations that are to be added or updated for the +custom voice model. Pass an empty array to make no additions or updates.

    @@ -219,7 +217,11 @@

    Declaration

    Declaration

    Swift

    -
    public init(name: String? = nil, description: String? = nil, words: [Word]? = nil)
    +
    public init(
    +    name: String? = nil,
    +    description: String? = nil,
    +    words: [Word]? = nil
    +)
    @@ -259,7 +261,8 @@

    Parameters

    -

    An array of Word objects that provides the words and their translations that are to be added or updated for the custom voice model. Pass an empty array to make no additions or updates.

    +

    An array of Word objects that provides the words and their translations that are to be added or updated for the +custom voice model. Pass an empty array to make no additions or updates.

    @@ -278,7 +281,7 @@

    Return Value

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Voice.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Voice.html index b7efbfc9d..284c2018a 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Voice.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Voice.html @@ -56,9 +56,6 @@ - @@ -266,7 +263,8 @@

    Declaration

    -

    If true, the voice can be customized; if false, the voice cannot be customized. (Same as custom_pronunciation; maintained for backward compatibility.).

    +

    If true, the voice can be customized; if false, the voice cannot be customized. (Same as +custom_pronunciation; maintained for backward compatibility.).

    @@ -320,7 +318,8 @@

    Declaration

    -

    Returns information about a specified custom voice model. This field is returned only by the Get a voice method and only when you specify the customization ID of a custom voice model.

    +

    Returns information about a specified custom voice model. This field is returned only by the Get a voice method +and only when you specify the customization ID of a custom voice model.

    @@ -339,7 +338,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/VoiceModel.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/VoiceModel.html index 33e867450..49357a923 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/VoiceModel.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/VoiceModel.html @@ -56,9 +56,6 @@ - @@ -131,7 +128,8 @@

    VoiceModel

    -

    The customization ID (GUID) of the custom voice model. The Create a custom model method returns only this field. It does not not return the other fields of this object.

    +

    The customization ID (GUID) of the custom voice model. The Create a custom model method returns only this +field. It does not not return the other fields of this object.

    @@ -239,7 +237,8 @@

    Declaration

    -

    The date and time in Coordinated Universal Time (UTC) at which the custom voice model was created. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    +

    The date and time in Coordinated Universal Time (UTC) at which the custom voice model was created. The value is +provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    @@ -266,7 +265,9 @@

    Declaration

    -

    The date and time in Coordinated Universal Time (UTC) at which the custom voice model was last modified. Equals created when a new voice model is first added but has yet to be updated. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    +

    The date and time in Coordinated Universal Time (UTC) at which the custom voice model was last modified. Equals +created when a new voice model is first added but has yet to be updated. The value is provided in full ISO 8601 +format (YYYY-MM-DDThh:mm:ss.sTZD).

    @@ -320,7 +321,10 @@

    Declaration

    -

    An array of Word objects that lists the words and their translations from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if the custom model contains no words. This field is returned only by the Get a voice method and only when you specify the customization ID of a custom voice model.

    +

    An array of Word objects that lists the words and their translations from the custom voice model. The words are +listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if the +custom model contains no words. This field is returned only by the Get a voice method and only when you specify +the customization ID of a custom voice model.

    @@ -339,7 +343,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/VoiceModels.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/VoiceModels.html index 1ee233eb3..6f7d2530a 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/VoiceModels.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/VoiceModels.html @@ -56,9 +56,6 @@ - @@ -131,7 +128,9 @@

    VoiceModels

    -

    An array of VoiceModel objects that provides information about each available custom voice model. The array is empty if the requesting service credentials own no custom voice models (if no language is specified) or own no custom voice models for the specified language.

    +

    An array of VoiceModel objects that provides information about each available custom voice model. The array is +empty if the requesting service credentials own no custom voice models (if no language is specified) or own no +custom voice models for the specified language.

    @@ -150,7 +149,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Voices.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Voices.html index 77cc6f615..7a32fb5bc 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Voices.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Voices.html @@ -56,9 +56,6 @@ - @@ -150,7 +147,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Word.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Word.html index 74d39f425..614c5038b 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Word.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Word.html @@ -56,9 +56,6 @@ - @@ -131,7 +128,10 @@

    Word

    -

    Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    +

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation +for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot +create multiple entries with different parts of speech for the same word. For more information, see Working with +Japanese entries.

    See more
    @@ -186,7 +186,9 @@

    Declaration

    -

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for representing the phonetic string of a word either as an IPA or IBM SPR translation. A sounds-like translation consists of one or more words that, when combined, sound like the word.

    +

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for +representing the phonetic string of a word either as an IPA or IBM SPR translation. A sounds-like translation +consists of one or more words that, when combined, sound like the word.

    @@ -213,7 +215,10 @@

    Declaration

    -

    Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    +

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation +for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot +create multiple entries with different parts of speech for the same word. For more information, see Working with +Japanese entries.

    @@ -247,7 +252,11 @@

    Declaration

    Declaration

    Swift

    -
    public init(word: String, translation: String, partOfSpeech: String? = nil)
    +
    public init(
    +    word: String,
    +    translation: String,
    +    partOfSpeech: String? = nil
    +)
    @@ -275,7 +284,9 @@

    Parameters

    -

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for representing the phonetic string of a word either as an IPA or IBM SPR translation. A sounds-like translation consists of one or more words that, when combined, sound like the word.

    +

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for +representing the phonetic string of a word either as an IPA or IBM SPR translation. A sounds-like translation +consists of one or more words that, when combined, sound like the word.

    @@ -287,7 +298,11 @@

    Parameters

    -

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    +

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation +for the word. You can create only a single entry, with or without a single part of speech, for any word; you +cannot create multiple entries with different parts of speech for the same word. For more information, see +Working with Japanese +entries.

    @@ -306,7 +321,7 @@

    Return Value

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Word/PartOfSpeech.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Word/PartOfSpeech.html index 40787a896..134afaccf 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Word/PartOfSpeech.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Word/PartOfSpeech.html @@ -56,9 +56,6 @@ - @@ -112,7 +109,10 @@

    PartOfSpeech

    -

    Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    +

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation +for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot +create multiple entries with different parts of speech for the same word. For more information, see Working with +Japanese entries.

    @@ -582,7 +582,7 @@

    Declaration

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Words.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Words.html index a0a91e58e..2febd0c8d 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Words.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/Structs/Words.html @@ -56,9 +56,6 @@ - @@ -131,7 +128,11 @@

    Words

    -

    The Add custom words method accepts an array of Word objects. Each object provides a word that is to be added or updated for the custom voice model and the word’s translation. The List custom words method returns an array of Word objects. Each object shows a word and its translation from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if the custom model contains no words.

    +

    The Add custom words method accepts an array of Word objects. Each object provides a word that is to be added +or updated for the custom voice model and the word’s translation. +The List custom words method returns an array of Word objects. Each object shows a word and its translation +from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before +lowercase letters. The array is empty if the custom model contains no words.

    @@ -165,7 +166,9 @@

    Declaration

    Declaration

    Swift

    -
    public init(words: [Word])
    +
    public init(
    +    words: [Word]
    +)
    @@ -181,7 +184,11 @@

    Parameters

    -

    The Add custom words method accepts an array of Word objects. Each object provides a word that is to be added or updated for the custom voice model and the word’s translation. The List custom words method returns an array of Word objects. Each object shows a word and its translation from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if the custom model contains no words.

    +

    The Add custom words method accepts an array of Word objects. Each object provides a word that is to be +added or updated for the custom voice model and the word’s translation. +The List custom words method returns an array of Word objects. Each object shows a word and its translation +from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before +lowercase letters. The array is empty if the custom model contains no words.

    @@ -200,7 +207,7 @@

    Return Value

    diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/index.html b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/index.html index eccd4eeda..13b36526f 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/index.html +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/index.html @@ -55,9 +55,6 @@ - @@ -145,7 +142,8 @@

    Services

    • Assistant
    • Discovery
    • -
    • Language Translator
    • +
    • Language Translator V2
    • +
    • Language Translator V3
    • Natural Language Classifier
    • Natural Language Understanding
    • Personality Insights
    • @@ -190,7 +188,7 @@

      Swift Package Manager

      Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

      dependencies: [
      -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
      +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
       ]
       

      Service Instances

      @@ -233,7 +231,7 @@

      Username and Password

      API Key

      -

      Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

      +

      Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

      let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
       

      Using IAM

      @@ -468,7 +466,12 @@

      Private Data Collections

    • IBM Discovery - Documentation
    • IBM Discovery - Demo
    -

    Language Translator

    +

    Language Translator V2

    + +

    Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

    The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

    @@ -479,6 +482,25 @@

    Language Translator

    let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} +
    +

    Language Translator V3

    + +

    The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

    + +

    The following example demonstrates how to use the Language Translator service:

    +
    import LanguageTranslatorV3
    +
    +let username = "your-username-here"
    +let password = "your-password-here"
    +let version = "yyyy-mm-dd" // use today's date for the most recent version
    +let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
    +
     let failure = { (error: Error) in print(error) }
     let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
     languageTranslator.translate(request: request, failure: failure) {
    @@ -869,7 +891,7 @@ 

    Visual Recognition

    let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -877,6 +899,10 @@

    Visual Recognition

    print(classifiedImages) }
    + +

    Note: a different initializer is used for authentication with instances created before May 23, 2018:

    +
    let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
    +

    Using Core ML

    The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

    @@ -928,7 +954,7 @@

    Bundlin diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/search.json b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/search.json index 32bf99a8a..1e306fc99 100644 --- a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/search.json +++ b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/Documents/search.json @@ -1 +1 @@ -{"Structs/Words.html#/s:14TextToSpeechV15WordsV5wordsSayAA4WordVGvp":{"name":"words","abstract":"

    The Add custom words method accepts an array of Word objects. Each object provides a word that is to be added or updated for the custom voice model and the word’s translation. The List custom words method returns an array of Word objects. Each object shows a word and its translation from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if the custom model contains no words.

    ","parent_name":"Words"},"Structs/Words.html#/s:14TextToSpeechV15WordsVACSayAA4WordVG5words_tcfc":{"name":"init(words:)","abstract":"

    Initialize a Words with member variables.

    ","parent_name":"Words"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4josiA2EmF":{"name":"josi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4mesiA2EmF":{"name":"mesi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4kigoA2EmF":{"name":"kigo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4gobiA2EmF":{"name":"gobi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4dosiA2EmF":{"name":"dosi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4jodoA2EmF":{"name":"jodo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4koyuA2EmF":{"name":"koyu","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4stbiA2EmF":{"name":"stbi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4sujiA2EmF":{"name":"suji","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4kedoA2EmF":{"name":"kedo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4fukuA2EmF":{"name":"fuku","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4keyoA2EmF":{"name":"keyo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4sttoA2EmF":{"name":"stto","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4retaA2EmF":{"name":"reta","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4stzoA2EmF":{"name":"stzo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4katoA2EmF":{"name":"kato","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4hokaA2EmF":{"name":"hoka","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html":{"name":"PartOfSpeech","abstract":"

    Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    ","parent_name":"Word"},"Structs/Word.html#/s:14TextToSpeechV14WordV4wordSSvp":{"name":"word","abstract":"

    A word from the custom voice model.

    ","parent_name":"Word"},"Structs/Word.html#/s:14TextToSpeechV14WordV11translationSSvp":{"name":"translation","abstract":"

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for representing the phonetic string of a word either as an IPA or IBM SPR translation. A sounds-like translation consists of one or more words that, when combined, sound like the word.

    ","parent_name":"Word"},"Structs/Word.html#/s:14TextToSpeechV14WordV06partOfC0SSSgvp":{"name":"partOfSpeech","abstract":"

    Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    ","parent_name":"Word"},"Structs/Word.html#/s:14TextToSpeechV14WordVACSS4word_SS11translationSSSg06partOfC0tcfc":{"name":"init(word:translation:partOfSpeech:)","abstract":"

    Initialize a Word with member variables.

    ","parent_name":"Word"},"Structs/Voices.html#/s:14TextToSpeechV16VoicesV6voicesSayAA5VoiceVGvp":{"name":"voices","abstract":"

    A list of available voices.

    ","parent_name":"Voices"},"Structs/VoiceModels.html#/s:14TextToSpeechV111VoiceModelsV14customizationsSayAA0E5ModelVGvp":{"name":"customizations","abstract":"

    An array of VoiceModel objects that provides information about each available custom voice model. The array is empty if the requesting service credentials own no custom voice models (if no language is specified) or own no custom voice models for the specified language.

    ","parent_name":"VoiceModels"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV15customizationIDSSvp":{"name":"customizationID","abstract":"

    The customization ID (GUID) of the custom voice model. The Create a custom model method returns only this field. It does not not return the other fields of this object.

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV4nameSSSgvp":{"name":"name","abstract":"

    The name of the custom voice model.

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV8languageSSSgvp":{"name":"language","abstract":"

    The language identifier of the custom voice model (for example, en-US).

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV5ownerSSSgvp":{"name":"owner","abstract":"

    The GUID of the service credentials for the instance of the service that owns the custom voice model.

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV7createdSSSgvp":{"name":"created","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the custom voice model was created. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV12lastModifiedSSSgvp":{"name":"lastModified","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the custom voice model was last modified. Equals created when a new voice model is first added but has yet to be updated. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV11descriptionSSSgvp":{"name":"description","abstract":"

    The description of the custom voice model.

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV5wordsSayAA4WordVGSgvp":{"name":"words","abstract":"

    An array of Word objects that lists the words and their translations from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if the custom model contains no words. This field is returned only by the Get a voice method and only when you specify the customization ID of a custom voice model.

    ","parent_name":"VoiceModel"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV3urlSSvp":{"name":"url","abstract":"

    The URI of the voice.

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV6genderSSvp":{"name":"gender","abstract":"

    The gender of the voice: male or female.

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV4nameSSvp":{"name":"name","abstract":"

    The name of the voice. Use this as the voice identifier in all requests.

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV8languageSSvp":{"name":"language","abstract":"

    The language and region of the voice (for example, en-US).

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV11descriptionSSvp":{"name":"description","abstract":"

    A textual description of the voice.

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV12customizableSbvp":{"name":"customizable","abstract":"

    If true, the voice can be customized; if false, the voice cannot be customized. (Same as custom_pronunciation; maintained for backward compatibility.).

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV17supportedFeaturesAA09SupportedG0Vvp":{"name":"supportedFeatures","abstract":"

    Describes the additional service features supported with the voice.

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV13customizationAA0E5ModelVSgvp":{"name":"customization","abstract":"

    Returns information about a specified custom voice model. This field is returned only by the Get a voice method and only when you specify the customization ID of a custom voice model.

    ","parent_name":"Voice"},"Structs/UpdateVoiceModel.html#/s:14TextToSpeechV116UpdateVoiceModelV4nameSSSgvp":{"name":"name","abstract":"

    A new name for the custom voice model.

    ","parent_name":"UpdateVoiceModel"},"Structs/UpdateVoiceModel.html#/s:14TextToSpeechV116UpdateVoiceModelV11descriptionSSSgvp":{"name":"description","abstract":"

    A new description for the custom voice model.

    ","parent_name":"UpdateVoiceModel"},"Structs/UpdateVoiceModel.html#/s:14TextToSpeechV116UpdateVoiceModelV5wordsSayAA4WordVGSgvp":{"name":"words","abstract":"

    An array of Word objects that provides the words and their translations that are to be added or updated for the custom voice model. Pass an empty array to make no additions or updates.

    ","parent_name":"UpdateVoiceModel"},"Structs/UpdateVoiceModel.html#/s:14TextToSpeechV116UpdateVoiceModelVACSSSg4name_AD11descriptionSayAA4WordVGSg5wordstcfc":{"name":"init(name:description:words:)","abstract":"

    Initialize a UpdateVoiceModel with member variables.

    ","parent_name":"UpdateVoiceModel"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4josiA2EmF":{"name":"josi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4mesiA2EmF":{"name":"mesi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4kigoA2EmF":{"name":"kigo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4gobiA2EmF":{"name":"gobi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4dosiA2EmF":{"name":"dosi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4jodoA2EmF":{"name":"jodo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4koyuA2EmF":{"name":"koyu","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4stbiA2EmF":{"name":"stbi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4sujiA2EmF":{"name":"suji","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4kedoA2EmF":{"name":"kedo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4fukuA2EmF":{"name":"fuku","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4keyoA2EmF":{"name":"keyo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4sttoA2EmF":{"name":"stto","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4retaA2EmF":{"name":"reta","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4stzoA2EmF":{"name":"stzo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4katoA2EmF":{"name":"kato","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4hokaA2EmF":{"name":"hoka","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html":{"name":"PartOfSpeech","abstract":"

    Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    ","parent_name":"Translation"},"Structs/Translation.html#/s:14TextToSpeechV111TranslationV11translationSSvp":{"name":"translation","abstract":"

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A sounds-like is one or more words that, when combined, sound like the word.

    ","parent_name":"Translation"},"Structs/Translation.html#/s:14TextToSpeechV111TranslationV06partOfC0SSSgvp":{"name":"partOfSpeech","abstract":"

    Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    ","parent_name":"Translation"},"Structs/Translation.html#/s:14TextToSpeechV111TranslationVACSS11translation_SSSg06partOfC0tcfc":{"name":"init(translation:partOfSpeech:)","abstract":"

    Initialize a Translation with member variables.

    ","parent_name":"Translation"},"Structs/Text.html#/s:14TextToSpeechV10A0V4textSSvp":{"name":"text","abstract":"

    The text to synthesize.

    ","parent_name":"Text"},"Structs/Text.html#/s:14TextToSpeechV10A0VACSS4text_tcfc":{"name":"init(text:)","abstract":"

    Initialize a Text with member variables.

    ","parent_name":"Text"},"Structs/SupportedFeatures.html#/s:14TextToSpeechV117SupportedFeaturesV19customPronunciationSbvp":{"name":"customPronunciation","abstract":"

    If true, the voice can be customized; if false, the voice cannot be customized. (Same as customizable.).

    ","parent_name":"SupportedFeatures"},"Structs/SupportedFeatures.html#/s:14TextToSpeechV117SupportedFeaturesV19voiceTransformationSbvp":{"name":"voiceTransformation","abstract":"

    If true, the voice can be transformed by using the SSML <voice-transformation> element; if false, the voice cannot be transformed.

    ","parent_name":"SupportedFeatures"},"Structs/Pronunciation.html#/s:14TextToSpeechV113PronunciationV13pronunciationSSvp":{"name":"pronunciation","abstract":"

    The pronunciation of the specified text in the requested voice and format. If a custom voice model is specified, the pronunciation also reflects that custom voice.

    ","parent_name":"Pronunciation"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4deDeA2EmF":{"name":"deDe","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4enUsA2EmF":{"name":"enUs","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4enGbA2EmF":{"name":"enGb","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4esEsA2EmF":{"name":"esEs","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4esLaA2EmF":{"name":"esLa","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4esUsA2EmF":{"name":"esUs","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4frFrA2EmF":{"name":"frFr","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4itItA2EmF":{"name":"itIt","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4jaJpA2EmF":{"name":"jaJp","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4ptBrA2EmF":{"name":"ptBr","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html":{"name":"Language","abstract":"

    The language of the new custom voice model. Omit the parameter to use the the default language, en-US.

    ","parent_name":"CreateVoiceModel"},"Structs/CreateVoiceModel.html#/s:14TextToSpeechV116CreateVoiceModelV4nameSSvp":{"name":"name","abstract":"

    The name of the new custom voice model.

    ","parent_name":"CreateVoiceModel"},"Structs/CreateVoiceModel.html#/s:14TextToSpeechV116CreateVoiceModelV8languageSSSgvp":{"name":"language","abstract":"

    The language of the new custom voice model. Omit the parameter to use the the default language, en-US.

    ","parent_name":"CreateVoiceModel"},"Structs/CreateVoiceModel.html#/s:14TextToSpeechV116CreateVoiceModelV11descriptionSSSgvp":{"name":"description","abstract":"

    A description of the new custom voice model. Specifying a description is recommended.

    ","parent_name":"CreateVoiceModel"},"Structs/CreateVoiceModel.html#/s:14TextToSpeechV116CreateVoiceModelVACSS4name_SSSg8languageAE11descriptiontcfc":{"name":"init(name:language:description:)","abstract":"

    Initialize a CreateVoiceModel with member variables.

    ","parent_name":"CreateVoiceModel"},"Structs.html#/s:14TextToSpeechV111JSONWrapperV":{"name":"JSONWrapper","abstract":"

    Used internally to serialize and deserialize JSON."},"Structs/CreateVoiceModel.html":{"name":"CreateVoiceModel","abstract":"

    CreateVoiceModel.

    "},"Structs/Pronunciation.html":{"name":"Pronunciation","abstract":"

    Pronunciation.

    "},"Structs/SupportedFeatures.html":{"name":"SupportedFeatures","abstract":"

    SupportedFeatures.

    "},"Structs/Text.html":{"name":"Text","abstract":"

    Text.

    "},"Structs/Translation.html":{"name":"Translation","abstract":"

    Translation.

    "},"Structs/UpdateVoiceModel.html":{"name":"UpdateVoiceModel","abstract":"

    UpdateVoiceModel.

    "},"Structs/Voice.html":{"name":"Voice","abstract":"

    Voice.

    "},"Structs/VoiceModel.html":{"name":"VoiceModel","abstract":"

    VoiceModel.

    "},"Structs/VoiceModels.html":{"name":"VoiceModels","abstract":"

    VoiceModels.

    "},"Structs/Voices.html":{"name":"Voices","abstract":"

    Voices.

    "},"Structs/Word.html":{"name":"Word","abstract":"

    Word.

    "},"Structs/Words.html":{"name":"Words","abstract":"

    Words.

    "},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

    No response was received from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

    No data was returned from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO013serializationF0A2CmF":{"name":"serializationError","abstract":"

    Failed to serialize value(s) to data.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO08encodingF0A2CmF":{"name":"encodingError","abstract":"

    Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO011fileManagerF0A2CmF":{"name":"fileManagerError","abstract":"

    FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

    Failed to load the given file.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

    An HTTP error with a status code and description.

    ","parent_name":"RestError"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO4nullA2CmF":{"name":"null","abstract":"

    A null value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

    A boolean value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO6stringACSScACmF":{"name":"string","abstract":"

    A string value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO3intACSicACmF":{"name":"int","abstract":"

    A number value, represented as an integer.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

    A number value, represented as a double.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

    An array value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

    An object value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Decode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

    Initialize a JSON value from an encodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

    Convert this JSON value to a decodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

    Encode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compare two JSON values for equality.

    ","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

    A JSON value (one of string, number, object, array, true, false, or null).

    "},"Enums/RestError.html":{"name":"RestError","abstract":"

    An error from processing a network request or response.

    "},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

    The base URL to use when contacting the service.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

    The default HTTP headers for all requests to the service.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0CACSS8username_SS8passwordtcfc":{"name":"init(username:password:)","abstract":"

    Create a TextToSpeech object.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

    Create a TextToSpeech object.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

    Create a TextToSpeech object.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

    Undocumented

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C10listVoicesys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"listVoices(headers:failure:success:)","abstract":"

    List voices.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C8getVoiceySS5voice_SSSg15customizationIDs10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"getVoice(voice:customizationID:headers:failure:success:)","abstract":"

    Get a voice.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C10synthesizeySS4text_SSSg6acceptAF5voiceAF15customizationIDs10DictionaryVyS2SGSg7headersys5Error_pcSg7failurey10Foundation4DataVc7successtF":{"name":"synthesize(text:accept:voice:customizationID:headers:failure:success:)","abstract":"

    Synthesize audio.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C16getPronunciationySS4text_SSSg5voiceAF6formatAF15customizationIDs10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"getPronunciation(text:voice:format:customizationID:headers:failure:success:)","abstract":"

    Get pronunciation.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C16createVoiceModelySS4name_SSSg8languageAF11descriptions10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"createVoiceModel(name:language:description:headers:failure:success:)","abstract":"

    Create a custom model.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C15listVoiceModelsySSSg8language_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"listVoiceModels(language:headers:failure:success:)","abstract":"

    List custom models.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C16updateVoiceModelySS15customizationID_SSSg4nameAF11descriptionSayAA4WordVGSg5wordss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"updateVoiceModel(customizationID:name:description:words:headers:failure:success:)","abstract":"

    Update a custom model.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C13getVoiceModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"getVoiceModel(customizationID:headers:failure:success:)","abstract":"

    Get a custom model.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C16deleteVoiceModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteVoiceModel(customizationID:headers:failure:success:)","abstract":"

    Delete a custom model.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C8addWordsySS15customizationID_SayAA4WordVG5wordss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addWords(customizationID:words:headers:failure:success:)","abstract":"

    Add custom words.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C9listWordsySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"listWords(customizationID:headers:failure:success:)","abstract":"

    List custom words.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C7addWordySS15customizationID_SS4wordSS11translationSSSg06partOfC0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addWord(customizationID:word:translation:partOfSpeech:headers:failure:success:)","abstract":"

    Add a custom word.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C7getWordySS15customizationID_SS4words10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA11TranslationVc7successtF":{"name":"getWord(customizationID:word:headers:failure:success:)","abstract":"

    Get a custom word.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C10deleteWordySS15customizationID_SS4words10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteWord(customizationID:word:headers:failure:success:)","abstract":"

    Delete a custom word.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

    Delete labeled data.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html":{"name":"TextToSpeech","abstract":"

    Service Overview

    "},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "}} \ No newline at end of file +{"Structs/Words.html#/s:14TextToSpeechV15WordsV5wordsSayAA4WordVGvp":{"name":"words","abstract":"

    The Add custom words method accepts an array of Word objects. Each object provides a word that is to be added","parent_name":"Words"},"Structs/Words.html#/s:14TextToSpeechV15WordsVACSayAA4WordVG5words_tcfc":{"name":"init(words:)","abstract":"

    Initialize a Words with member variables.

    ","parent_name":"Words"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4josiA2EmF":{"name":"josi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4mesiA2EmF":{"name":"mesi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4kigoA2EmF":{"name":"kigo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4gobiA2EmF":{"name":"gobi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4dosiA2EmF":{"name":"dosi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4jodoA2EmF":{"name":"jodo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4koyuA2EmF":{"name":"koyu","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4stbiA2EmF":{"name":"stbi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4sujiA2EmF":{"name":"suji","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4kedoA2EmF":{"name":"kedo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4fukuA2EmF":{"name":"fuku","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4keyoA2EmF":{"name":"keyo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4sttoA2EmF":{"name":"stto","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4retaA2EmF":{"name":"reta","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4stzoA2EmF":{"name":"stzo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4katoA2EmF":{"name":"kato","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4hokaA2EmF":{"name":"hoka","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html":{"name":"PartOfSpeech","abstract":"

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation","parent_name":"Word"},"Structs/Word.html#/s:14TextToSpeechV14WordV4wordSSvp":{"name":"word","abstract":"

    A word from the custom voice model.

    ","parent_name":"Word"},"Structs/Word.html#/s:14TextToSpeechV14WordV11translationSSvp":{"name":"translation","abstract":"

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for","parent_name":"Word"},"Structs/Word.html#/s:14TextToSpeechV14WordV06partOfC0SSSgvp":{"name":"partOfSpeech","abstract":"

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation","parent_name":"Word"},"Structs/Word.html#/s:14TextToSpeechV14WordVACSS4word_SS11translationSSSg06partOfC0tcfc":{"name":"init(word:translation:partOfSpeech:)","abstract":"

    Initialize a Word with member variables.

    ","parent_name":"Word"},"Structs/Voices.html#/s:14TextToSpeechV16VoicesV6voicesSayAA5VoiceVGvp":{"name":"voices","abstract":"

    A list of available voices.

    ","parent_name":"Voices"},"Structs/VoiceModels.html#/s:14TextToSpeechV111VoiceModelsV14customizationsSayAA0E5ModelVGvp":{"name":"customizations","abstract":"

    An array of VoiceModel objects that provides information about each available custom voice model. The array is","parent_name":"VoiceModels"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV15customizationIDSSvp":{"name":"customizationID","abstract":"

    The customization ID (GUID) of the custom voice model. The Create a custom model method returns only this","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV4nameSSSgvp":{"name":"name","abstract":"

    The name of the custom voice model.

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV8languageSSSgvp":{"name":"language","abstract":"

    The language identifier of the custom voice model (for example, en-US).

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV5ownerSSSgvp":{"name":"owner","abstract":"

    The GUID of the service credentials for the instance of the service that owns the custom voice model.

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV7createdSSSgvp":{"name":"created","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the custom voice model was created. The value is","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV12lastModifiedSSSgvp":{"name":"lastModified","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the custom voice model was last modified. Equals","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV11descriptionSSSgvp":{"name":"description","abstract":"

    The description of the custom voice model.

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV5wordsSayAA4WordVGSgvp":{"name":"words","abstract":"

    An array of Word objects that lists the words and their translations from the custom voice model. The words are","parent_name":"VoiceModel"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV3urlSSvp":{"name":"url","abstract":"

    The URI of the voice.

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV6genderSSvp":{"name":"gender","abstract":"

    The gender of the voice: male or female.

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV4nameSSvp":{"name":"name","abstract":"

    The name of the voice. Use this as the voice identifier in all requests.

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV8languageSSvp":{"name":"language","abstract":"

    The language and region of the voice (for example, en-US).

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV11descriptionSSvp":{"name":"description","abstract":"

    A textual description of the voice.

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV12customizableSbvp":{"name":"customizable","abstract":"

    If true, the voice can be customized; if false, the voice cannot be customized. (Same as","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV17supportedFeaturesAA09SupportedG0Vvp":{"name":"supportedFeatures","abstract":"

    Describes the additional service features supported with the voice.

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV13customizationAA0E5ModelVSgvp":{"name":"customization","abstract":"

    Returns information about a specified custom voice model. This field is returned only by the Get a voice method","parent_name":"Voice"},"Structs/UpdateVoiceModel.html#/s:14TextToSpeechV116UpdateVoiceModelV4nameSSSgvp":{"name":"name","abstract":"

    A new name for the custom voice model.

    ","parent_name":"UpdateVoiceModel"},"Structs/UpdateVoiceModel.html#/s:14TextToSpeechV116UpdateVoiceModelV11descriptionSSSgvp":{"name":"description","abstract":"

    A new description for the custom voice model.

    ","parent_name":"UpdateVoiceModel"},"Structs/UpdateVoiceModel.html#/s:14TextToSpeechV116UpdateVoiceModelV5wordsSayAA4WordVGSgvp":{"name":"words","abstract":"

    An array of Word objects that provides the words and their translations that are to be added or updated for the","parent_name":"UpdateVoiceModel"},"Structs/UpdateVoiceModel.html#/s:14TextToSpeechV116UpdateVoiceModelVACSSSg4name_AD11descriptionSayAA4WordVGSg5wordstcfc":{"name":"init(name:description:words:)","abstract":"

    Initialize a UpdateVoiceModel with member variables.

    ","parent_name":"UpdateVoiceModel"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4josiA2EmF":{"name":"josi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4mesiA2EmF":{"name":"mesi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4kigoA2EmF":{"name":"kigo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4gobiA2EmF":{"name":"gobi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4dosiA2EmF":{"name":"dosi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4jodoA2EmF":{"name":"jodo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4koyuA2EmF":{"name":"koyu","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4stbiA2EmF":{"name":"stbi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4sujiA2EmF":{"name":"suji","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4kedoA2EmF":{"name":"kedo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4fukuA2EmF":{"name":"fuku","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4keyoA2EmF":{"name":"keyo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4sttoA2EmF":{"name":"stto","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4retaA2EmF":{"name":"reta","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4stzoA2EmF":{"name":"stzo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4katoA2EmF":{"name":"kato","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4hokaA2EmF":{"name":"hoka","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html":{"name":"PartOfSpeech","abstract":"

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation","parent_name":"Translation"},"Structs/Translation.html#/s:14TextToSpeechV111TranslationV11translationSSvp":{"name":"translation","abstract":"

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for","parent_name":"Translation"},"Structs/Translation.html#/s:14TextToSpeechV111TranslationV06partOfC0SSSgvp":{"name":"partOfSpeech","abstract":"

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation","parent_name":"Translation"},"Structs/Translation.html#/s:14TextToSpeechV111TranslationVACSS11translation_SSSg06partOfC0tcfc":{"name":"init(translation:partOfSpeech:)","abstract":"

    Initialize a Translation with member variables.

    ","parent_name":"Translation"},"Structs/Text.html#/s:14TextToSpeechV10A0V4textSSvp":{"name":"text","abstract":"

    The text to synthesize.

    ","parent_name":"Text"},"Structs/Text.html#/s:14TextToSpeechV10A0VACSS4text_tcfc":{"name":"init(text:)","abstract":"

    Initialize a Text with member variables.

    ","parent_name":"Text"},"Structs/SupportedFeatures.html#/s:14TextToSpeechV117SupportedFeaturesV19customPronunciationSbvp":{"name":"customPronunciation","abstract":"

    If true, the voice can be customized; if false, the voice cannot be customized. (Same as customizable.).

    ","parent_name":"SupportedFeatures"},"Structs/SupportedFeatures.html#/s:14TextToSpeechV117SupportedFeaturesV19voiceTransformationSbvp":{"name":"voiceTransformation","abstract":"

    If true, the voice can be transformed by using the SSML <voice-transformation> element; if false, the","parent_name":"SupportedFeatures"},"Structs/Pronunciation.html#/s:14TextToSpeechV113PronunciationV13pronunciationSSvp":{"name":"pronunciation","abstract":"

    The pronunciation of the specified text in the requested voice and format. If a custom voice model is specified,","parent_name":"Pronunciation"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4deDeA2EmF":{"name":"deDe","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4enUsA2EmF":{"name":"enUs","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4enGbA2EmF":{"name":"enGb","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4esEsA2EmF":{"name":"esEs","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4esLaA2EmF":{"name":"esLa","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4esUsA2EmF":{"name":"esUs","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4frFrA2EmF":{"name":"frFr","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4itItA2EmF":{"name":"itIt","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4jaJpA2EmF":{"name":"jaJp","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4ptBrA2EmF":{"name":"ptBr","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html":{"name":"Language","abstract":"

    The language of the new custom voice model. Omit the parameter to use the the default language, en-US.

    ","parent_name":"CreateVoiceModel"},"Structs/CreateVoiceModel.html#/s:14TextToSpeechV116CreateVoiceModelV4nameSSvp":{"name":"name","abstract":"

    The name of the new custom voice model.

    ","parent_name":"CreateVoiceModel"},"Structs/CreateVoiceModel.html#/s:14TextToSpeechV116CreateVoiceModelV8languageSSSgvp":{"name":"language","abstract":"

    The language of the new custom voice model. Omit the parameter to use the the default language, en-US.

    ","parent_name":"CreateVoiceModel"},"Structs/CreateVoiceModel.html#/s:14TextToSpeechV116CreateVoiceModelV11descriptionSSSgvp":{"name":"description","abstract":"

    A description of the new custom voice model. Specifying a description is recommended.

    ","parent_name":"CreateVoiceModel"},"Structs/CreateVoiceModel.html#/s:14TextToSpeechV116CreateVoiceModelVACSS4name_SSSg8languageAE11descriptiontcfc":{"name":"init(name:language:description:)","abstract":"

    Initialize a CreateVoiceModel with member variables.

    ","parent_name":"CreateVoiceModel"},"Structs/CreateVoiceModel.html":{"name":"CreateVoiceModel","abstract":"

    CreateVoiceModel.

    "},"Structs/Pronunciation.html":{"name":"Pronunciation","abstract":"

    Pronunciation.

    "},"Structs/SupportedFeatures.html":{"name":"SupportedFeatures","abstract":"

    SupportedFeatures.

    "},"Structs/Text.html":{"name":"Text","abstract":"

    Text.

    "},"Structs/Translation.html":{"name":"Translation","abstract":"

    Translation.

    "},"Structs/UpdateVoiceModel.html":{"name":"UpdateVoiceModel","abstract":"

    UpdateVoiceModel.

    "},"Structs/Voice.html":{"name":"Voice","abstract":"

    Voice.

    "},"Structs/VoiceModel.html":{"name":"VoiceModel","abstract":"

    VoiceModel.

    "},"Structs/VoiceModels.html":{"name":"VoiceModels","abstract":"

    VoiceModels.

    "},"Structs/Voices.html":{"name":"Voices","abstract":"

    Voices.

    "},"Structs/Word.html":{"name":"Word","abstract":"

    Word.

    "},"Structs/Words.html":{"name":"Words","abstract":"

    Words.

    "},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

    No response was received from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

    No data was returned from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO013serializationF0A2CmF":{"name":"serializationError","abstract":"

    Failed to serialize value(s) to data.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO08encodingF0A2CmF":{"name":"encodingError","abstract":"

    Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO011fileManagerF0A2CmF":{"name":"fileManagerError","abstract":"

    FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

    Failed to load the given file.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

    An HTTP error with a status code and description.

    ","parent_name":"RestError"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO4nullA2CmF":{"name":"null","abstract":"

    A null value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

    A boolean value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO6stringACSScACmF":{"name":"string","abstract":"

    A string value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO3intACSicACmF":{"name":"int","abstract":"

    A number value, represented as an integer.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

    A number value, represented as a double.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

    An array value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

    An object value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Decode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

    Initialize a JSON value from an encodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

    Convert this JSON value to a decodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

    Encode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compare two JSON values for equality.

    ","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

    A JSON value (one of string, number, object, array, true, false, or null).

    "},"Enums/RestError.html":{"name":"RestError","abstract":"

    An error from processing a network request or response.

    "},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

    The base URL to use when contacting the service.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

    The default HTTP headers for all requests to the service.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0CACSS8username_SS8passwordtcfc":{"name":"init(username:password:)","abstract":"

    Create a TextToSpeech object.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

    Create a TextToSpeech object.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

    Create a TextToSpeech object.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

    Undocumented

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C10listVoicesys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"listVoices(headers:failure:success:)","abstract":"

    List voices.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C8getVoiceySS5voice_SSSg15customizationIDs10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"getVoice(voice:customizationID:headers:failure:success:)","abstract":"

    Get a voice.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C10synthesizeySS4text_SSSg6acceptAF5voiceAF15customizationIDs10DictionaryVyS2SGSg7headersys5Error_pcSg7failurey10Foundation4DataVc7successtF":{"name":"synthesize(text:accept:voice:customizationID:headers:failure:success:)","abstract":"

    Synthesize audio.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C16getPronunciationySS4text_SSSg5voiceAF6formatAF15customizationIDs10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"getPronunciation(text:voice:format:customizationID:headers:failure:success:)","abstract":"

    Get pronunciation.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C16createVoiceModelySS4name_SSSg8languageAF11descriptions10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"createVoiceModel(name:language:description:headers:failure:success:)","abstract":"

    Create a custom model.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C15listVoiceModelsySSSg8language_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"listVoiceModels(language:headers:failure:success:)","abstract":"

    List custom models.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C16updateVoiceModelySS15customizationID_SSSg4nameAF11descriptionSayAA4WordVGSg5wordss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"updateVoiceModel(customizationID:name:description:words:headers:failure:success:)","abstract":"

    Update a custom model.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C13getVoiceModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"getVoiceModel(customizationID:headers:failure:success:)","abstract":"

    Get a custom model.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C16deleteVoiceModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteVoiceModel(customizationID:headers:failure:success:)","abstract":"

    Delete a custom model.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C8addWordsySS15customizationID_SayAA4WordVG5wordss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addWords(customizationID:words:headers:failure:success:)","abstract":"

    Add custom words.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C9listWordsySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"listWords(customizationID:headers:failure:success:)","abstract":"

    List custom words.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C7addWordySS15customizationID_SS4wordSS11translationSSSg06partOfC0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addWord(customizationID:word:translation:partOfSpeech:headers:failure:success:)","abstract":"

    Add a custom word.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C7getWordySS15customizationID_SS4words10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA11TranslationVc7successtF":{"name":"getWord(customizationID:word:headers:failure:success:)","abstract":"

    Get a custom word.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C10deleteWordySS15customizationID_SS4words10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteWord(customizationID:word:headers:failure:success:)","abstract":"

    Delete a custom word.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

    Delete labeled data.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html":{"name":"TextToSpeech","abstract":"

    Service Overview

    "},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "}} \ No newline at end of file diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/docSet.dsidx b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/docSet.dsidx index cd7545a83..77bf49f93 100644 Binary files a/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/docSet.dsidx and b/docs/swift-api/services/TextToSpeechV1/docsets/.docset/Contents/Resources/docSet.dsidx differ diff --git a/docs/swift-api/services/TextToSpeechV1/docsets/.tgz b/docs/swift-api/services/TextToSpeechV1/docsets/.tgz index 2f87b1ea2..7a3b45635 100644 Binary files a/docs/swift-api/services/TextToSpeechV1/docsets/.tgz and b/docs/swift-api/services/TextToSpeechV1/docsets/.tgz differ diff --git a/docs/swift-api/services/TextToSpeechV1/index.html b/docs/swift-api/services/TextToSpeechV1/index.html index eccd4eeda..13b36526f 100644 --- a/docs/swift-api/services/TextToSpeechV1/index.html +++ b/docs/swift-api/services/TextToSpeechV1/index.html @@ -55,9 +55,6 @@ - @@ -145,7 +142,8 @@

    Services

    • Assistant
    • Discovery
    • -
    • Language Translator
    • +
    • Language Translator V2
    • +
    • Language Translator V3
    • Natural Language Classifier
    • Natural Language Understanding
    • Personality Insights
    • @@ -190,7 +188,7 @@

      Swift Package Manager

      Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

      dependencies: [
      -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
      +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
       ]
       

      Service Instances

      @@ -233,7 +231,7 @@

      Username and Password

      API Key

      -

      Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

      +

      Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

      let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
       

      Using IAM

      @@ -468,7 +466,12 @@

      Private Data Collections

    • IBM Discovery - Documentation
    • IBM Discovery - Demo
    -

    Language Translator

    +

    Language Translator V2

    + +

    Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

    The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

    @@ -479,6 +482,25 @@

    Language Translator

    let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} +
    +

    Language Translator V3

    + +

    The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

    + +

    The following example demonstrates how to use the Language Translator service:

    +
    import LanguageTranslatorV3
    +
    +let username = "your-username-here"
    +let password = "your-password-here"
    +let version = "yyyy-mm-dd" // use today's date for the most recent version
    +let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
    +
     let failure = { (error: Error) in print(error) }
     let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
     languageTranslator.translate(request: request, failure: failure) {
    @@ -869,7 +891,7 @@ 

    Visual Recognition

    let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -877,6 +899,10 @@

    Visual Recognition

    print(classifiedImages) }
    + +

    Note: a different initializer is used for authentication with instances created before May 23, 2018:

    +
    let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
    +

    Using Core ML

    The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

    @@ -928,7 +954,7 @@

    Bundlin diff --git a/docs/swift-api/services/TextToSpeechV1/search.json b/docs/swift-api/services/TextToSpeechV1/search.json index 32bf99a8a..1e306fc99 100644 --- a/docs/swift-api/services/TextToSpeechV1/search.json +++ b/docs/swift-api/services/TextToSpeechV1/search.json @@ -1 +1 @@ -{"Structs/Words.html#/s:14TextToSpeechV15WordsV5wordsSayAA4WordVGvp":{"name":"words","abstract":"

    The Add custom words method accepts an array of Word objects. Each object provides a word that is to be added or updated for the custom voice model and the word’s translation. The List custom words method returns an array of Word objects. Each object shows a word and its translation from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if the custom model contains no words.

    ","parent_name":"Words"},"Structs/Words.html#/s:14TextToSpeechV15WordsVACSayAA4WordVG5words_tcfc":{"name":"init(words:)","abstract":"

    Initialize a Words with member variables.

    ","parent_name":"Words"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4josiA2EmF":{"name":"josi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4mesiA2EmF":{"name":"mesi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4kigoA2EmF":{"name":"kigo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4gobiA2EmF":{"name":"gobi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4dosiA2EmF":{"name":"dosi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4jodoA2EmF":{"name":"jodo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4koyuA2EmF":{"name":"koyu","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4stbiA2EmF":{"name":"stbi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4sujiA2EmF":{"name":"suji","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4kedoA2EmF":{"name":"kedo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4fukuA2EmF":{"name":"fuku","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4keyoA2EmF":{"name":"keyo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4sttoA2EmF":{"name":"stto","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4retaA2EmF":{"name":"reta","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4stzoA2EmF":{"name":"stzo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4katoA2EmF":{"name":"kato","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4hokaA2EmF":{"name":"hoka","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html":{"name":"PartOfSpeech","abstract":"

    Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    ","parent_name":"Word"},"Structs/Word.html#/s:14TextToSpeechV14WordV4wordSSvp":{"name":"word","abstract":"

    A word from the custom voice model.

    ","parent_name":"Word"},"Structs/Word.html#/s:14TextToSpeechV14WordV11translationSSvp":{"name":"translation","abstract":"

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for representing the phonetic string of a word either as an IPA or IBM SPR translation. A sounds-like translation consists of one or more words that, when combined, sound like the word.

    ","parent_name":"Word"},"Structs/Word.html#/s:14TextToSpeechV14WordV06partOfC0SSSgvp":{"name":"partOfSpeech","abstract":"

    Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    ","parent_name":"Word"},"Structs/Word.html#/s:14TextToSpeechV14WordVACSS4word_SS11translationSSSg06partOfC0tcfc":{"name":"init(word:translation:partOfSpeech:)","abstract":"

    Initialize a Word with member variables.

    ","parent_name":"Word"},"Structs/Voices.html#/s:14TextToSpeechV16VoicesV6voicesSayAA5VoiceVGvp":{"name":"voices","abstract":"

    A list of available voices.

    ","parent_name":"Voices"},"Structs/VoiceModels.html#/s:14TextToSpeechV111VoiceModelsV14customizationsSayAA0E5ModelVGvp":{"name":"customizations","abstract":"

    An array of VoiceModel objects that provides information about each available custom voice model. The array is empty if the requesting service credentials own no custom voice models (if no language is specified) or own no custom voice models for the specified language.

    ","parent_name":"VoiceModels"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV15customizationIDSSvp":{"name":"customizationID","abstract":"

    The customization ID (GUID) of the custom voice model. The Create a custom model method returns only this field. It does not not return the other fields of this object.

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV4nameSSSgvp":{"name":"name","abstract":"

    The name of the custom voice model.

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV8languageSSSgvp":{"name":"language","abstract":"

    The language identifier of the custom voice model (for example, en-US).

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV5ownerSSSgvp":{"name":"owner","abstract":"

    The GUID of the service credentials for the instance of the service that owns the custom voice model.

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV7createdSSSgvp":{"name":"created","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the custom voice model was created. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV12lastModifiedSSSgvp":{"name":"lastModified","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the custom voice model was last modified. Equals created when a new voice model is first added but has yet to be updated. The value is provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV11descriptionSSSgvp":{"name":"description","abstract":"

    The description of the custom voice model.

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV5wordsSayAA4WordVGSgvp":{"name":"words","abstract":"

    An array of Word objects that lists the words and their translations from the custom voice model. The words are listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if the custom model contains no words. This field is returned only by the Get a voice method and only when you specify the customization ID of a custom voice model.

    ","parent_name":"VoiceModel"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV3urlSSvp":{"name":"url","abstract":"

    The URI of the voice.

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV6genderSSvp":{"name":"gender","abstract":"

    The gender of the voice: male or female.

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV4nameSSvp":{"name":"name","abstract":"

    The name of the voice. Use this as the voice identifier in all requests.

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV8languageSSvp":{"name":"language","abstract":"

    The language and region of the voice (for example, en-US).

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV11descriptionSSvp":{"name":"description","abstract":"

    A textual description of the voice.

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV12customizableSbvp":{"name":"customizable","abstract":"

    If true, the voice can be customized; if false, the voice cannot be customized. (Same as custom_pronunciation; maintained for backward compatibility.).

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV17supportedFeaturesAA09SupportedG0Vvp":{"name":"supportedFeatures","abstract":"

    Describes the additional service features supported with the voice.

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV13customizationAA0E5ModelVSgvp":{"name":"customization","abstract":"

    Returns information about a specified custom voice model. This field is returned only by the Get a voice method and only when you specify the customization ID of a custom voice model.

    ","parent_name":"Voice"},"Structs/UpdateVoiceModel.html#/s:14TextToSpeechV116UpdateVoiceModelV4nameSSSgvp":{"name":"name","abstract":"

    A new name for the custom voice model.

    ","parent_name":"UpdateVoiceModel"},"Structs/UpdateVoiceModel.html#/s:14TextToSpeechV116UpdateVoiceModelV11descriptionSSSgvp":{"name":"description","abstract":"

    A new description for the custom voice model.

    ","parent_name":"UpdateVoiceModel"},"Structs/UpdateVoiceModel.html#/s:14TextToSpeechV116UpdateVoiceModelV5wordsSayAA4WordVGSgvp":{"name":"words","abstract":"

    An array of Word objects that provides the words and their translations that are to be added or updated for the custom voice model. Pass an empty array to make no additions or updates.

    ","parent_name":"UpdateVoiceModel"},"Structs/UpdateVoiceModel.html#/s:14TextToSpeechV116UpdateVoiceModelVACSSSg4name_AD11descriptionSayAA4WordVGSg5wordstcfc":{"name":"init(name:description:words:)","abstract":"

    Initialize a UpdateVoiceModel with member variables.

    ","parent_name":"UpdateVoiceModel"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4josiA2EmF":{"name":"josi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4mesiA2EmF":{"name":"mesi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4kigoA2EmF":{"name":"kigo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4gobiA2EmF":{"name":"gobi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4dosiA2EmF":{"name":"dosi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4jodoA2EmF":{"name":"jodo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4koyuA2EmF":{"name":"koyu","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4stbiA2EmF":{"name":"stbi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4sujiA2EmF":{"name":"suji","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4kedoA2EmF":{"name":"kedo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4fukuA2EmF":{"name":"fuku","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4keyoA2EmF":{"name":"keyo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4sttoA2EmF":{"name":"stto","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4retaA2EmF":{"name":"reta","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4stzoA2EmF":{"name":"stzo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4katoA2EmF":{"name":"kato","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4hokaA2EmF":{"name":"hoka","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html":{"name":"PartOfSpeech","abstract":"

    Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    ","parent_name":"Translation"},"Structs/Translation.html#/s:14TextToSpeechV111TranslationV11translationSSvp":{"name":"translation","abstract":"

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for representing the phonetic string of a word either as an IPA translation or as an IBM SPR translation. A sounds-like is one or more words that, when combined, sound like the word.

    ","parent_name":"Translation"},"Structs/Translation.html#/s:14TextToSpeechV111TranslationV06partOfC0SSSgvp":{"name":"partOfSpeech","abstract":"

    Japanese only.** The part of speech for the word. The service uses the value to produce the correct intonation for the word. You can create only a single entry, with or without a single part of speech, for any word; you cannot create multiple entries with different parts of speech for the same word. For more information, see Working with Japanese entries.

    ","parent_name":"Translation"},"Structs/Translation.html#/s:14TextToSpeechV111TranslationVACSS11translation_SSSg06partOfC0tcfc":{"name":"init(translation:partOfSpeech:)","abstract":"

    Initialize a Translation with member variables.

    ","parent_name":"Translation"},"Structs/Text.html#/s:14TextToSpeechV10A0V4textSSvp":{"name":"text","abstract":"

    The text to synthesize.

    ","parent_name":"Text"},"Structs/Text.html#/s:14TextToSpeechV10A0VACSS4text_tcfc":{"name":"init(text:)","abstract":"

    Initialize a Text with member variables.

    ","parent_name":"Text"},"Structs/SupportedFeatures.html#/s:14TextToSpeechV117SupportedFeaturesV19customPronunciationSbvp":{"name":"customPronunciation","abstract":"

    If true, the voice can be customized; if false, the voice cannot be customized. (Same as customizable.).

    ","parent_name":"SupportedFeatures"},"Structs/SupportedFeatures.html#/s:14TextToSpeechV117SupportedFeaturesV19voiceTransformationSbvp":{"name":"voiceTransformation","abstract":"

    If true, the voice can be transformed by using the SSML <voice-transformation> element; if false, the voice cannot be transformed.

    ","parent_name":"SupportedFeatures"},"Structs/Pronunciation.html#/s:14TextToSpeechV113PronunciationV13pronunciationSSvp":{"name":"pronunciation","abstract":"

    The pronunciation of the specified text in the requested voice and format. If a custom voice model is specified, the pronunciation also reflects that custom voice.

    ","parent_name":"Pronunciation"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4deDeA2EmF":{"name":"deDe","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4enUsA2EmF":{"name":"enUs","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4enGbA2EmF":{"name":"enGb","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4esEsA2EmF":{"name":"esEs","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4esLaA2EmF":{"name":"esLa","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4esUsA2EmF":{"name":"esUs","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4frFrA2EmF":{"name":"frFr","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4itItA2EmF":{"name":"itIt","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4jaJpA2EmF":{"name":"jaJp","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4ptBrA2EmF":{"name":"ptBr","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html":{"name":"Language","abstract":"

    The language of the new custom voice model. Omit the parameter to use the the default language, en-US.

    ","parent_name":"CreateVoiceModel"},"Structs/CreateVoiceModel.html#/s:14TextToSpeechV116CreateVoiceModelV4nameSSvp":{"name":"name","abstract":"

    The name of the new custom voice model.

    ","parent_name":"CreateVoiceModel"},"Structs/CreateVoiceModel.html#/s:14TextToSpeechV116CreateVoiceModelV8languageSSSgvp":{"name":"language","abstract":"

    The language of the new custom voice model. Omit the parameter to use the the default language, en-US.

    ","parent_name":"CreateVoiceModel"},"Structs/CreateVoiceModel.html#/s:14TextToSpeechV116CreateVoiceModelV11descriptionSSSgvp":{"name":"description","abstract":"

    A description of the new custom voice model. Specifying a description is recommended.

    ","parent_name":"CreateVoiceModel"},"Structs/CreateVoiceModel.html#/s:14TextToSpeechV116CreateVoiceModelVACSS4name_SSSg8languageAE11descriptiontcfc":{"name":"init(name:language:description:)","abstract":"

    Initialize a CreateVoiceModel with member variables.

    ","parent_name":"CreateVoiceModel"},"Structs.html#/s:14TextToSpeechV111JSONWrapperV":{"name":"JSONWrapper","abstract":"

    Used internally to serialize and deserialize JSON."},"Structs/CreateVoiceModel.html":{"name":"CreateVoiceModel","abstract":"

    CreateVoiceModel.

    "},"Structs/Pronunciation.html":{"name":"Pronunciation","abstract":"

    Pronunciation.

    "},"Structs/SupportedFeatures.html":{"name":"SupportedFeatures","abstract":"

    SupportedFeatures.

    "},"Structs/Text.html":{"name":"Text","abstract":"

    Text.

    "},"Structs/Translation.html":{"name":"Translation","abstract":"

    Translation.

    "},"Structs/UpdateVoiceModel.html":{"name":"UpdateVoiceModel","abstract":"

    UpdateVoiceModel.

    "},"Structs/Voice.html":{"name":"Voice","abstract":"

    Voice.

    "},"Structs/VoiceModel.html":{"name":"VoiceModel","abstract":"

    VoiceModel.

    "},"Structs/VoiceModels.html":{"name":"VoiceModels","abstract":"

    VoiceModels.

    "},"Structs/Voices.html":{"name":"Voices","abstract":"

    Voices.

    "},"Structs/Word.html":{"name":"Word","abstract":"

    Word.

    "},"Structs/Words.html":{"name":"Words","abstract":"

    Words.

    "},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

    No response was received from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

    No data was returned from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO013serializationF0A2CmF":{"name":"serializationError","abstract":"

    Failed to serialize value(s) to data.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO08encodingF0A2CmF":{"name":"encodingError","abstract":"

    Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO011fileManagerF0A2CmF":{"name":"fileManagerError","abstract":"

    FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

    Failed to load the given file.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

    An HTTP error with a status code and description.

    ","parent_name":"RestError"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO4nullA2CmF":{"name":"null","abstract":"

    A null value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

    A boolean value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO6stringACSScACmF":{"name":"string","abstract":"

    A string value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO3intACSicACmF":{"name":"int","abstract":"

    A number value, represented as an integer.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

    A number value, represented as a double.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

    An array value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

    An object value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Decode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

    Initialize a JSON value from an encodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

    Convert this JSON value to a decodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

    Encode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compare two JSON values for equality.

    ","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

    A JSON value (one of string, number, object, array, true, false, or null).

    "},"Enums/RestError.html":{"name":"RestError","abstract":"

    An error from processing a network request or response.

    "},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

    The base URL to use when contacting the service.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

    The default HTTP headers for all requests to the service.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0CACSS8username_SS8passwordtcfc":{"name":"init(username:password:)","abstract":"

    Create a TextToSpeech object.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

    Create a TextToSpeech object.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

    Create a TextToSpeech object.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

    Undocumented

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C10listVoicesys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"listVoices(headers:failure:success:)","abstract":"

    List voices.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C8getVoiceySS5voice_SSSg15customizationIDs10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"getVoice(voice:customizationID:headers:failure:success:)","abstract":"

    Get a voice.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C10synthesizeySS4text_SSSg6acceptAF5voiceAF15customizationIDs10DictionaryVyS2SGSg7headersys5Error_pcSg7failurey10Foundation4DataVc7successtF":{"name":"synthesize(text:accept:voice:customizationID:headers:failure:success:)","abstract":"

    Synthesize audio.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C16getPronunciationySS4text_SSSg5voiceAF6formatAF15customizationIDs10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"getPronunciation(text:voice:format:customizationID:headers:failure:success:)","abstract":"

    Get pronunciation.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C16createVoiceModelySS4name_SSSg8languageAF11descriptions10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"createVoiceModel(name:language:description:headers:failure:success:)","abstract":"

    Create a custom model.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C15listVoiceModelsySSSg8language_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"listVoiceModels(language:headers:failure:success:)","abstract":"

    List custom models.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C16updateVoiceModelySS15customizationID_SSSg4nameAF11descriptionSayAA4WordVGSg5wordss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"updateVoiceModel(customizationID:name:description:words:headers:failure:success:)","abstract":"

    Update a custom model.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C13getVoiceModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"getVoiceModel(customizationID:headers:failure:success:)","abstract":"

    Get a custom model.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C16deleteVoiceModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteVoiceModel(customizationID:headers:failure:success:)","abstract":"

    Delete a custom model.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C8addWordsySS15customizationID_SayAA4WordVG5wordss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addWords(customizationID:words:headers:failure:success:)","abstract":"

    Add custom words.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C9listWordsySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"listWords(customizationID:headers:failure:success:)","abstract":"

    List custom words.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C7addWordySS15customizationID_SS4wordSS11translationSSSg06partOfC0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addWord(customizationID:word:translation:partOfSpeech:headers:failure:success:)","abstract":"

    Add a custom word.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C7getWordySS15customizationID_SS4words10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA11TranslationVc7successtF":{"name":"getWord(customizationID:word:headers:failure:success:)","abstract":"

    Get a custom word.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C10deleteWordySS15customizationID_SS4words10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteWord(customizationID:word:headers:failure:success:)","abstract":"

    Delete a custom word.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

    Delete labeled data.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html":{"name":"TextToSpeech","abstract":"

    Service Overview

    "},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "}} \ No newline at end of file +{"Structs/Words.html#/s:14TextToSpeechV15WordsV5wordsSayAA4WordVGvp":{"name":"words","abstract":"

    The Add custom words method accepts an array of Word objects. Each object provides a word that is to be added","parent_name":"Words"},"Structs/Words.html#/s:14TextToSpeechV15WordsVACSayAA4WordVG5words_tcfc":{"name":"init(words:)","abstract":"

    Initialize a Words with member variables.

    ","parent_name":"Words"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4josiA2EmF":{"name":"josi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4mesiA2EmF":{"name":"mesi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4kigoA2EmF":{"name":"kigo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4gobiA2EmF":{"name":"gobi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4dosiA2EmF":{"name":"dosi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4jodoA2EmF":{"name":"jodo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4koyuA2EmF":{"name":"koyu","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4stbiA2EmF":{"name":"stbi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4sujiA2EmF":{"name":"suji","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4kedoA2EmF":{"name":"kedo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4fukuA2EmF":{"name":"fuku","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4keyoA2EmF":{"name":"keyo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4sttoA2EmF":{"name":"stto","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4retaA2EmF":{"name":"reta","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4stzoA2EmF":{"name":"stzo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4katoA2EmF":{"name":"kato","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html#/s:14TextToSpeechV14WordV06PartOfC0O4hokaA2EmF":{"name":"hoka","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Word/PartOfSpeech.html":{"name":"PartOfSpeech","abstract":"

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation","parent_name":"Word"},"Structs/Word.html#/s:14TextToSpeechV14WordV4wordSSvp":{"name":"word","abstract":"

    A word from the custom voice model.

    ","parent_name":"Word"},"Structs/Word.html#/s:14TextToSpeechV14WordV11translationSSvp":{"name":"translation","abstract":"

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for","parent_name":"Word"},"Structs/Word.html#/s:14TextToSpeechV14WordV06partOfC0SSSgvp":{"name":"partOfSpeech","abstract":"

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation","parent_name":"Word"},"Structs/Word.html#/s:14TextToSpeechV14WordVACSS4word_SS11translationSSSg06partOfC0tcfc":{"name":"init(word:translation:partOfSpeech:)","abstract":"

    Initialize a Word with member variables.

    ","parent_name":"Word"},"Structs/Voices.html#/s:14TextToSpeechV16VoicesV6voicesSayAA5VoiceVGvp":{"name":"voices","abstract":"

    A list of available voices.

    ","parent_name":"Voices"},"Structs/VoiceModels.html#/s:14TextToSpeechV111VoiceModelsV14customizationsSayAA0E5ModelVGvp":{"name":"customizations","abstract":"

    An array of VoiceModel objects that provides information about each available custom voice model. The array is","parent_name":"VoiceModels"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV15customizationIDSSvp":{"name":"customizationID","abstract":"

    The customization ID (GUID) of the custom voice model. The Create a custom model method returns only this","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV4nameSSSgvp":{"name":"name","abstract":"

    The name of the custom voice model.

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV8languageSSSgvp":{"name":"language","abstract":"

    The language identifier of the custom voice model (for example, en-US).

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV5ownerSSSgvp":{"name":"owner","abstract":"

    The GUID of the service credentials for the instance of the service that owns the custom voice model.

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV7createdSSSgvp":{"name":"created","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the custom voice model was created. The value is","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV12lastModifiedSSSgvp":{"name":"lastModified","abstract":"

    The date and time in Coordinated Universal Time (UTC) at which the custom voice model was last modified. Equals","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV11descriptionSSSgvp":{"name":"description","abstract":"

    The description of the custom voice model.

    ","parent_name":"VoiceModel"},"Structs/VoiceModel.html#/s:14TextToSpeechV110VoiceModelV5wordsSayAA4WordVGSgvp":{"name":"words","abstract":"

    An array of Word objects that lists the words and their translations from the custom voice model. The words are","parent_name":"VoiceModel"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV3urlSSvp":{"name":"url","abstract":"

    The URI of the voice.

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV6genderSSvp":{"name":"gender","abstract":"

    The gender of the voice: male or female.

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV4nameSSvp":{"name":"name","abstract":"

    The name of the voice. Use this as the voice identifier in all requests.

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV8languageSSvp":{"name":"language","abstract":"

    The language and region of the voice (for example, en-US).

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV11descriptionSSvp":{"name":"description","abstract":"

    A textual description of the voice.

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV12customizableSbvp":{"name":"customizable","abstract":"

    If true, the voice can be customized; if false, the voice cannot be customized. (Same as","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV17supportedFeaturesAA09SupportedG0Vvp":{"name":"supportedFeatures","abstract":"

    Describes the additional service features supported with the voice.

    ","parent_name":"Voice"},"Structs/Voice.html#/s:14TextToSpeechV15VoiceV13customizationAA0E5ModelVSgvp":{"name":"customization","abstract":"

    Returns information about a specified custom voice model. This field is returned only by the Get a voice method","parent_name":"Voice"},"Structs/UpdateVoiceModel.html#/s:14TextToSpeechV116UpdateVoiceModelV4nameSSSgvp":{"name":"name","abstract":"

    A new name for the custom voice model.

    ","parent_name":"UpdateVoiceModel"},"Structs/UpdateVoiceModel.html#/s:14TextToSpeechV116UpdateVoiceModelV11descriptionSSSgvp":{"name":"description","abstract":"

    A new description for the custom voice model.

    ","parent_name":"UpdateVoiceModel"},"Structs/UpdateVoiceModel.html#/s:14TextToSpeechV116UpdateVoiceModelV5wordsSayAA4WordVGSgvp":{"name":"words","abstract":"

    An array of Word objects that provides the words and their translations that are to be added or updated for the","parent_name":"UpdateVoiceModel"},"Structs/UpdateVoiceModel.html#/s:14TextToSpeechV116UpdateVoiceModelVACSSSg4name_AD11descriptionSayAA4WordVGSg5wordstcfc":{"name":"init(name:description:words:)","abstract":"

    Initialize a UpdateVoiceModel with member variables.

    ","parent_name":"UpdateVoiceModel"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4josiA2EmF":{"name":"josi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4mesiA2EmF":{"name":"mesi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4kigoA2EmF":{"name":"kigo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4gobiA2EmF":{"name":"gobi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4dosiA2EmF":{"name":"dosi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4jodoA2EmF":{"name":"jodo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4koyuA2EmF":{"name":"koyu","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4stbiA2EmF":{"name":"stbi","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4sujiA2EmF":{"name":"suji","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4kedoA2EmF":{"name":"kedo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4fukuA2EmF":{"name":"fuku","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4keyoA2EmF":{"name":"keyo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4sttoA2EmF":{"name":"stto","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4retaA2EmF":{"name":"reta","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4stzoA2EmF":{"name":"stzo","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4katoA2EmF":{"name":"kato","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html#/s:14TextToSpeechV111TranslationV06PartOfC0O4hokaA2EmF":{"name":"hoka","abstract":"

    Undocumented

    ","parent_name":"PartOfSpeech"},"Structs/Translation/PartOfSpeech.html":{"name":"PartOfSpeech","abstract":"

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation","parent_name":"Translation"},"Structs/Translation.html#/s:14TextToSpeechV111TranslationV11translationSSvp":{"name":"translation","abstract":"

    The phonetic or sounds-like translation for the word. A phonetic translation is based on the SSML format for","parent_name":"Translation"},"Structs/Translation.html#/s:14TextToSpeechV111TranslationV06partOfC0SSSgvp":{"name":"partOfSpeech","abstract":"

    Japanese only. The part of speech for the word. The service uses the value to produce the correct intonation","parent_name":"Translation"},"Structs/Translation.html#/s:14TextToSpeechV111TranslationVACSS11translation_SSSg06partOfC0tcfc":{"name":"init(translation:partOfSpeech:)","abstract":"

    Initialize a Translation with member variables.

    ","parent_name":"Translation"},"Structs/Text.html#/s:14TextToSpeechV10A0V4textSSvp":{"name":"text","abstract":"

    The text to synthesize.

    ","parent_name":"Text"},"Structs/Text.html#/s:14TextToSpeechV10A0VACSS4text_tcfc":{"name":"init(text:)","abstract":"

    Initialize a Text with member variables.

    ","parent_name":"Text"},"Structs/SupportedFeatures.html#/s:14TextToSpeechV117SupportedFeaturesV19customPronunciationSbvp":{"name":"customPronunciation","abstract":"

    If true, the voice can be customized; if false, the voice cannot be customized. (Same as customizable.).

    ","parent_name":"SupportedFeatures"},"Structs/SupportedFeatures.html#/s:14TextToSpeechV117SupportedFeaturesV19voiceTransformationSbvp":{"name":"voiceTransformation","abstract":"

    If true, the voice can be transformed by using the SSML <voice-transformation> element; if false, the","parent_name":"SupportedFeatures"},"Structs/Pronunciation.html#/s:14TextToSpeechV113PronunciationV13pronunciationSSvp":{"name":"pronunciation","abstract":"

    The pronunciation of the specified text in the requested voice and format. If a custom voice model is specified,","parent_name":"Pronunciation"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4deDeA2EmF":{"name":"deDe","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4enUsA2EmF":{"name":"enUs","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4enGbA2EmF":{"name":"enGb","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4esEsA2EmF":{"name":"esEs","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4esLaA2EmF":{"name":"esLa","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4esUsA2EmF":{"name":"esUs","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4frFrA2EmF":{"name":"frFr","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4itItA2EmF":{"name":"itIt","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4jaJpA2EmF":{"name":"jaJp","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html#/s:14TextToSpeechV116CreateVoiceModelV8LanguageO4ptBrA2EmF":{"name":"ptBr","abstract":"

    Undocumented

    ","parent_name":"Language"},"Structs/CreateVoiceModel/Language.html":{"name":"Language","abstract":"

    The language of the new custom voice model. Omit the parameter to use the the default language, en-US.

    ","parent_name":"CreateVoiceModel"},"Structs/CreateVoiceModel.html#/s:14TextToSpeechV116CreateVoiceModelV4nameSSvp":{"name":"name","abstract":"

    The name of the new custom voice model.

    ","parent_name":"CreateVoiceModel"},"Structs/CreateVoiceModel.html#/s:14TextToSpeechV116CreateVoiceModelV8languageSSSgvp":{"name":"language","abstract":"

    The language of the new custom voice model. Omit the parameter to use the the default language, en-US.

    ","parent_name":"CreateVoiceModel"},"Structs/CreateVoiceModel.html#/s:14TextToSpeechV116CreateVoiceModelV11descriptionSSSgvp":{"name":"description","abstract":"

    A description of the new custom voice model. Specifying a description is recommended.

    ","parent_name":"CreateVoiceModel"},"Structs/CreateVoiceModel.html#/s:14TextToSpeechV116CreateVoiceModelVACSS4name_SSSg8languageAE11descriptiontcfc":{"name":"init(name:language:description:)","abstract":"

    Initialize a CreateVoiceModel with member variables.

    ","parent_name":"CreateVoiceModel"},"Structs/CreateVoiceModel.html":{"name":"CreateVoiceModel","abstract":"

    CreateVoiceModel.

    "},"Structs/Pronunciation.html":{"name":"Pronunciation","abstract":"

    Pronunciation.

    "},"Structs/SupportedFeatures.html":{"name":"SupportedFeatures","abstract":"

    SupportedFeatures.

    "},"Structs/Text.html":{"name":"Text","abstract":"

    Text.

    "},"Structs/Translation.html":{"name":"Translation","abstract":"

    Translation.

    "},"Structs/UpdateVoiceModel.html":{"name":"UpdateVoiceModel","abstract":"

    UpdateVoiceModel.

    "},"Structs/Voice.html":{"name":"Voice","abstract":"

    Voice.

    "},"Structs/VoiceModel.html":{"name":"VoiceModel","abstract":"

    VoiceModel.

    "},"Structs/VoiceModels.html":{"name":"VoiceModels","abstract":"

    VoiceModels.

    "},"Structs/Voices.html":{"name":"Voices","abstract":"

    Voices.

    "},"Structs/Word.html":{"name":"Word","abstract":"

    Word.

    "},"Structs/Words.html":{"name":"Words","abstract":"

    Words.

    "},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

    No response was received from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

    No data was returned from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO013serializationF0A2CmF":{"name":"serializationError","abstract":"

    Failed to serialize value(s) to data.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO08encodingF0A2CmF":{"name":"encodingError","abstract":"

    Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO011fileManagerF0A2CmF":{"name":"fileManagerError","abstract":"

    FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

    Failed to load the given file.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14TextToSpeechV19RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

    An HTTP error with a status code and description.

    ","parent_name":"RestError"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO4nullA2CmF":{"name":"null","abstract":"

    A null value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

    A boolean value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO6stringACSScACmF":{"name":"string","abstract":"

    A string value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO3intACSicACmF":{"name":"int","abstract":"

    A number value, represented as an integer.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO6doubleACSdcACmF":{"name":"double","abstract":"

    A number value, represented as a double.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

    An array value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

    An object value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Decode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

    Initialize a JSON value from an encodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

    Convert this JSON value to a decodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

    Encode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14TextToSpeechV14JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compare two JSON values for equality.

    ","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

    A JSON value (one of string, number, object, array, true, false, or null).

    "},"Enums/RestError.html":{"name":"RestError","abstract":"

    An error from processing a network request or response.

    "},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

    The base URL to use when contacting the service.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

    The default HTTP headers for all requests to the service.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0CACSS8username_SS8passwordtcfc":{"name":"init(username:password:)","abstract":"

    Create a TextToSpeech object.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

    Create a TextToSpeech object.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

    Create a TextToSpeech object.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

    Undocumented

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C10listVoicesys10DictionaryVyS2SGSg7headers_ys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"listVoices(headers:failure:success:)","abstract":"

    List voices.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C8getVoiceySS5voice_SSSg15customizationIDs10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"getVoice(voice:customizationID:headers:failure:success:)","abstract":"

    Get a voice.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C10synthesizeySS4text_SSSg6acceptAF5voiceAF15customizationIDs10DictionaryVyS2SGSg7headersys5Error_pcSg7failurey10Foundation4DataVc7successtF":{"name":"synthesize(text:accept:voice:customizationID:headers:failure:success:)","abstract":"

    Synthesize audio.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C16getPronunciationySS4text_SSSg5voiceAF6formatAF15customizationIDs10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"getPronunciation(text:voice:format:customizationID:headers:failure:success:)","abstract":"

    Get pronunciation.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C16createVoiceModelySS4name_SSSg8languageAF11descriptions10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"createVoiceModel(name:language:description:headers:failure:success:)","abstract":"

    Create a custom model.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C15listVoiceModelsySSSg8language_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"listVoiceModels(language:headers:failure:success:)","abstract":"

    List custom models.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C16updateVoiceModelySS15customizationID_SSSg4nameAF11descriptionSayAA4WordVGSg5wordss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"updateVoiceModel(customizationID:name:description:words:headers:failure:success:)","abstract":"

    Update a custom model.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C13getVoiceModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0fG0Vc7successtF":{"name":"getVoiceModel(customizationID:headers:failure:success:)","abstract":"

    Get a custom model.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C16deleteVoiceModelySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteVoiceModel(customizationID:headers:failure:success:)","abstract":"

    Delete a custom model.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C8addWordsySS15customizationID_SayAA4WordVG5wordss10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addWords(customizationID:words:headers:failure:success:)","abstract":"

    Add custom words.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C9listWordsySS15customizationID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F0Vc7successtF":{"name":"listWords(customizationID:headers:failure:success:)","abstract":"

    List custom words.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C7addWordySS15customizationID_SS4wordSS11translationSSSg06partOfC0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"addWord(customizationID:word:translation:partOfSpeech:headers:failure:success:)","abstract":"

    Add a custom word.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C7getWordySS15customizationID_SS4words10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA11TranslationVc7successtF":{"name":"getWord(customizationID:word:headers:failure:success:)","abstract":"

    Get a custom word.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C10deleteWordySS15customizationID_SS4words10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteWord(customizationID:word:headers:failure:success:)","abstract":"

    Delete a custom word.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html#/s:14TextToSpeechV10abC0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

    Delete labeled data.

    ","parent_name":"TextToSpeech"},"Classes/TextToSpeech.html":{"name":"TextToSpeech","abstract":"

    Service Overview

    "},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "}} \ No newline at end of file diff --git a/docs/swift-api/services/TextToSpeechV1/undocumented.json b/docs/swift-api/services/TextToSpeechV1/undocumented.json index 25a8dfff1..1607627f5 100644 --- a/docs/swift-api/services/TextToSpeechV1/undocumented.json +++ b/docs/swift-api/services/TextToSpeechV1/undocumented.json @@ -2,308 +2,308 @@ "warnings": [ { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/CreateVoiceModel.swift", - "line": 24, + "line": 26, "symbol": "CreateVoiceModel.Language.deDe", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/CreateVoiceModel.swift", - "line": 25, + "line": 27, "symbol": "CreateVoiceModel.Language.enUs", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/CreateVoiceModel.swift", - "line": 26, + "line": 28, "symbol": "CreateVoiceModel.Language.enGb", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/CreateVoiceModel.swift", - "line": 27, + "line": 29, "symbol": "CreateVoiceModel.Language.esEs", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/CreateVoiceModel.swift", - "line": 28, + "line": 30, "symbol": "CreateVoiceModel.Language.esLa", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/CreateVoiceModel.swift", - "line": 29, + "line": 31, "symbol": "CreateVoiceModel.Language.esUs", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/CreateVoiceModel.swift", - "line": 30, + "line": 32, "symbol": "CreateVoiceModel.Language.frFr", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/CreateVoiceModel.swift", - "line": 31, + "line": 33, "symbol": "CreateVoiceModel.Language.itIt", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/CreateVoiceModel.swift", - "line": 32, + "line": 34, "symbol": "CreateVoiceModel.Language.jaJp", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/CreateVoiceModel.swift", - "line": 33, + "line": 35, "symbol": "CreateVoiceModel.Language.ptBr", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 24, + "line": 29, "symbol": "Translation.PartOfSpeech.josi", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 25, + "line": 30, "symbol": "Translation.PartOfSpeech.mesi", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 26, + "line": 31, "symbol": "Translation.PartOfSpeech.kigo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 27, + "line": 32, "symbol": "Translation.PartOfSpeech.gobi", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 28, + "line": 33, "symbol": "Translation.PartOfSpeech.dosi", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 29, + "line": 34, "symbol": "Translation.PartOfSpeech.jodo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 30, + "line": 35, "symbol": "Translation.PartOfSpeech.koyu", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 31, + "line": 36, "symbol": "Translation.PartOfSpeech.stbi", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 32, + "line": 37, "symbol": "Translation.PartOfSpeech.suji", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 33, + "line": 38, "symbol": "Translation.PartOfSpeech.kedo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 34, + "line": 39, "symbol": "Translation.PartOfSpeech.fuku", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 35, + "line": 40, "symbol": "Translation.PartOfSpeech.keyo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 36, + "line": 41, "symbol": "Translation.PartOfSpeech.stto", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 37, + "line": 42, "symbol": "Translation.PartOfSpeech.reta", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 38, + "line": 43, "symbol": "Translation.PartOfSpeech.stzo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 39, + "line": 44, "symbol": "Translation.PartOfSpeech.kato", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 40, + "line": 45, "symbol": "Translation.PartOfSpeech.hoka", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 24, + "line": 29, "symbol": "Word.PartOfSpeech.josi", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 25, + "line": 30, "symbol": "Word.PartOfSpeech.mesi", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 26, + "line": 31, "symbol": "Word.PartOfSpeech.kigo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 27, + "line": 32, "symbol": "Word.PartOfSpeech.gobi", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 28, + "line": 33, "symbol": "Word.PartOfSpeech.dosi", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 29, + "line": 34, "symbol": "Word.PartOfSpeech.jodo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 30, + "line": 35, "symbol": "Word.PartOfSpeech.koyu", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 31, + "line": 36, "symbol": "Word.PartOfSpeech.stbi", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 32, + "line": 37, "symbol": "Word.PartOfSpeech.suji", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 33, + "line": 38, "symbol": "Word.PartOfSpeech.kedo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 34, + "line": 39, "symbol": "Word.PartOfSpeech.fuku", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 35, + "line": 40, "symbol": "Word.PartOfSpeech.keyo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 36, + "line": 41, "symbol": "Word.PartOfSpeech.stto", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 37, + "line": 42, "symbol": "Word.PartOfSpeech.reta", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 38, + "line": 43, "symbol": "Word.PartOfSpeech.stzo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 39, + "line": 44, "symbol": "Word.PartOfSpeech.kato", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 40, + "line": 45, "symbol": "Word.PartOfSpeech.hoka", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" diff --git a/docs/swift-api/services/ToneAnalyzerV3/Classes.html b/docs/swift-api/services/ToneAnalyzerV3/Classes.html index 4342dbaf5..1eb2580f7 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/Classes.html +++ b/docs/swift-api/services/ToneAnalyzerV3/Classes.html @@ -53,9 +53,6 @@ - @@ -113,9 +110,9 @@

    Classes

    -

    The IBM Watson Tone Analyzer service uses linguistic analysis to detect emotional and language tones in written text. -The service can analyze tone at both the document and sentence levels. You can use the service to understand how your -written communications are perceived and then to improve the tone of your communications. Businesses can use the +

    The IBM Watson™ Tone Analyzer service uses linguistic analysis to detect emotional and language tones in written +text. The service can analyze tone at both the document and sentence levels. You can use the service to understand how +your written communications are perceived and then to improve the tone of your communications. Businesses can use the service to learn the tone of their customers’ communications and to respond to each customer appropriately, or to understand and improve their customer conversations. Note: Request logging is disabled for the Tone Analyzer service. The service neither logs nor retains data from @@ -139,7 +136,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/Classes/ToneAnalyzer.html b/docs/swift-api/services/ToneAnalyzerV3/Classes/ToneAnalyzer.html index 4c094c485..d5f9f3973 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/Classes/ToneAnalyzer.html +++ b/docs/swift-api/services/ToneAnalyzerV3/Classes/ToneAnalyzer.html @@ -53,9 +53,6 @@ - @@ -100,9 +97,9 @@

    ToneAnalyzer

    -

    The IBM Watson Tone Analyzer service uses linguistic analysis to detect emotional and language tones in written text. -The service can analyze tone at both the document and sentence levels. You can use the service to understand how your -written communications are perceived and then to improve the tone of your communications. Businesses can use the +

    The IBM Watson™ Tone Analyzer service uses linguistic analysis to detect emotional and language tones in written +text. The service can analyze tone at both the document and sentence levels. You can use the service to understand how +your written communications are perceived and then to improve the tone of your communications. Businesses can use the service to learn the tone of their customers’ communications and to respond to each customer appropriately, or to understand and improve their customer conversations. Note: Request logging is disabled for the Tone Analyzer service. The service neither logs nor retains data from @@ -411,9 +408,10 @@

    Declaration

    Use the general purpose endpoint to analyze the tone of your input content. The service analyzes the content for emotional and language tones. The method always analyzes the tone of the full document; by default, it also -analyzes the tone of each individual sentence of the content. You can submit no more than 128 KB of total input -content and no more than 1000 individual sentences in JSON, plain text, or HTML format. The service analyzes the -first 1000 sentences for document-level analysis and only the first 100 sentences for sentence-level analysis. +analyzes the tone of each individual sentence of the content. +You can submit no more than 128 KB of total input content and no more than 1000 individual sentences in JSON, plain +text, or HTML format. The service analyzes the first 1000 sentences for document-level analysis and only the first +100 sentences for sentence-level analysis. Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content type of plain text or HTML, include the charset parameter to indicate the @@ -449,7 +447,7 @@

    Parameters

    -

    The content to be analyzed.

    +

    JSON input that contains the content to be analyzed.

    @@ -475,10 +473,10 @@

    Parameters

    2017-09-21: Deprecated. The service continues to accept the parameter for backward-compatibility, but the -parameter no longer affects the response. 2016-05-19: A comma-separated list of tones for which the service -is to return its analysis of the input; the indicated tones apply both to the full document and to individual -sentences of the document. You can specify one or more of the valid values. Omit the parameter to request results -for all three tones.

    +parameter no longer affects the response. +2016-05-19: A comma-separated list of tones for which the service is to return its analysis of the input; +the indicated tones apply both to the full document and to individual sentences of the document. You can specify +one or more of the valid values. Omit the parameter to request results for all three tones.

    @@ -491,9 +489,14 @@

    Parameters

    The language of the input text for the request: English or French. Regional variants are treated as their parent -language; for example, en-US is interpreted as en. The input content must match the specified language. Do not -submit content that contains both languages. You can use different languages for Content-Language and -Accept-Language. * 2017-09-21: Accepts en or fr. * 2016-05-19: Accepts only en.

    +language; for example, en-US is interpreted as en. The input content must match the specified language. Do +not submit content that contains both languages. You can use different languages for Content-Language and +Accept-Language. + +
      +
    • 2017-09-21: Accepts en or fr.
    • +
    • 2016-05-19: Accepts only en.
    • +

    @@ -506,8 +509,8 @@

    Parameters

    The desired language of the response. For two-character arguments, regional variants are treated as their parent -language; for example, en-US is interpreted as en. You can use different languages for Content-Language and -Accept-Language.

    +language; for example, en-US is interpreted as en. You can use different languages for Content-Language +and Accept-Language.

    @@ -570,15 +573,21 @@

    Parameters

    Use the general purpose endpoint to analyze the tone of your input content. The service analyzes the content for emotional and language tones. The method always analyzes the tone of the full document; by default, it also -analyzes the tone of each individual sentence of the content. You can submit no more than 128 KB of total input -content and no more than 1000 individual sentences in JSON, plain text, or HTML format. The service analyzes the -first 1000 sentences for document-level analysis and only the first 100 sentences for sentence-level analysis. +analyzes the tone of each individual sentence of the content. +You can submit no more than 128 KB of total input content and no more than 1000 individual sentences in JSON, plain +text, or HTML format. The service analyzes the first 1000 sentences for document-level analysis and only the first +100 sentences for sentence-level analysis. Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content type of plain text or HTML, include the charset parameter to indicate the character encoding of the input text; for example: Content-Type: text/plain;charset=utf-8. For text/html, the service removes HTML tags and analyzes only the textual content.

    +
      +
    • 2017-09-21: Accepts en or fr.
    • +
    • 2016-05-19: Accepts only en.
    • +
    +

    Declaration

    @@ -608,7 +617,7 @@

    Parameters

    -

    The content to be analyzed.

    +

    plain text input that contains the content to be analyzed.

    @@ -634,10 +643,10 @@

    Parameters

    2017-09-21: Deprecated. The service continues to accept the parameter for backward-compatibility, but the -parameter no longer affects the response. 2016-05-19: A comma-separated list of tones for which the service -is to return its analysis of the input; the indicated tones apply both to the full document and to individual -sentences of the document. You can specify one or more of the valid values. Omit the parameter to request results -for all three tones.

    +parameter no longer affects the response. +2016-05-19: A comma-separated list of tones for which the service is to return its analysis of the input; +the indicated tones apply both to the full document and to individual sentences of the document. You can specify +one or more of the valid values. Omit the parameter to request results for all three tones.

    @@ -650,9 +659,9 @@

    Parameters

    The language of the input text for the request: English or French. Regional variants are treated as their parent -language; for example, en-US is interpreted as en. The input content must match the specified language. Do not -submit content that contains both languages. You can use different languages for Content-Language and -Accept-Language. * 2017-09-21: Accepts en or fr. * 2016-05-19: Accepts only en.

    +language; for example, en-US is interpreted as en. The input content must match the specified language. Do +not submit content that contains both languages. You can use different languages for Content-Language and +Accept-Language.

    @@ -665,8 +674,8 @@

    Parameters

    The desired language of the response. For two-character arguments, regional variants are treated as their parent -language; for example, en-US is interpreted as en. You can use different languages for Content-Language and -Accept-Language.

    +language; for example, en-US is interpreted as en. You can use different languages for Content-Language +and Accept-Language.

    @@ -729,15 +738,21 @@

    Parameters

    Use the general purpose endpoint to analyze the tone of your input content. The service analyzes the content for emotional and language tones. The method always analyzes the tone of the full document; by default, it also -analyzes the tone of each individual sentence of the content. You can submit no more than 128 KB of total input -content and no more than 1000 individual sentences in JSON, plain text, or HTML format. The service analyzes the -first 1000 sentences for document-level analysis and only the first 100 sentences for sentence-level analysis. +analyzes the tone of each individual sentence of the content. +You can submit no more than 128 KB of total input content and no more than 1000 individual sentences in JSON, plain +text, or HTML format. The service analyzes the first 1000 sentences for document-level analysis and only the first +100 sentences for sentence-level analysis. Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content type of plain text or HTML, include the charset parameter to indicate the character encoding of the input text; for example: Content-Type: text/plain;charset=utf-8. For text/html, the service removes HTML tags and analyzes only the textual content.

    +
      +
    • 2017-09-21: Accepts en or fr.
    • +
    • 2016-05-19: Accepts only en.
    • +
    +

    Declaration

    @@ -767,7 +782,7 @@

    Parameters

    -

    The content to be analyzed.

    +

    HTML input that contains the content to be analyzed.

    @@ -793,10 +808,10 @@

    Parameters

    2017-09-21: Deprecated. The service continues to accept the parameter for backward-compatibility, but the -parameter no longer affects the response. 2016-05-19: A comma-separated list of tones for which the service -is to return its analysis of the input; the indicated tones apply both to the full document and to individual -sentences of the document. You can specify one or more of the valid values. Omit the parameter to request results -for all three tones.

    +parameter no longer affects the response. +2016-05-19: A comma-separated list of tones for which the service is to return its analysis of the input; +the indicated tones apply both to the full document and to individual sentences of the document. You can specify +one or more of the valid values. Omit the parameter to request results for all three tones.

    @@ -809,9 +824,9 @@

    Parameters

    The language of the input text for the request: English or French. Regional variants are treated as their parent -language; for example, en-US is interpreted as en. The input content must match the specified language. Do not -submit content that contains both languages. You can use different languages for Content-Language and -Accept-Language. * 2017-09-21: Accepts en or fr. * 2016-05-19: Accepts only en.

    +language; for example, en-US is interpreted as en. The input content must match the specified language. Do +not submit content that contains both languages. You can use different languages for Content-Language and +Accept-Language.

    @@ -824,8 +839,8 @@

    Parameters

    The desired language of the response. For two-character arguments, regional variants are treated as their parent -language; for example, en-US is interpreted as en. You can use different languages for Content-Language and -Accept-Language.

    +language; for example, en-US is interpreted as en. You can use different languages for Content-Language +and Accept-Language.

    @@ -888,11 +903,12 @@

    Parameters

    Use the customer engagement endpoint to analyze the tone of customer service and customer support conversations. For each utterance of a conversation, the method reports the most prevalent subset of the following seven tones: -sad, frustrated, satisfied, excited, polite, impolite, and sympathetic. If you submit more than 50 utterances, -the service returns a warning for the overall content and analyzes only the first 50 utterances. If you submit a -single utterance that contains more than 500 characters, the service returns an error for that utterance and does -not analyze the utterance. The request fails if all utterances have more than 500 characters. Per the JSON -specification, the default character encoding for JSON content is effectively always UTF-8.

    +sad, frustrated, satisfied, excited, polite, impolite, and sympathetic. +If you submit more than 50 utterances, the service returns a warning for the overall content and analyzes only the +first 50 utterances. If you submit a single utterance that contains more than 500 characters, the service returns +an error for that utterance and does not analyze the utterance. The request fails if all utterances have more than +500 characters. +Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8.

    @@ -934,9 +950,14 @@

    Parameters

    The language of the input text for the request: English or French. Regional variants are treated as their parent -language; for example, en-US is interpreted as en. The input content must match the specified language. Do not -submit content that contains both languages. You can use different languages for Content-Language and -Accept-Language. * 2017-09-21: Accepts en or fr. * 2016-05-19: Accepts only en.

    +language; for example, en-US is interpreted as en. The input content must match the specified language. Do +not submit content that contains both languages. You can use different languages for Content-Language and +Accept-Language. + +
      +
    • 2017-09-21: Accepts en or fr.
    • +
    • 2016-05-19: Accepts only en.
    • +

    @@ -949,8 +970,8 @@

    Parameters

    The desired language of the response. For two-character arguments, regional variants are treated as their parent -language; for example, en-US is interpreted as en. You can use different languages for Content-Language and -Accept-Language.

    +language; for example, en-US is interpreted as en. You can use different languages for Content-Language +and Accept-Language.

    @@ -1001,7 +1022,7 @@

    Parameters

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/Enums.html b/docs/swift-api/services/ToneAnalyzerV3/Enums.html index 1619a7a88..8e6ae5cf9 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/Enums.html +++ b/docs/swift-api/services/ToneAnalyzerV3/Enums.html @@ -53,9 +53,6 @@ - @@ -165,7 +162,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/Enums/JSON.html b/docs/swift-api/services/ToneAnalyzerV3/Enums/JSON.html index b3fefba29..96c88f7ec 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/Enums/JSON.html +++ b/docs/swift-api/services/ToneAnalyzerV3/Enums/JSON.html @@ -53,9 +53,6 @@ - @@ -435,7 +432,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/Enums/RestError.html b/docs/swift-api/services/ToneAnalyzerV3/Enums/RestError.html index 2875eabda..59f33fd09 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/Enums/RestError.html +++ b/docs/swift-api/services/ToneAnalyzerV3/Enums/RestError.html @@ -53,9 +53,6 @@ - @@ -302,7 +299,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/Structs.html b/docs/swift-api/services/ToneAnalyzerV3/Structs.html index 1fceb3491..bbc7ba847 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/Structs.html +++ b/docs/swift-api/services/ToneAnalyzerV3/Structs.html @@ -53,9 +53,6 @@ - @@ -98,45 +95,6 @@

    Structures

    -
    -
    - - - -

    JSON

    -
    -
    -
      -
    • -
      - - - - JSONWrapper - -
      -
      -
      -
      -
      -
      -

      Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public struct JSONWrapper
      - -
      -
      -
      -
      -
    • -
    -
    • @@ -492,7 +450,7 @@

      Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/Structs/DocumentAnalysis.html b/docs/swift-api/services/ToneAnalyzerV3/Structs/DocumentAnalysis.html index 186fcb089..50cb0d5c9 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/Structs/DocumentAnalysis.html +++ b/docs/swift-api/services/ToneAnalyzerV3/Structs/DocumentAnalysis.html @@ -53,9 +53,6 @@ - @@ -119,7 +116,9 @@

    DocumentAnalysis

    -

    2017-09-21:** An array of ToneScore objects that provides the results of the analysis for each qualifying tone of the document. The array includes results for any tone whose score is at least 0.5. The array is empty if no tone has a score that meets this threshold. 2016-05-19: Not returned.

    +

    2017-09-21: An array of ToneScore objects that provides the results of the analysis for each qualifying +tone of the document. The array includes results for any tone whose score is at least 0.5. The array is empty if no +tone has a score that meets this threshold. 2016-05-19: Not returned.

    @@ -146,7 +145,9 @@

    Declaration

    -

    2017-09-21:** Not returned. 2016-05-19: An array of ToneCategory objects that provides the results of the tone analysis for the full document of the input content. The service returns results only for the tones specified with the tones parameter of the request.

    +

    2017-09-21: Not returned. 2016-05-19: An array of ToneCategory objects that provides the results of +the tone analysis for the full document of the input content. The service returns results only for the tones +specified with the tones parameter of the request.

    @@ -173,7 +174,9 @@

    Declaration

    -

    2017-09-21:** A warning message if the overall content exceeds 128 KB or contains more than 1000 sentences. The service analyzes only the first 1000 sentences for document-level analysis and the first 100 sentences for sentence-level analysis. 2016-05-19: Not returned.

    +

    2017-09-21: A warning message if the overall content exceeds 128 KB or contains more than 1000 sentences. The +service analyzes only the first 1000 sentences for document-level analysis and the first 100 sentences for +sentence-level analysis. 2016-05-19: Not returned.

    @@ -192,7 +195,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/Structs/SentenceAnalysis.html b/docs/swift-api/services/ToneAnalyzerV3/Structs/SentenceAnalysis.html index bde4225a4..a8f4f32ce 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/Structs/SentenceAnalysis.html +++ b/docs/swift-api/services/ToneAnalyzerV3/Structs/SentenceAnalysis.html @@ -53,9 +53,6 @@ - @@ -119,7 +116,8 @@

    SentenceAnalysis

    -

    The unique identifier of a sentence of the input content. The first sentence has ID 0, and the ID of each subsequent sentence is incremented by one.

    +

    The unique identifier of a sentence of the input content. The first sentence has ID 0, and the ID of each +subsequent sentence is incremented by one.

    @@ -173,7 +171,9 @@

    Declaration

    -

    2017-09-21:** An array of ToneScore objects that provides the results of the analysis for each qualifying tone of the sentence. The array includes results for any tone whose score is at least 0.5. The array is empty if no tone has a score that meets this threshold. 2016-05-19: Not returned.

    +

    2017-09-21: An array of ToneScore objects that provides the results of the analysis for each qualifying +tone of the sentence. The array includes results for any tone whose score is at least 0.5. The array is empty if no +tone has a score that meets this threshold. 2016-05-19: Not returned.

    @@ -200,7 +200,9 @@

    Declaration

    -

    2017-09-21:** Not returned. 2016-05-19: An array of ToneCategory objects that provides the results of the tone analysis for the sentence. The service returns results only for the tones specified with the tones parameter of the request.

    +

    2017-09-21: Not returned. 2016-05-19: An array of ToneCategory objects that provides the results of +the tone analysis for the sentence. The service returns results only for the tones specified with the tones +parameter of the request.

    @@ -227,7 +229,8 @@

    Declaration

    -

    2017-09-21:** Not returned. 2016-05-19: The offset of the first character of the sentence in the overall input content.

    +

    2017-09-21: Not returned. 2016-05-19: The offset of the first character of the sentence in the overall +input content.

    @@ -254,7 +257,8 @@

    Declaration

    -

    2017-09-21:** Not returned. 2016-05-19: The offset of the last character of the sentence in the overall input content.

    +

    2017-09-21: Not returned. 2016-05-19: The offset of the last character of the sentence in the overall +input content.

    @@ -273,7 +277,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneAnalysis.html b/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneAnalysis.html index 79775988a..7e03e29ea 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneAnalysis.html +++ b/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneAnalysis.html @@ -53,9 +53,6 @@ - @@ -146,7 +143,9 @@

    Declaration

    -

    An array of SentenceAnalysis objects that provides the results of the analysis for the individual sentences of the input content. The service returns results only for the first 100 sentences of the input. The field is omitted if the sentences parameter of the request is set to false.

    +

    An array of SentenceAnalysis objects that provides the results of the analysis for the individual sentences of +the input content. The service returns results only for the first 100 sentences of the input. The field is omitted +if the sentences parameter of the request is set to false.

    @@ -165,7 +164,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneCategory.html b/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneCategory.html index ea03fec1e..e37568d7c 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneCategory.html +++ b/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneCategory.html @@ -53,9 +53,6 @@ - @@ -146,7 +143,8 @@

    Declaration

    -

    The unique, non-localized identifier of the category for the results. The service can return results for the following category IDs: emotion_tone, language_tone, and social_tone.

    +

    The unique, non-localized identifier of the category for the results. The service can return results for the +following category IDs: emotion_tone, language_tone, and social_tone.

    @@ -192,7 +190,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneChatInput.html b/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneChatInput.html index 6eaf8ea4b..4413a3437 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneChatInput.html +++ b/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneChatInput.html @@ -53,9 +53,6 @@ - @@ -153,7 +150,9 @@

    Declaration

    Declaration

    Swift

    -
    public init(utterances: [Utterance])
    +
    public init(
    +    utterances: [Utterance]
    +)
    @@ -188,7 +187,7 @@

    Return Value

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneChatScore.html b/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneChatScore.html index e0b24b46b..471385257 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneChatScore.html +++ b/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneChatScore.html @@ -53,9 +53,6 @@ - @@ -119,7 +116,8 @@

    ToneChatScore

    -

    The score for the tone in the range of 0.5 to 1. A score greater than 0.75 indicates a high likelihood that the tone is perceived in the utterance.

    +

    The score for the tone in the range of 0.5 to 1. A score greater than 0.75 indicates a high likelihood that the +tone is perceived in the utterance.

    @@ -146,7 +144,9 @@

    Declaration

    -

    The unique, non-localized identifier of the tone for the results. The service can return results for the following tone IDs: sad, frustrated, satisfied, excited, polite, impolite, and sympathetic. The service returns results only for tones whose scores meet a minimum threshold of 0.5.

    +

    The unique, non-localized identifier of the tone for the results. The service can return results for the following +tone IDs: sad, frustrated, satisfied, excited, polite, impolite, and sympathetic. The service returns +results only for tones whose scores meet a minimum threshold of 0.5.

    @@ -192,7 +192,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneInput.html b/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneInput.html index 5ce3632d3..471449857 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneInput.html +++ b/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneInput.html @@ -53,9 +53,6 @@ - @@ -153,7 +150,9 @@

    Declaration

    Declaration

    Swift

    -
    public init(text: String)
    +
    public init(
    +    text: String
    +)
    @@ -188,7 +187,7 @@

    Return Value

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneScore.html b/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneScore.html index f257b190a..d1f6e95c8 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneScore.html +++ b/docs/swift-api/services/ToneAnalyzerV3/Structs/ToneScore.html @@ -53,9 +53,6 @@ - @@ -119,7 +116,15 @@

    ToneScore

    -

    The score for the tone. * 2017-09-21: The score that is returned lies in the range of 0.5 to 1. A score greater than 0.75 indicates a high likelihood that the tone is perceived in the content. * 2016-05-19: The score that is returned lies in the range of 0 to 1. A score less than 0.5 indicates that the tone is unlikely to be perceived in the content; a score greater than 0.75 indicates a high likelihood that the tone is perceived.

    +

    The score for the tone.

    + +
      +
    • 2017-09-21: The score that is returned lies in the range of 0.5 to 1. A score greater than 0.75 indicates a +high likelihood that the tone is perceived in the content.
    • +
    • 2016-05-19: The score that is returned lies in the range of 0 to 1. A score less than 0.5 indicates that +the tone is unlikely to be perceived in the content; a score greater than 0.75 indicates a high likelihood that the +tone is perceived.
    • +
    @@ -146,7 +151,18 @@

    Declaration

    -

    The unique, non-localized identifier of the tone. * 2017-09-21: The service can return results for the following tone IDs: anger, fear, joy, and sadness (emotional tones); analytical, confident, and tentative (language tones). The service returns results only for tones whose scores meet a minimum threshold of 0.5. * 2016-05-19: The service can return results for the following tone IDs of the different categories: for the emotion category: anger, disgust, fear, joy, and sadness; for the language category: analytical, confident, and tentative; for the social category: openness_big5, conscientiousness_big5, extraversion_big5, agreeableness_big5, and emotional_range_big5. The service returns scores for all tones of a category, regardless of their values.

    +

    The unique, non-localized identifier of the tone.

    + +
      +
    • 2017-09-21: The service can return results for the following tone IDs: anger, fear, joy, and +sadness (emotional tones); analytical, confident, and tentative (language tones). The service returns +results only for tones whose scores meet a minimum threshold of 0.5.
    • +
    • 2016-05-19: The service can return results for the following tone IDs of the different categories: for the +emotion category: anger, disgust, fear, joy, and sadness; for the language category: analytical, +confident, and tentative; for the social category: openness_big5, conscientiousness_big5, +extraversion_big5, agreeableness_big5, and emotional_range_big5. The service returns scores for all tones of +a category, regardless of their values.
    • +
    @@ -192,7 +208,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/Structs/Utterance.html b/docs/swift-api/services/ToneAnalyzerV3/Structs/Utterance.html index b749ffa48..05bc27b4f 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/Structs/Utterance.html +++ b/docs/swift-api/services/ToneAnalyzerV3/Structs/Utterance.html @@ -53,9 +53,6 @@ - @@ -119,7 +116,8 @@

    Utterance

    -

    An utterance contributed by a user in the conversation that is to be analyzed. The utterance can contain multiple sentences.

    +

    An utterance contributed by a user in the conversation that is to be analyzed. The utterance can contain multiple +sentences.

    @@ -180,7 +178,10 @@

    Declaration

    Declaration

    Swift

    -
    public init(text: String, user: String? = nil)
    +
    public init(
    +    text: String,
    +    user: String? = nil
    +)
    @@ -196,7 +197,8 @@

    Parameters

    -

    An utterance contributed by a user in the conversation that is to be analyzed. The utterance can contain multiple sentences.

    +

    An utterance contributed by a user in the conversation that is to be analyzed. The utterance can contain multiple +sentences.

    @@ -227,7 +229,7 @@

    Return Value

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/Structs/UtteranceAnalyses.html b/docs/swift-api/services/ToneAnalyzerV3/Structs/UtteranceAnalyses.html index 0804fa36f..02f9cbea1 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/Structs/UtteranceAnalyses.html +++ b/docs/swift-api/services/ToneAnalyzerV3/Structs/UtteranceAnalyses.html @@ -53,9 +53,6 @@ - @@ -146,7 +143,8 @@

    Declaration

    -

    2017-09-21:** A warning message if the content contains more than 50 utterances. The service analyzes only the first 50 utterances. 2016-05-19: Not returned.

    +

    2017-09-21: A warning message if the content contains more than 50 utterances. The service analyzes only the +first 50 utterances. 2016-05-19: Not returned.

    @@ -165,7 +163,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/Structs/UtteranceAnalysis.html b/docs/swift-api/services/ToneAnalyzerV3/Structs/UtteranceAnalysis.html index aa3e6c399..17603e16a 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/Structs/UtteranceAnalysis.html +++ b/docs/swift-api/services/ToneAnalyzerV3/Structs/UtteranceAnalysis.html @@ -53,9 +53,6 @@ - @@ -119,7 +116,8 @@

    UtteranceAnalysis

    -

    The unique identifier of the utterance. The first utterance has ID 0, and the ID of each subsequent utterance is incremented by one.

    +

    The unique identifier of the utterance. The first utterance has ID 0, and the ID of each subsequent utterance is +incremented by one.

    @@ -173,7 +171,9 @@

    Declaration

    -

    An array of ToneChatScore objects that provides results for the most prevalent tones of the utterance. The array includes results for any tone whose score is at least 0.5. The array is empty if no tone has a score that meets this threshold.

    +

    An array of ToneChatScore objects that provides results for the most prevalent tones of the utterance. The array +includes results for any tone whose score is at least 0.5. The array is empty if no tone has a score that meets +this threshold.

    @@ -200,7 +200,8 @@

    Declaration

    -

    2017-09-21:** An error message if the utterance contains more than 500 characters. The service does not analyze the utterance. 2016-05-19: Not returned.

    +

    2017-09-21: An error message if the utterance contains more than 500 characters. The service does not analyze +the utterance. 2016-05-19: Not returned.

    @@ -219,7 +220,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Classes.html b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Classes.html index 4342dbaf5..1eb2580f7 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Classes.html +++ b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Classes.html @@ -53,9 +53,6 @@ - @@ -113,9 +110,9 @@

    Classes

    -

    The IBM Watson Tone Analyzer service uses linguistic analysis to detect emotional and language tones in written text. -The service can analyze tone at both the document and sentence levels. You can use the service to understand how your -written communications are perceived and then to improve the tone of your communications. Businesses can use the +

    The IBM Watson™ Tone Analyzer service uses linguistic analysis to detect emotional and language tones in written +text. The service can analyze tone at both the document and sentence levels. You can use the service to understand how +your written communications are perceived and then to improve the tone of your communications. Businesses can use the service to learn the tone of their customers’ communications and to respond to each customer appropriately, or to understand and improve their customer conversations. Note: Request logging is disabled for the Tone Analyzer service. The service neither logs nor retains data from @@ -139,7 +136,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Classes/ToneAnalyzer.html b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Classes/ToneAnalyzer.html index 4c094c485..d5f9f3973 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Classes/ToneAnalyzer.html +++ b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Classes/ToneAnalyzer.html @@ -53,9 +53,6 @@ - @@ -100,9 +97,9 @@

    ToneAnalyzer

    -

    The IBM Watson Tone Analyzer service uses linguistic analysis to detect emotional and language tones in written text. -The service can analyze tone at both the document and sentence levels. You can use the service to understand how your -written communications are perceived and then to improve the tone of your communications. Businesses can use the +

    The IBM Watson™ Tone Analyzer service uses linguistic analysis to detect emotional and language tones in written +text. The service can analyze tone at both the document and sentence levels. You can use the service to understand how +your written communications are perceived and then to improve the tone of your communications. Businesses can use the service to learn the tone of their customers’ communications and to respond to each customer appropriately, or to understand and improve their customer conversations. Note: Request logging is disabled for the Tone Analyzer service. The service neither logs nor retains data from @@ -411,9 +408,10 @@

    Declaration

    Use the general purpose endpoint to analyze the tone of your input content. The service analyzes the content for emotional and language tones. The method always analyzes the tone of the full document; by default, it also -analyzes the tone of each individual sentence of the content. You can submit no more than 128 KB of total input -content and no more than 1000 individual sentences in JSON, plain text, or HTML format. The service analyzes the -first 1000 sentences for document-level analysis and only the first 100 sentences for sentence-level analysis. +analyzes the tone of each individual sentence of the content. +You can submit no more than 128 KB of total input content and no more than 1000 individual sentences in JSON, plain +text, or HTML format. The service analyzes the first 1000 sentences for document-level analysis and only the first +100 sentences for sentence-level analysis. Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content type of plain text or HTML, include the charset parameter to indicate the @@ -449,7 +447,7 @@

    Parameters

    -

    The content to be analyzed.

    +

    JSON input that contains the content to be analyzed.

    @@ -475,10 +473,10 @@

    Parameters

    2017-09-21: Deprecated. The service continues to accept the parameter for backward-compatibility, but the -parameter no longer affects the response. 2016-05-19: A comma-separated list of tones for which the service -is to return its analysis of the input; the indicated tones apply both to the full document and to individual -sentences of the document. You can specify one or more of the valid values. Omit the parameter to request results -for all three tones.

    +parameter no longer affects the response. +2016-05-19: A comma-separated list of tones for which the service is to return its analysis of the input; +the indicated tones apply both to the full document and to individual sentences of the document. You can specify +one or more of the valid values. Omit the parameter to request results for all three tones.

    @@ -491,9 +489,14 @@

    Parameters

    The language of the input text for the request: English or French. Regional variants are treated as their parent -language; for example, en-US is interpreted as en. The input content must match the specified language. Do not -submit content that contains both languages. You can use different languages for Content-Language and -Accept-Language. * 2017-09-21: Accepts en or fr. * 2016-05-19: Accepts only en.

    +language; for example, en-US is interpreted as en. The input content must match the specified language. Do +not submit content that contains both languages. You can use different languages for Content-Language and +Accept-Language. + +
      +
    • 2017-09-21: Accepts en or fr.
    • +
    • 2016-05-19: Accepts only en.
    • +

    @@ -506,8 +509,8 @@

    Parameters

    The desired language of the response. For two-character arguments, regional variants are treated as their parent -language; for example, en-US is interpreted as en. You can use different languages for Content-Language and -Accept-Language.

    +language; for example, en-US is interpreted as en. You can use different languages for Content-Language +and Accept-Language.

    @@ -570,15 +573,21 @@

    Parameters

    Use the general purpose endpoint to analyze the tone of your input content. The service analyzes the content for emotional and language tones. The method always analyzes the tone of the full document; by default, it also -analyzes the tone of each individual sentence of the content. You can submit no more than 128 KB of total input -content and no more than 1000 individual sentences in JSON, plain text, or HTML format. The service analyzes the -first 1000 sentences for document-level analysis and only the first 100 sentences for sentence-level analysis. +analyzes the tone of each individual sentence of the content. +You can submit no more than 128 KB of total input content and no more than 1000 individual sentences in JSON, plain +text, or HTML format. The service analyzes the first 1000 sentences for document-level analysis and only the first +100 sentences for sentence-level analysis. Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content type of plain text or HTML, include the charset parameter to indicate the character encoding of the input text; for example: Content-Type: text/plain;charset=utf-8. For text/html, the service removes HTML tags and analyzes only the textual content.

    +
      +
    • 2017-09-21: Accepts en or fr.
    • +
    • 2016-05-19: Accepts only en.
    • +
    +

    Declaration

    @@ -608,7 +617,7 @@

    Parameters

    -

    The content to be analyzed.

    +

    plain text input that contains the content to be analyzed.

    @@ -634,10 +643,10 @@

    Parameters

    2017-09-21: Deprecated. The service continues to accept the parameter for backward-compatibility, but the -parameter no longer affects the response. 2016-05-19: A comma-separated list of tones for which the service -is to return its analysis of the input; the indicated tones apply both to the full document and to individual -sentences of the document. You can specify one or more of the valid values. Omit the parameter to request results -for all three tones.

    +parameter no longer affects the response. +2016-05-19: A comma-separated list of tones for which the service is to return its analysis of the input; +the indicated tones apply both to the full document and to individual sentences of the document. You can specify +one or more of the valid values. Omit the parameter to request results for all three tones.

    @@ -650,9 +659,9 @@

    Parameters

    The language of the input text for the request: English or French. Regional variants are treated as their parent -language; for example, en-US is interpreted as en. The input content must match the specified language. Do not -submit content that contains both languages. You can use different languages for Content-Language and -Accept-Language. * 2017-09-21: Accepts en or fr. * 2016-05-19: Accepts only en.

    +language; for example, en-US is interpreted as en. The input content must match the specified language. Do +not submit content that contains both languages. You can use different languages for Content-Language and +Accept-Language.

    @@ -665,8 +674,8 @@

    Parameters

    The desired language of the response. For two-character arguments, regional variants are treated as their parent -language; for example, en-US is interpreted as en. You can use different languages for Content-Language and -Accept-Language.

    +language; for example, en-US is interpreted as en. You can use different languages for Content-Language +and Accept-Language.

    @@ -729,15 +738,21 @@

    Parameters

    Use the general purpose endpoint to analyze the tone of your input content. The service analyzes the content for emotional and language tones. The method always analyzes the tone of the full document; by default, it also -analyzes the tone of each individual sentence of the content. You can submit no more than 128 KB of total input -content and no more than 1000 individual sentences in JSON, plain text, or HTML format. The service analyzes the -first 1000 sentences for document-level analysis and only the first 100 sentences for sentence-level analysis. +analyzes the tone of each individual sentence of the content. +You can submit no more than 128 KB of total input content and no more than 1000 individual sentences in JSON, plain +text, or HTML format. The service analyzes the first 1000 sentences for document-level analysis and only the first +100 sentences for sentence-level analysis. Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content type of plain text or HTML, include the charset parameter to indicate the character encoding of the input text; for example: Content-Type: text/plain;charset=utf-8. For text/html, the service removes HTML tags and analyzes only the textual content.

    +
      +
    • 2017-09-21: Accepts en or fr.
    • +
    • 2016-05-19: Accepts only en.
    • +
    +

    Declaration

    @@ -767,7 +782,7 @@

    Parameters

    -

    The content to be analyzed.

    +

    HTML input that contains the content to be analyzed.

    @@ -793,10 +808,10 @@

    Parameters

    2017-09-21: Deprecated. The service continues to accept the parameter for backward-compatibility, but the -parameter no longer affects the response. 2016-05-19: A comma-separated list of tones for which the service -is to return its analysis of the input; the indicated tones apply both to the full document and to individual -sentences of the document. You can specify one or more of the valid values. Omit the parameter to request results -for all three tones.

    +parameter no longer affects the response. +2016-05-19: A comma-separated list of tones for which the service is to return its analysis of the input; +the indicated tones apply both to the full document and to individual sentences of the document. You can specify +one or more of the valid values. Omit the parameter to request results for all three tones.

    @@ -809,9 +824,9 @@

    Parameters

    The language of the input text for the request: English or French. Regional variants are treated as their parent -language; for example, en-US is interpreted as en. The input content must match the specified language. Do not -submit content that contains both languages. You can use different languages for Content-Language and -Accept-Language. * 2017-09-21: Accepts en or fr. * 2016-05-19: Accepts only en.

    +language; for example, en-US is interpreted as en. The input content must match the specified language. Do +not submit content that contains both languages. You can use different languages for Content-Language and +Accept-Language.

    @@ -824,8 +839,8 @@

    Parameters

    The desired language of the response. For two-character arguments, regional variants are treated as their parent -language; for example, en-US is interpreted as en. You can use different languages for Content-Language and -Accept-Language.

    +language; for example, en-US is interpreted as en. You can use different languages for Content-Language +and Accept-Language.

    @@ -888,11 +903,12 @@

    Parameters

    Use the customer engagement endpoint to analyze the tone of customer service and customer support conversations. For each utterance of a conversation, the method reports the most prevalent subset of the following seven tones: -sad, frustrated, satisfied, excited, polite, impolite, and sympathetic. If you submit more than 50 utterances, -the service returns a warning for the overall content and analyzes only the first 50 utterances. If you submit a -single utterance that contains more than 500 characters, the service returns an error for that utterance and does -not analyze the utterance. The request fails if all utterances have more than 500 characters. Per the JSON -specification, the default character encoding for JSON content is effectively always UTF-8.

    +sad, frustrated, satisfied, excited, polite, impolite, and sympathetic. +If you submit more than 50 utterances, the service returns a warning for the overall content and analyzes only the +first 50 utterances. If you submit a single utterance that contains more than 500 characters, the service returns +an error for that utterance and does not analyze the utterance. The request fails if all utterances have more than +500 characters. +Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8.

    @@ -934,9 +950,14 @@

    Parameters

    The language of the input text for the request: English or French. Regional variants are treated as their parent -language; for example, en-US is interpreted as en. The input content must match the specified language. Do not -submit content that contains both languages. You can use different languages for Content-Language and -Accept-Language. * 2017-09-21: Accepts en or fr. * 2016-05-19: Accepts only en.

    +language; for example, en-US is interpreted as en. The input content must match the specified language. Do +not submit content that contains both languages. You can use different languages for Content-Language and +Accept-Language. + +
      +
    • 2017-09-21: Accepts en or fr.
    • +
    • 2016-05-19: Accepts only en.
    • +

    @@ -949,8 +970,8 @@

    Parameters

    The desired language of the response. For two-character arguments, regional variants are treated as their parent -language; for example, en-US is interpreted as en. You can use different languages for Content-Language and -Accept-Language.

    +language; for example, en-US is interpreted as en. You can use different languages for Content-Language +and Accept-Language.

    @@ -1001,7 +1022,7 @@

    Parameters

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Enums.html b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Enums.html index 1619a7a88..8e6ae5cf9 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Enums.html +++ b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Enums.html @@ -53,9 +53,6 @@ - @@ -165,7 +162,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html index b3fefba29..96c88f7ec 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html +++ b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html @@ -53,9 +53,6 @@ - @@ -435,7 +432,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html index 2875eabda..59f33fd09 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html +++ b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html @@ -53,9 +53,6 @@ - @@ -302,7 +299,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs.html b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs.html index 1fceb3491..bbc7ba847 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs.html +++ b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs.html @@ -53,9 +53,6 @@ - @@ -98,45 +95,6 @@

    Structures

    -
    -
    - - - -

    JSON

    -
    -
    -
      -
    • -
      - - - - JSONWrapper - -
      -
      -
      -
      -
      -
      -

      Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public struct JSONWrapper
      - -
      -
      -
      -
      -
    • -
    -
    • @@ -492,7 +450,7 @@

      Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/DocumentAnalysis.html b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/DocumentAnalysis.html index 186fcb089..50cb0d5c9 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/DocumentAnalysis.html +++ b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/DocumentAnalysis.html @@ -53,9 +53,6 @@ - @@ -119,7 +116,9 @@

    DocumentAnalysis

    -

    2017-09-21:** An array of ToneScore objects that provides the results of the analysis for each qualifying tone of the document. The array includes results for any tone whose score is at least 0.5. The array is empty if no tone has a score that meets this threshold. 2016-05-19: Not returned.

    +

    2017-09-21: An array of ToneScore objects that provides the results of the analysis for each qualifying +tone of the document. The array includes results for any tone whose score is at least 0.5. The array is empty if no +tone has a score that meets this threshold. 2016-05-19: Not returned.

    @@ -146,7 +145,9 @@

    Declaration

    -

    2017-09-21:** Not returned. 2016-05-19: An array of ToneCategory objects that provides the results of the tone analysis for the full document of the input content. The service returns results only for the tones specified with the tones parameter of the request.

    +

    2017-09-21: Not returned. 2016-05-19: An array of ToneCategory objects that provides the results of +the tone analysis for the full document of the input content. The service returns results only for the tones +specified with the tones parameter of the request.

    @@ -173,7 +174,9 @@

    Declaration

    -

    2017-09-21:** A warning message if the overall content exceeds 128 KB or contains more than 1000 sentences. The service analyzes only the first 1000 sentences for document-level analysis and the first 100 sentences for sentence-level analysis. 2016-05-19: Not returned.

    +

    2017-09-21: A warning message if the overall content exceeds 128 KB or contains more than 1000 sentences. The +service analyzes only the first 1000 sentences for document-level analysis and the first 100 sentences for +sentence-level analysis. 2016-05-19: Not returned.

    @@ -192,7 +195,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/SentenceAnalysis.html b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/SentenceAnalysis.html index bde4225a4..a8f4f32ce 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/SentenceAnalysis.html +++ b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/SentenceAnalysis.html @@ -53,9 +53,6 @@ - @@ -119,7 +116,8 @@

    SentenceAnalysis

    -

    The unique identifier of a sentence of the input content. The first sentence has ID 0, and the ID of each subsequent sentence is incremented by one.

    +

    The unique identifier of a sentence of the input content. The first sentence has ID 0, and the ID of each +subsequent sentence is incremented by one.

    @@ -173,7 +171,9 @@

    Declaration

    -

    2017-09-21:** An array of ToneScore objects that provides the results of the analysis for each qualifying tone of the sentence. The array includes results for any tone whose score is at least 0.5. The array is empty if no tone has a score that meets this threshold. 2016-05-19: Not returned.

    +

    2017-09-21: An array of ToneScore objects that provides the results of the analysis for each qualifying +tone of the sentence. The array includes results for any tone whose score is at least 0.5. The array is empty if no +tone has a score that meets this threshold. 2016-05-19: Not returned.

    @@ -200,7 +200,9 @@

    Declaration

    -

    2017-09-21:** Not returned. 2016-05-19: An array of ToneCategory objects that provides the results of the tone analysis for the sentence. The service returns results only for the tones specified with the tones parameter of the request.

    +

    2017-09-21: Not returned. 2016-05-19: An array of ToneCategory objects that provides the results of +the tone analysis for the sentence. The service returns results only for the tones specified with the tones +parameter of the request.

    @@ -227,7 +229,8 @@

    Declaration

    -

    2017-09-21:** Not returned. 2016-05-19: The offset of the first character of the sentence in the overall input content.

    +

    2017-09-21: Not returned. 2016-05-19: The offset of the first character of the sentence in the overall +input content.

    @@ -254,7 +257,8 @@

    Declaration

    -

    2017-09-21:** Not returned. 2016-05-19: The offset of the last character of the sentence in the overall input content.

    +

    2017-09-21: Not returned. 2016-05-19: The offset of the last character of the sentence in the overall +input content.

    @@ -273,7 +277,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneAnalysis.html b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneAnalysis.html index 79775988a..7e03e29ea 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneAnalysis.html +++ b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneAnalysis.html @@ -53,9 +53,6 @@ - @@ -146,7 +143,9 @@

    Declaration

    -

    An array of SentenceAnalysis objects that provides the results of the analysis for the individual sentences of the input content. The service returns results only for the first 100 sentences of the input. The field is omitted if the sentences parameter of the request is set to false.

    +

    An array of SentenceAnalysis objects that provides the results of the analysis for the individual sentences of +the input content. The service returns results only for the first 100 sentences of the input. The field is omitted +if the sentences parameter of the request is set to false.

    @@ -165,7 +164,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneCategory.html b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneCategory.html index ea03fec1e..e37568d7c 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneCategory.html +++ b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneCategory.html @@ -53,9 +53,6 @@ - @@ -146,7 +143,8 @@

    Declaration

    -

    The unique, non-localized identifier of the category for the results. The service can return results for the following category IDs: emotion_tone, language_tone, and social_tone.

    +

    The unique, non-localized identifier of the category for the results. The service can return results for the +following category IDs: emotion_tone, language_tone, and social_tone.

    @@ -192,7 +190,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneChatInput.html b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneChatInput.html index 6eaf8ea4b..4413a3437 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneChatInput.html +++ b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneChatInput.html @@ -53,9 +53,6 @@ - @@ -153,7 +150,9 @@

    Declaration

    Declaration

    Swift

    -
    public init(utterances: [Utterance])
    +
    public init(
    +    utterances: [Utterance]
    +)
    @@ -188,7 +187,7 @@

    Return Value

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneChatScore.html b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneChatScore.html index e0b24b46b..471385257 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneChatScore.html +++ b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneChatScore.html @@ -53,9 +53,6 @@ - @@ -119,7 +116,8 @@

    ToneChatScore

    -

    The score for the tone in the range of 0.5 to 1. A score greater than 0.75 indicates a high likelihood that the tone is perceived in the utterance.

    +

    The score for the tone in the range of 0.5 to 1. A score greater than 0.75 indicates a high likelihood that the +tone is perceived in the utterance.

    @@ -146,7 +144,9 @@

    Declaration

    -

    The unique, non-localized identifier of the tone for the results. The service can return results for the following tone IDs: sad, frustrated, satisfied, excited, polite, impolite, and sympathetic. The service returns results only for tones whose scores meet a minimum threshold of 0.5.

    +

    The unique, non-localized identifier of the tone for the results. The service can return results for the following +tone IDs: sad, frustrated, satisfied, excited, polite, impolite, and sympathetic. The service returns +results only for tones whose scores meet a minimum threshold of 0.5.

    @@ -192,7 +192,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneInput.html b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneInput.html index 5ce3632d3..471449857 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneInput.html +++ b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneInput.html @@ -53,9 +53,6 @@ - @@ -153,7 +150,9 @@

    Declaration

    Declaration

    Swift

    -
    public init(text: String)
    +
    public init(
    +    text: String
    +)
    @@ -188,7 +187,7 @@

    Return Value

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneScore.html b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneScore.html index f257b190a..d1f6e95c8 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneScore.html +++ b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/ToneScore.html @@ -53,9 +53,6 @@ - @@ -119,7 +116,15 @@

    ToneScore

    -

    The score for the tone. * 2017-09-21: The score that is returned lies in the range of 0.5 to 1. A score greater than 0.75 indicates a high likelihood that the tone is perceived in the content. * 2016-05-19: The score that is returned lies in the range of 0 to 1. A score less than 0.5 indicates that the tone is unlikely to be perceived in the content; a score greater than 0.75 indicates a high likelihood that the tone is perceived.

    +

    The score for the tone.

    + +
      +
    • 2017-09-21: The score that is returned lies in the range of 0.5 to 1. A score greater than 0.75 indicates a +high likelihood that the tone is perceived in the content.
    • +
    • 2016-05-19: The score that is returned lies in the range of 0 to 1. A score less than 0.5 indicates that +the tone is unlikely to be perceived in the content; a score greater than 0.75 indicates a high likelihood that the +tone is perceived.
    • +
    @@ -146,7 +151,18 @@

    Declaration

    -

    The unique, non-localized identifier of the tone. * 2017-09-21: The service can return results for the following tone IDs: anger, fear, joy, and sadness (emotional tones); analytical, confident, and tentative (language tones). The service returns results only for tones whose scores meet a minimum threshold of 0.5. * 2016-05-19: The service can return results for the following tone IDs of the different categories: for the emotion category: anger, disgust, fear, joy, and sadness; for the language category: analytical, confident, and tentative; for the social category: openness_big5, conscientiousness_big5, extraversion_big5, agreeableness_big5, and emotional_range_big5. The service returns scores for all tones of a category, regardless of their values.

    +

    The unique, non-localized identifier of the tone.

    + +
      +
    • 2017-09-21: The service can return results for the following tone IDs: anger, fear, joy, and +sadness (emotional tones); analytical, confident, and tentative (language tones). The service returns +results only for tones whose scores meet a minimum threshold of 0.5.
    • +
    • 2016-05-19: The service can return results for the following tone IDs of the different categories: for the +emotion category: anger, disgust, fear, joy, and sadness; for the language category: analytical, +confident, and tentative; for the social category: openness_big5, conscientiousness_big5, +extraversion_big5, agreeableness_big5, and emotional_range_big5. The service returns scores for all tones of +a category, regardless of their values.
    • +
    @@ -192,7 +208,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/Utterance.html b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/Utterance.html index b749ffa48..05bc27b4f 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/Utterance.html +++ b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/Utterance.html @@ -53,9 +53,6 @@ - @@ -119,7 +116,8 @@

    Utterance

    -

    An utterance contributed by a user in the conversation that is to be analyzed. The utterance can contain multiple sentences.

    +

    An utterance contributed by a user in the conversation that is to be analyzed. The utterance can contain multiple +sentences.

    @@ -180,7 +178,10 @@

    Declaration

    Declaration

    Swift

    -
    public init(text: String, user: String? = nil)
    +
    public init(
    +    text: String,
    +    user: String? = nil
    +)
    @@ -196,7 +197,8 @@

    Parameters

    -

    An utterance contributed by a user in the conversation that is to be analyzed. The utterance can contain multiple sentences.

    +

    An utterance contributed by a user in the conversation that is to be analyzed. The utterance can contain multiple +sentences.

    @@ -227,7 +229,7 @@

    Return Value

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/UtteranceAnalyses.html b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/UtteranceAnalyses.html index 0804fa36f..02f9cbea1 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/UtteranceAnalyses.html +++ b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/UtteranceAnalyses.html @@ -53,9 +53,6 @@ - @@ -146,7 +143,8 @@

    Declaration

    -

    2017-09-21:** A warning message if the content contains more than 50 utterances. The service analyzes only the first 50 utterances. 2016-05-19: Not returned.

    +

    2017-09-21: A warning message if the content contains more than 50 utterances. The service analyzes only the +first 50 utterances. 2016-05-19: Not returned.

    @@ -165,7 +163,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/UtteranceAnalysis.html b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/UtteranceAnalysis.html index aa3e6c399..17603e16a 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/UtteranceAnalysis.html +++ b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/Structs/UtteranceAnalysis.html @@ -53,9 +53,6 @@ - @@ -119,7 +116,8 @@

    UtteranceAnalysis

    -

    The unique identifier of the utterance. The first utterance has ID 0, and the ID of each subsequent utterance is incremented by one.

    +

    The unique identifier of the utterance. The first utterance has ID 0, and the ID of each subsequent utterance is +incremented by one.

    @@ -173,7 +171,9 @@

    Declaration

    -

    An array of ToneChatScore objects that provides results for the most prevalent tones of the utterance. The array includes results for any tone whose score is at least 0.5. The array is empty if no tone has a score that meets this threshold.

    +

    An array of ToneChatScore objects that provides results for the most prevalent tones of the utterance. The array +includes results for any tone whose score is at least 0.5. The array is empty if no tone has a score that meets +this threshold.

    @@ -200,7 +200,8 @@

    Declaration

    -

    2017-09-21:** An error message if the utterance contains more than 500 characters. The service does not analyze the utterance. 2016-05-19: Not returned.

    +

    2017-09-21: An error message if the utterance contains more than 500 characters. The service does not analyze +the utterance. 2016-05-19: Not returned.

    @@ -219,7 +220,7 @@

    Declaration

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/index.html b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/index.html index 9901526cb..dda243347 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/index.html +++ b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/index.html @@ -52,9 +52,6 @@ - @@ -133,7 +130,8 @@

    Services

    • Assistant
    • Discovery
    • -
    • Language Translator
    • +
    • Language Translator V2
    • +
    • Language Translator V3
    • Natural Language Classifier
    • Natural Language Understanding
    • Personality Insights
    • @@ -178,7 +176,7 @@

      Swift Package Manager

      Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

      dependencies: [
      -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
      +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
       ]
       

      Service Instances

      @@ -221,7 +219,7 @@

      Username and Password

      API Key

      -

      Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

      +

      Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

      let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
       

      Using IAM

      @@ -456,7 +454,12 @@

      Private Data Collections

    • IBM Discovery - Documentation
    • IBM Discovery - Demo
    -

    Language Translator

    +

    Language Translator V2

    + +

    Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

    The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

    @@ -467,6 +470,25 @@

    Language Translator

    let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} + +

    Language Translator V3

    + +

    The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

    + +

    The following example demonstrates how to use the Language Translator service:

    +
    import LanguageTranslatorV3
    +
    +let username = "your-username-here"
    +let password = "your-password-here"
    +let version = "yyyy-mm-dd" // use today's date for the most recent version
    +let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
    +
     let failure = { (error: Error) in print(error) }
     let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
     languageTranslator.translate(request: request, failure: failure) {
    @@ -857,7 +879,7 @@ 

    Visual Recognition

    let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -865,6 +887,10 @@

    Visual Recognition

    print(classifiedImages) }
    + +

    Note: a different initializer is used for authentication with instances created before May 23, 2018:

    +
    let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
    +

    Using Core ML

    The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

    @@ -916,7 +942,7 @@

    Bundlin

    diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/search.json b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/search.json index 0bfc58d74..ac2af2cca 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/search.json +++ b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/Documents/search.json @@ -1 +1 @@ -{"Structs/UtteranceAnalysis.html#/s:14ToneAnalyzerV317UtteranceAnalysisV11utteranceIDSivp":{"name":"utteranceID","abstract":"

    The unique identifier of the utterance. The first utterance has ID 0, and the ID of each subsequent utterance is incremented by one.

    ","parent_name":"UtteranceAnalysis"},"Structs/UtteranceAnalysis.html#/s:14ToneAnalyzerV317UtteranceAnalysisV13utteranceTextSSvp":{"name":"utteranceText","abstract":"

    The text of the utterance.

    ","parent_name":"UtteranceAnalysis"},"Structs/UtteranceAnalysis.html#/s:14ToneAnalyzerV317UtteranceAnalysisV5tonesSayAA0A9ChatScoreVGvp":{"name":"tones","abstract":"

    An array of ToneChatScore objects that provides results for the most prevalent tones of the utterance. The array includes results for any tone whose score is at least 0.5. The array is empty if no tone has a score that meets this threshold.

    ","parent_name":"UtteranceAnalysis"},"Structs/UtteranceAnalysis.html#/s:14ToneAnalyzerV317UtteranceAnalysisV5errorSSSgvp":{"name":"error","abstract":"

    2017-09-21:** An error message if the utterance contains more than 500 characters. The service does not analyze the utterance. 2016-05-19: Not returned.

    ","parent_name":"UtteranceAnalysis"},"Structs/UtteranceAnalyses.html#/s:14ToneAnalyzerV317UtteranceAnalysesV010utterancesA0SayAA0D8AnalysisVGvp":{"name":"utterancesTone","abstract":"

    An array of UtteranceAnalysis objects that provides the results for each utterance of the input.

    ","parent_name":"UtteranceAnalyses"},"Structs/UtteranceAnalyses.html#/s:14ToneAnalyzerV317UtteranceAnalysesV7warningSSSgvp":{"name":"warning","abstract":"

    2017-09-21:** A warning message if the content contains more than 50 utterances. The service analyzes only the first 50 utterances. 2016-05-19: Not returned.

    ","parent_name":"UtteranceAnalyses"},"Structs/Utterance.html#/s:14ToneAnalyzerV39UtteranceV4textSSvp":{"name":"text","abstract":"

    An utterance contributed by a user in the conversation that is to be analyzed. The utterance can contain multiple sentences.

    ","parent_name":"Utterance"},"Structs/Utterance.html#/s:14ToneAnalyzerV39UtteranceV4userSSSgvp":{"name":"user","abstract":"

    A string that identifies the user who contributed the utterance specified by the text parameter.

    ","parent_name":"Utterance"},"Structs/Utterance.html#/s:14ToneAnalyzerV39UtteranceVACSS4text_SSSg4usertcfc":{"name":"init(text:user:)","abstract":"

    Initialize a Utterance with member variables.

    ","parent_name":"Utterance"},"Structs/ToneScore.html#/s:14ToneAnalyzerV30A5ScoreV5scoreSdvp":{"name":"score","abstract":"

    The score for the tone. * 2017-09-21: The score that is returned lies in the range of 0.5 to 1. A score greater than 0.75 indicates a high likelihood that the tone is perceived in the content. * 2016-05-19: The score that is returned lies in the range of 0 to 1. A score less than 0.5 indicates that the tone is unlikely to be perceived in the content; a score greater than 0.75 indicates a high likelihood that the tone is perceived.

    ","parent_name":"ToneScore"},"Structs/ToneScore.html#/s:14ToneAnalyzerV30A5ScoreV6toneIDSSvp":{"name":"toneID","abstract":"

    The unique, non-localized identifier of the tone. * 2017-09-21: The service can return results for the following tone IDs: anger, fear, joy, and sadness (emotional tones); analytical, confident, and tentative (language tones). The service returns results only for tones whose scores meet a minimum threshold of 0.5. * 2016-05-19: The service can return results for the following tone IDs of the different categories: for the emotion category: anger, disgust, fear, joy, and sadness; for the language category: analytical, confident, and tentative; for the social category: openness_big5, conscientiousness_big5, extraversion_big5, agreeableness_big5, and emotional_range_big5. The service returns scores for all tones of a category, regardless of their values.

    ","parent_name":"ToneScore"},"Structs/ToneScore.html#/s:14ToneAnalyzerV30A5ScoreV8toneNameSSvp":{"name":"toneName","abstract":"

    The user-visible, localized name of the tone.

    ","parent_name":"ToneScore"},"Structs/ToneInput.html#/s:14ToneAnalyzerV30A5InputV4textSSvp":{"name":"text","abstract":"

    The input content that the service is to analyze.

    ","parent_name":"ToneInput"},"Structs/ToneInput.html#/s:14ToneAnalyzerV30A5InputVACSS4text_tcfc":{"name":"init(text:)","abstract":"

    Initialize a ToneInput with member variables.

    ","parent_name":"ToneInput"},"Structs/ToneChatScore.html#/s:14ToneAnalyzerV30A9ChatScoreV5scoreSdvp":{"name":"score","abstract":"

    The score for the tone in the range of 0.5 to 1. A score greater than 0.75 indicates a high likelihood that the tone is perceived in the utterance.

    ","parent_name":"ToneChatScore"},"Structs/ToneChatScore.html#/s:14ToneAnalyzerV30A9ChatScoreV6toneIDSSvp":{"name":"toneID","abstract":"

    The unique, non-localized identifier of the tone for the results. The service can return results for the following tone IDs: sad, frustrated, satisfied, excited, polite, impolite, and sympathetic. The service returns results only for tones whose scores meet a minimum threshold of 0.5.

    ","parent_name":"ToneChatScore"},"Structs/ToneChatScore.html#/s:14ToneAnalyzerV30A9ChatScoreV8toneNameSSvp":{"name":"toneName","abstract":"

    The user-visible, localized name of the tone.

    ","parent_name":"ToneChatScore"},"Structs/ToneChatInput.html#/s:14ToneAnalyzerV30A9ChatInputV10utterancesSayAA9UtteranceVGvp":{"name":"utterances","abstract":"

    An array of Utterance objects that provides the input content that the service is to analyze.

    ","parent_name":"ToneChatInput"},"Structs/ToneChatInput.html#/s:14ToneAnalyzerV30A9ChatInputVACSayAA9UtteranceVG10utterances_tcfc":{"name":"init(utterances:)","abstract":"

    Initialize a ToneChatInput with member variables.

    ","parent_name":"ToneChatInput"},"Structs/ToneCategory.html#/s:14ToneAnalyzerV30A8CategoryV5tonesSayAA0A5ScoreVGvp":{"name":"tones","abstract":"

    An array of ToneScore objects that provides the results for the tones of the category.

    ","parent_name":"ToneCategory"},"Structs/ToneCategory.html#/s:14ToneAnalyzerV30A8CategoryV10categoryIDSSvp":{"name":"categoryID","abstract":"

    The unique, non-localized identifier of the category for the results. The service can return results for the following category IDs: emotion_tone, language_tone, and social_tone.

    ","parent_name":"ToneCategory"},"Structs/ToneCategory.html#/s:14ToneAnalyzerV30A8CategoryV12categoryNameSSvp":{"name":"categoryName","abstract":"

    The user-visible, localized name of the category.

    ","parent_name":"ToneCategory"},"Structs/ToneAnalysis.html#/s:14ToneAnalyzerV30A8AnalysisV08documentA0AA08DocumentD0Vvp":{"name":"documentTone","abstract":"

    An object of type DocumentAnalysis that provides the results of the analysis for the full input document.

    ","parent_name":"ToneAnalysis"},"Structs/ToneAnalysis.html#/s:14ToneAnalyzerV30A8AnalysisV09sentencesA0SayAA08SentenceD0VGSgvp":{"name":"sentencesTone","abstract":"

    An array of SentenceAnalysis objects that provides the results of the analysis for the individual sentences of the input content. The service returns results only for the first 100 sentences of the input. The field is omitted if the sentences parameter of the request is set to false.

    ","parent_name":"ToneAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV10sentenceIDSivp":{"name":"sentenceID","abstract":"

    The unique identifier of a sentence of the input content. The first sentence has ID 0, and the ID of each subsequent sentence is incremented by one.

    ","parent_name":"SentenceAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV4textSSvp":{"name":"text","abstract":"

    The text of the input sentence.

    ","parent_name":"SentenceAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV5tonesSayAA0A5ScoreVGSgvp":{"name":"tones","abstract":"

    2017-09-21:** An array of ToneScore objects that provides the results of the analysis for each qualifying tone of the sentence. The array includes results for any tone whose score is at least 0.5. The array is empty if no tone has a score that meets this threshold. 2016-05-19: Not returned.

    ","parent_name":"SentenceAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV14toneCategoriesSayAA0A8CategoryVGSgvp":{"name":"toneCategories","abstract":"

    2017-09-21:** Not returned. 2016-05-19: An array of ToneCategory objects that provides the results of the tone analysis for the sentence. The service returns results only for the tones specified with the tones parameter of the request.

    ","parent_name":"SentenceAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV9inputFromSiSgvp":{"name":"inputFrom","abstract":"

    2017-09-21:** Not returned. 2016-05-19: The offset of the first character of the sentence in the overall input content.

    ","parent_name":"SentenceAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV7inputToSiSgvp":{"name":"inputTo","abstract":"

    2017-09-21:** Not returned. 2016-05-19: The offset of the last character of the sentence in the overall input content.

    ","parent_name":"SentenceAnalysis"},"Structs/DocumentAnalysis.html#/s:14ToneAnalyzerV316DocumentAnalysisV5tonesSayAA0A5ScoreVGSgvp":{"name":"tones","abstract":"

    2017-09-21:** An array of ToneScore objects that provides the results of the analysis for each qualifying tone of the document. The array includes results for any tone whose score is at least 0.5. The array is empty if no tone has a score that meets this threshold. 2016-05-19: Not returned.

    ","parent_name":"DocumentAnalysis"},"Structs/DocumentAnalysis.html#/s:14ToneAnalyzerV316DocumentAnalysisV14toneCategoriesSayAA0A8CategoryVGSgvp":{"name":"toneCategories","abstract":"

    2017-09-21:** Not returned. 2016-05-19: An array of ToneCategory objects that provides the results of the tone analysis for the full document of the input content. The service returns results only for the tones specified with the tones parameter of the request.

    ","parent_name":"DocumentAnalysis"},"Structs/DocumentAnalysis.html#/s:14ToneAnalyzerV316DocumentAnalysisV7warningSSSgvp":{"name":"warning","abstract":"

    2017-09-21:** A warning message if the overall content exceeds 128 KB or contains more than 1000 sentences. The service analyzes only the first 1000 sentences for document-level analysis and the first 100 sentences for sentence-level analysis. 2016-05-19: Not returned.

    ","parent_name":"DocumentAnalysis"},"Structs.html#/s:14ToneAnalyzerV311JSONWrapperV":{"name":"JSONWrapper","abstract":"

    Used internally to serialize and deserialize JSON."},"Structs/DocumentAnalysis.html":{"name":"DocumentAnalysis","abstract":"

    DocumentAnalysis.

    "},"Structs/SentenceAnalysis.html":{"name":"SentenceAnalysis","abstract":"

    SentenceAnalysis.

    "},"Structs/ToneAnalysis.html":{"name":"ToneAnalysis","abstract":"

    ToneAnalysis.

    "},"Structs/ToneCategory.html":{"name":"ToneCategory","abstract":"

    ToneCategory.

    "},"Structs/ToneChatInput.html":{"name":"ToneChatInput","abstract":"

    ToneChatInput.

    "},"Structs/ToneChatScore.html":{"name":"ToneChatScore","abstract":"

    ToneChatScore.

    "},"Structs/ToneInput.html":{"name":"ToneInput","abstract":"

    ToneInput.

    "},"Structs/ToneScore.html":{"name":"ToneScore","abstract":"

    ToneScore.

    "},"Structs/Utterance.html":{"name":"Utterance","abstract":"

    Utterance.

    "},"Structs/UtteranceAnalyses.html":{"name":"UtteranceAnalyses","abstract":"

    UtteranceAnalyses.

    "},"Structs/UtteranceAnalysis.html":{"name":"UtteranceAnalysis","abstract":"

    UtteranceAnalysis.

    "},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

    No response was received from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

    No data was returned from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO013serializationE0A2CmF":{"name":"serializationError","abstract":"

    Failed to serialize value(s) to data.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO08encodingE0A2CmF":{"name":"encodingError","abstract":"

    Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO011fileManagerE0A2CmF":{"name":"fileManagerError","abstract":"

    FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

    Failed to load the given file.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

    An HTTP error with a status code and description.

    ","parent_name":"RestError"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO4nullA2CmF":{"name":"null","abstract":"

    A null value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

    A boolean value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO6stringACSScACmF":{"name":"string","abstract":"

    A string value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO3intACSicACmF":{"name":"int","abstract":"

    A number value, represented as an integer.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO6doubleACSdcACmF":{"name":"double","abstract":"

    A number value, represented as a double.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

    An array value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

    An object value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Decode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

    Initialize a JSON value from an encodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

    Convert this JSON value to a decodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

    Encode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compare two JSON values for equality.

    ","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

    A JSON value (one of string, number, object, array, true, false, or null).

    "},"Enums/RestError.html":{"name":"RestError","abstract":"

    An error from processing a network request or response.

    "},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

    The base URL to use when contacting the service.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

    The default HTTP headers for all requests to the service.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

    Create a ToneAnalyzer object.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

    Create a ToneAnalyzer object.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

    Create a ToneAnalyzer object.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

    Undocumented

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C4toneyAA0A5InputV0dE0_SbSg9sentencesSaySSGSg5tonesSSSg15contentLanguageAM06acceptI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0A8AnalysisVc7successtF":{"name":"tone(toneInput:sentences:tones:contentLanguage:acceptLanguage:headers:failure:success:)","abstract":"

    Analyze general tone.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C4toneySS4text_SbSg9sentencesSaySSGSg5tonesSSSg15contentLanguageAK06acceptI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0A8AnalysisVc7successtF":{"name":"tone(text:sentences:tones:contentLanguage:acceptLanguage:headers:failure:success:)","abstract":"

    Analyze general tone.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C4toneySS4html_SbSg9sentencesSaySSGSg5tonesSSSg15contentLanguageAK06acceptI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0A8AnalysisVc7successtF":{"name":"tone(html:sentences:tones:contentLanguage:acceptLanguage:headers:failure:success:)","abstract":"

    Analyze general tone.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C8toneChatySayAA9UtteranceVG10utterances_SSSg15contentLanguageAI06acceptI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F8AnalysesVc7successtF":{"name":"toneChat(utterances:contentLanguage:acceptLanguage:headers:failure:success:)","abstract":"

    Analyze customer engagement tone.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html":{"name":"ToneAnalyzer","abstract":"

    The IBM Watson Tone Analyzer service uses linguistic analysis to detect emotional and language tones in written text."},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "}} \ No newline at end of file +{"Structs/UtteranceAnalysis.html#/s:14ToneAnalyzerV317UtteranceAnalysisV11utteranceIDSivp":{"name":"utteranceID","abstract":"

    The unique identifier of the utterance. The first utterance has ID 0, and the ID of each subsequent utterance is","parent_name":"UtteranceAnalysis"},"Structs/UtteranceAnalysis.html#/s:14ToneAnalyzerV317UtteranceAnalysisV13utteranceTextSSvp":{"name":"utteranceText","abstract":"

    The text of the utterance.

    ","parent_name":"UtteranceAnalysis"},"Structs/UtteranceAnalysis.html#/s:14ToneAnalyzerV317UtteranceAnalysisV5tonesSayAA0A9ChatScoreVGvp":{"name":"tones","abstract":"

    An array of ToneChatScore objects that provides results for the most prevalent tones of the utterance. The array","parent_name":"UtteranceAnalysis"},"Structs/UtteranceAnalysis.html#/s:14ToneAnalyzerV317UtteranceAnalysisV5errorSSSgvp":{"name":"error","abstract":"

    2017-09-21: An error message if the utterance contains more than 500 characters. The service does not analyze","parent_name":"UtteranceAnalysis"},"Structs/UtteranceAnalyses.html#/s:14ToneAnalyzerV317UtteranceAnalysesV010utterancesA0SayAA0D8AnalysisVGvp":{"name":"utterancesTone","abstract":"

    An array of UtteranceAnalysis objects that provides the results for each utterance of the input.

    ","parent_name":"UtteranceAnalyses"},"Structs/UtteranceAnalyses.html#/s:14ToneAnalyzerV317UtteranceAnalysesV7warningSSSgvp":{"name":"warning","abstract":"

    2017-09-21: A warning message if the content contains more than 50 utterances. The service analyzes only the","parent_name":"UtteranceAnalyses"},"Structs/Utterance.html#/s:14ToneAnalyzerV39UtteranceV4textSSvp":{"name":"text","abstract":"

    An utterance contributed by a user in the conversation that is to be analyzed. The utterance can contain multiple","parent_name":"Utterance"},"Structs/Utterance.html#/s:14ToneAnalyzerV39UtteranceV4userSSSgvp":{"name":"user","abstract":"

    A string that identifies the user who contributed the utterance specified by the text parameter.

    ","parent_name":"Utterance"},"Structs/Utterance.html#/s:14ToneAnalyzerV39UtteranceVACSS4text_SSSg4usertcfc":{"name":"init(text:user:)","abstract":"

    Initialize a Utterance with member variables.

    ","parent_name":"Utterance"},"Structs/ToneScore.html#/s:14ToneAnalyzerV30A5ScoreV5scoreSdvp":{"name":"score","abstract":"

    The score for the tone.

    ","parent_name":"ToneScore"},"Structs/ToneScore.html#/s:14ToneAnalyzerV30A5ScoreV6toneIDSSvp":{"name":"toneID","abstract":"

    The unique, non-localized identifier of the tone.

    ","parent_name":"ToneScore"},"Structs/ToneScore.html#/s:14ToneAnalyzerV30A5ScoreV8toneNameSSvp":{"name":"toneName","abstract":"

    The user-visible, localized name of the tone.

    ","parent_name":"ToneScore"},"Structs/ToneInput.html#/s:14ToneAnalyzerV30A5InputV4textSSvp":{"name":"text","abstract":"

    The input content that the service is to analyze.

    ","parent_name":"ToneInput"},"Structs/ToneInput.html#/s:14ToneAnalyzerV30A5InputVACSS4text_tcfc":{"name":"init(text:)","abstract":"

    Initialize a ToneInput with member variables.

    ","parent_name":"ToneInput"},"Structs/ToneChatScore.html#/s:14ToneAnalyzerV30A9ChatScoreV5scoreSdvp":{"name":"score","abstract":"

    The score for the tone in the range of 0.5 to 1. A score greater than 0.75 indicates a high likelihood that the","parent_name":"ToneChatScore"},"Structs/ToneChatScore.html#/s:14ToneAnalyzerV30A9ChatScoreV6toneIDSSvp":{"name":"toneID","abstract":"

    The unique, non-localized identifier of the tone for the results. The service can return results for the following","parent_name":"ToneChatScore"},"Structs/ToneChatScore.html#/s:14ToneAnalyzerV30A9ChatScoreV8toneNameSSvp":{"name":"toneName","abstract":"

    The user-visible, localized name of the tone.

    ","parent_name":"ToneChatScore"},"Structs/ToneChatInput.html#/s:14ToneAnalyzerV30A9ChatInputV10utterancesSayAA9UtteranceVGvp":{"name":"utterances","abstract":"

    An array of Utterance objects that provides the input content that the service is to analyze.

    ","parent_name":"ToneChatInput"},"Structs/ToneChatInput.html#/s:14ToneAnalyzerV30A9ChatInputVACSayAA9UtteranceVG10utterances_tcfc":{"name":"init(utterances:)","abstract":"

    Initialize a ToneChatInput with member variables.

    ","parent_name":"ToneChatInput"},"Structs/ToneCategory.html#/s:14ToneAnalyzerV30A8CategoryV5tonesSayAA0A5ScoreVGvp":{"name":"tones","abstract":"

    An array of ToneScore objects that provides the results for the tones of the category.

    ","parent_name":"ToneCategory"},"Structs/ToneCategory.html#/s:14ToneAnalyzerV30A8CategoryV10categoryIDSSvp":{"name":"categoryID","abstract":"

    The unique, non-localized identifier of the category for the results. The service can return results for the","parent_name":"ToneCategory"},"Structs/ToneCategory.html#/s:14ToneAnalyzerV30A8CategoryV12categoryNameSSvp":{"name":"categoryName","abstract":"

    The user-visible, localized name of the category.

    ","parent_name":"ToneCategory"},"Structs/ToneAnalysis.html#/s:14ToneAnalyzerV30A8AnalysisV08documentA0AA08DocumentD0Vvp":{"name":"documentTone","abstract":"

    An object of type DocumentAnalysis that provides the results of the analysis for the full input document.

    ","parent_name":"ToneAnalysis"},"Structs/ToneAnalysis.html#/s:14ToneAnalyzerV30A8AnalysisV09sentencesA0SayAA08SentenceD0VGSgvp":{"name":"sentencesTone","abstract":"

    An array of SentenceAnalysis objects that provides the results of the analysis for the individual sentences of","parent_name":"ToneAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV10sentenceIDSivp":{"name":"sentenceID","abstract":"

    The unique identifier of a sentence of the input content. The first sentence has ID 0, and the ID of each","parent_name":"SentenceAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV4textSSvp":{"name":"text","abstract":"

    The text of the input sentence.

    ","parent_name":"SentenceAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV5tonesSayAA0A5ScoreVGSgvp":{"name":"tones","abstract":"

    2017-09-21: An array of ToneScore objects that provides the results of the analysis for each qualifying","parent_name":"SentenceAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV14toneCategoriesSayAA0A8CategoryVGSgvp":{"name":"toneCategories","abstract":"

    2017-09-21: Not returned. 2016-05-19: An array of ToneCategory objects that provides the results of","parent_name":"SentenceAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV9inputFromSiSgvp":{"name":"inputFrom","abstract":"

    2017-09-21: Not returned. 2016-05-19: The offset of the first character of the sentence in the overall","parent_name":"SentenceAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV7inputToSiSgvp":{"name":"inputTo","abstract":"

    2017-09-21: Not returned. 2016-05-19: The offset of the last character of the sentence in the overall","parent_name":"SentenceAnalysis"},"Structs/DocumentAnalysis.html#/s:14ToneAnalyzerV316DocumentAnalysisV5tonesSayAA0A5ScoreVGSgvp":{"name":"tones","abstract":"

    2017-09-21: An array of ToneScore objects that provides the results of the analysis for each qualifying","parent_name":"DocumentAnalysis"},"Structs/DocumentAnalysis.html#/s:14ToneAnalyzerV316DocumentAnalysisV14toneCategoriesSayAA0A8CategoryVGSgvp":{"name":"toneCategories","abstract":"

    2017-09-21: Not returned. 2016-05-19: An array of ToneCategory objects that provides the results of","parent_name":"DocumentAnalysis"},"Structs/DocumentAnalysis.html#/s:14ToneAnalyzerV316DocumentAnalysisV7warningSSSgvp":{"name":"warning","abstract":"

    2017-09-21: A warning message if the overall content exceeds 128 KB or contains more than 1000 sentences. The","parent_name":"DocumentAnalysis"},"Structs/DocumentAnalysis.html":{"name":"DocumentAnalysis","abstract":"

    DocumentAnalysis.

    "},"Structs/SentenceAnalysis.html":{"name":"SentenceAnalysis","abstract":"

    SentenceAnalysis.

    "},"Structs/ToneAnalysis.html":{"name":"ToneAnalysis","abstract":"

    ToneAnalysis.

    "},"Structs/ToneCategory.html":{"name":"ToneCategory","abstract":"

    ToneCategory.

    "},"Structs/ToneChatInput.html":{"name":"ToneChatInput","abstract":"

    ToneChatInput.

    "},"Structs/ToneChatScore.html":{"name":"ToneChatScore","abstract":"

    ToneChatScore.

    "},"Structs/ToneInput.html":{"name":"ToneInput","abstract":"

    ToneInput.

    "},"Structs/ToneScore.html":{"name":"ToneScore","abstract":"

    ToneScore.

    "},"Structs/Utterance.html":{"name":"Utterance","abstract":"

    Utterance.

    "},"Structs/UtteranceAnalyses.html":{"name":"UtteranceAnalyses","abstract":"

    UtteranceAnalyses.

    "},"Structs/UtteranceAnalysis.html":{"name":"UtteranceAnalysis","abstract":"

    UtteranceAnalysis.

    "},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

    No response was received from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

    No data was returned from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO013serializationE0A2CmF":{"name":"serializationError","abstract":"

    Failed to serialize value(s) to data.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO08encodingE0A2CmF":{"name":"encodingError","abstract":"

    Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO011fileManagerE0A2CmF":{"name":"fileManagerError","abstract":"

    FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

    Failed to load the given file.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

    An HTTP error with a status code and description.

    ","parent_name":"RestError"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO4nullA2CmF":{"name":"null","abstract":"

    A null value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

    A boolean value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO6stringACSScACmF":{"name":"string","abstract":"

    A string value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO3intACSicACmF":{"name":"int","abstract":"

    A number value, represented as an integer.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO6doubleACSdcACmF":{"name":"double","abstract":"

    A number value, represented as a double.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

    An array value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

    An object value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Decode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

    Initialize a JSON value from an encodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

    Convert this JSON value to a decodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

    Encode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compare two JSON values for equality.

    ","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

    A JSON value (one of string, number, object, array, true, false, or null).

    "},"Enums/RestError.html":{"name":"RestError","abstract":"

    An error from processing a network request or response.

    "},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

    The base URL to use when contacting the service.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

    The default HTTP headers for all requests to the service.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

    Create a ToneAnalyzer object.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

    Create a ToneAnalyzer object.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

    Create a ToneAnalyzer object.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

    Undocumented

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C4toneyAA0A5InputV0dE0_SbSg9sentencesSaySSGSg5tonesSSSg15contentLanguageAM06acceptI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0A8AnalysisVc7successtF":{"name":"tone(toneInput:sentences:tones:contentLanguage:acceptLanguage:headers:failure:success:)","abstract":"

    Analyze general tone.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C4toneySS4text_SbSg9sentencesSaySSGSg5tonesSSSg15contentLanguageAK06acceptI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0A8AnalysisVc7successtF":{"name":"tone(text:sentences:tones:contentLanguage:acceptLanguage:headers:failure:success:)","abstract":"

    Analyze general tone.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C4toneySS4html_SbSg9sentencesSaySSGSg5tonesSSSg15contentLanguageAK06acceptI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0A8AnalysisVc7successtF":{"name":"tone(html:sentences:tones:contentLanguage:acceptLanguage:headers:failure:success:)","abstract":"

    Analyze general tone.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C8toneChatySayAA9UtteranceVG10utterances_SSSg15contentLanguageAI06acceptI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F8AnalysesVc7successtF":{"name":"toneChat(utterances:contentLanguage:acceptLanguage:headers:failure:success:)","abstract":"

    Analyze customer engagement tone.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html":{"name":"ToneAnalyzer","abstract":"

    The IBM Watson™ Tone Analyzer service uses linguistic analysis to detect emotional and language tones in written"},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "}} \ No newline at end of file diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/docSet.dsidx b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/docSet.dsidx index 538cd7538..dde3d0772 100644 Binary files a/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/docSet.dsidx and b/docs/swift-api/services/ToneAnalyzerV3/docsets/.docset/Contents/Resources/docSet.dsidx differ diff --git a/docs/swift-api/services/ToneAnalyzerV3/docsets/.tgz b/docs/swift-api/services/ToneAnalyzerV3/docsets/.tgz index f0b1b682a..20ad9bcf7 100644 Binary files a/docs/swift-api/services/ToneAnalyzerV3/docsets/.tgz and b/docs/swift-api/services/ToneAnalyzerV3/docsets/.tgz differ diff --git a/docs/swift-api/services/ToneAnalyzerV3/index.html b/docs/swift-api/services/ToneAnalyzerV3/index.html index 9901526cb..dda243347 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/index.html +++ b/docs/swift-api/services/ToneAnalyzerV3/index.html @@ -52,9 +52,6 @@ - @@ -133,7 +130,8 @@

    Services

    • Assistant
    • Discovery
    • -
    • Language Translator
    • +
    • Language Translator V2
    • +
    • Language Translator V3
    • Natural Language Classifier
    • Natural Language Understanding
    • Personality Insights
    • @@ -178,7 +176,7 @@

      Swift Package Manager

      Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

      dependencies: [
      -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
      +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
       ]
       

      Service Instances

      @@ -221,7 +219,7 @@

      Username and Password

      API Key

      -

      Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

      +

      Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

      let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
       

      Using IAM

      @@ -456,7 +454,12 @@

      Private Data Collections

    • IBM Discovery - Documentation
    • IBM Discovery - Demo
    -

    Language Translator

    +

    Language Translator V2

    + +

    Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

    The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

    @@ -467,6 +470,25 @@

    Language Translator

    let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} + +

    Language Translator V3

    + +

    The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

    + +

    The following example demonstrates how to use the Language Translator service:

    +
    import LanguageTranslatorV3
    +
    +let username = "your-username-here"
    +let password = "your-password-here"
    +let version = "yyyy-mm-dd" // use today's date for the most recent version
    +let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
    +
     let failure = { (error: Error) in print(error) }
     let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
     languageTranslator.translate(request: request, failure: failure) {
    @@ -857,7 +879,7 @@ 

    Visual Recognition

    let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -865,6 +887,10 @@

    Visual Recognition

    print(classifiedImages) }
    + +

    Note: a different initializer is used for authentication with instances created before May 23, 2018:

    +
    let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
    +

    Using Core ML

    The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

    @@ -916,7 +942,7 @@

    Bundlin diff --git a/docs/swift-api/services/ToneAnalyzerV3/search.json b/docs/swift-api/services/ToneAnalyzerV3/search.json index 0bfc58d74..ac2af2cca 100644 --- a/docs/swift-api/services/ToneAnalyzerV3/search.json +++ b/docs/swift-api/services/ToneAnalyzerV3/search.json @@ -1 +1 @@ -{"Structs/UtteranceAnalysis.html#/s:14ToneAnalyzerV317UtteranceAnalysisV11utteranceIDSivp":{"name":"utteranceID","abstract":"

    The unique identifier of the utterance. The first utterance has ID 0, and the ID of each subsequent utterance is incremented by one.

    ","parent_name":"UtteranceAnalysis"},"Structs/UtteranceAnalysis.html#/s:14ToneAnalyzerV317UtteranceAnalysisV13utteranceTextSSvp":{"name":"utteranceText","abstract":"

    The text of the utterance.

    ","parent_name":"UtteranceAnalysis"},"Structs/UtteranceAnalysis.html#/s:14ToneAnalyzerV317UtteranceAnalysisV5tonesSayAA0A9ChatScoreVGvp":{"name":"tones","abstract":"

    An array of ToneChatScore objects that provides results for the most prevalent tones of the utterance. The array includes results for any tone whose score is at least 0.5. The array is empty if no tone has a score that meets this threshold.

    ","parent_name":"UtteranceAnalysis"},"Structs/UtteranceAnalysis.html#/s:14ToneAnalyzerV317UtteranceAnalysisV5errorSSSgvp":{"name":"error","abstract":"

    2017-09-21:** An error message if the utterance contains more than 500 characters. The service does not analyze the utterance. 2016-05-19: Not returned.

    ","parent_name":"UtteranceAnalysis"},"Structs/UtteranceAnalyses.html#/s:14ToneAnalyzerV317UtteranceAnalysesV010utterancesA0SayAA0D8AnalysisVGvp":{"name":"utterancesTone","abstract":"

    An array of UtteranceAnalysis objects that provides the results for each utterance of the input.

    ","parent_name":"UtteranceAnalyses"},"Structs/UtteranceAnalyses.html#/s:14ToneAnalyzerV317UtteranceAnalysesV7warningSSSgvp":{"name":"warning","abstract":"

    2017-09-21:** A warning message if the content contains more than 50 utterances. The service analyzes only the first 50 utterances. 2016-05-19: Not returned.

    ","parent_name":"UtteranceAnalyses"},"Structs/Utterance.html#/s:14ToneAnalyzerV39UtteranceV4textSSvp":{"name":"text","abstract":"

    An utterance contributed by a user in the conversation that is to be analyzed. The utterance can contain multiple sentences.

    ","parent_name":"Utterance"},"Structs/Utterance.html#/s:14ToneAnalyzerV39UtteranceV4userSSSgvp":{"name":"user","abstract":"

    A string that identifies the user who contributed the utterance specified by the text parameter.

    ","parent_name":"Utterance"},"Structs/Utterance.html#/s:14ToneAnalyzerV39UtteranceVACSS4text_SSSg4usertcfc":{"name":"init(text:user:)","abstract":"

    Initialize a Utterance with member variables.

    ","parent_name":"Utterance"},"Structs/ToneScore.html#/s:14ToneAnalyzerV30A5ScoreV5scoreSdvp":{"name":"score","abstract":"

    The score for the tone. * 2017-09-21: The score that is returned lies in the range of 0.5 to 1. A score greater than 0.75 indicates a high likelihood that the tone is perceived in the content. * 2016-05-19: The score that is returned lies in the range of 0 to 1. A score less than 0.5 indicates that the tone is unlikely to be perceived in the content; a score greater than 0.75 indicates a high likelihood that the tone is perceived.

    ","parent_name":"ToneScore"},"Structs/ToneScore.html#/s:14ToneAnalyzerV30A5ScoreV6toneIDSSvp":{"name":"toneID","abstract":"

    The unique, non-localized identifier of the tone. * 2017-09-21: The service can return results for the following tone IDs: anger, fear, joy, and sadness (emotional tones); analytical, confident, and tentative (language tones). The service returns results only for tones whose scores meet a minimum threshold of 0.5. * 2016-05-19: The service can return results for the following tone IDs of the different categories: for the emotion category: anger, disgust, fear, joy, and sadness; for the language category: analytical, confident, and tentative; for the social category: openness_big5, conscientiousness_big5, extraversion_big5, agreeableness_big5, and emotional_range_big5. The service returns scores for all tones of a category, regardless of their values.

    ","parent_name":"ToneScore"},"Structs/ToneScore.html#/s:14ToneAnalyzerV30A5ScoreV8toneNameSSvp":{"name":"toneName","abstract":"

    The user-visible, localized name of the tone.

    ","parent_name":"ToneScore"},"Structs/ToneInput.html#/s:14ToneAnalyzerV30A5InputV4textSSvp":{"name":"text","abstract":"

    The input content that the service is to analyze.

    ","parent_name":"ToneInput"},"Structs/ToneInput.html#/s:14ToneAnalyzerV30A5InputVACSS4text_tcfc":{"name":"init(text:)","abstract":"

    Initialize a ToneInput with member variables.

    ","parent_name":"ToneInput"},"Structs/ToneChatScore.html#/s:14ToneAnalyzerV30A9ChatScoreV5scoreSdvp":{"name":"score","abstract":"

    The score for the tone in the range of 0.5 to 1. A score greater than 0.75 indicates a high likelihood that the tone is perceived in the utterance.

    ","parent_name":"ToneChatScore"},"Structs/ToneChatScore.html#/s:14ToneAnalyzerV30A9ChatScoreV6toneIDSSvp":{"name":"toneID","abstract":"

    The unique, non-localized identifier of the tone for the results. The service can return results for the following tone IDs: sad, frustrated, satisfied, excited, polite, impolite, and sympathetic. The service returns results only for tones whose scores meet a minimum threshold of 0.5.

    ","parent_name":"ToneChatScore"},"Structs/ToneChatScore.html#/s:14ToneAnalyzerV30A9ChatScoreV8toneNameSSvp":{"name":"toneName","abstract":"

    The user-visible, localized name of the tone.

    ","parent_name":"ToneChatScore"},"Structs/ToneChatInput.html#/s:14ToneAnalyzerV30A9ChatInputV10utterancesSayAA9UtteranceVGvp":{"name":"utterances","abstract":"

    An array of Utterance objects that provides the input content that the service is to analyze.

    ","parent_name":"ToneChatInput"},"Structs/ToneChatInput.html#/s:14ToneAnalyzerV30A9ChatInputVACSayAA9UtteranceVG10utterances_tcfc":{"name":"init(utterances:)","abstract":"

    Initialize a ToneChatInput with member variables.

    ","parent_name":"ToneChatInput"},"Structs/ToneCategory.html#/s:14ToneAnalyzerV30A8CategoryV5tonesSayAA0A5ScoreVGvp":{"name":"tones","abstract":"

    An array of ToneScore objects that provides the results for the tones of the category.

    ","parent_name":"ToneCategory"},"Structs/ToneCategory.html#/s:14ToneAnalyzerV30A8CategoryV10categoryIDSSvp":{"name":"categoryID","abstract":"

    The unique, non-localized identifier of the category for the results. The service can return results for the following category IDs: emotion_tone, language_tone, and social_tone.

    ","parent_name":"ToneCategory"},"Structs/ToneCategory.html#/s:14ToneAnalyzerV30A8CategoryV12categoryNameSSvp":{"name":"categoryName","abstract":"

    The user-visible, localized name of the category.

    ","parent_name":"ToneCategory"},"Structs/ToneAnalysis.html#/s:14ToneAnalyzerV30A8AnalysisV08documentA0AA08DocumentD0Vvp":{"name":"documentTone","abstract":"

    An object of type DocumentAnalysis that provides the results of the analysis for the full input document.

    ","parent_name":"ToneAnalysis"},"Structs/ToneAnalysis.html#/s:14ToneAnalyzerV30A8AnalysisV09sentencesA0SayAA08SentenceD0VGSgvp":{"name":"sentencesTone","abstract":"

    An array of SentenceAnalysis objects that provides the results of the analysis for the individual sentences of the input content. The service returns results only for the first 100 sentences of the input. The field is omitted if the sentences parameter of the request is set to false.

    ","parent_name":"ToneAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV10sentenceIDSivp":{"name":"sentenceID","abstract":"

    The unique identifier of a sentence of the input content. The first sentence has ID 0, and the ID of each subsequent sentence is incremented by one.

    ","parent_name":"SentenceAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV4textSSvp":{"name":"text","abstract":"

    The text of the input sentence.

    ","parent_name":"SentenceAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV5tonesSayAA0A5ScoreVGSgvp":{"name":"tones","abstract":"

    2017-09-21:** An array of ToneScore objects that provides the results of the analysis for each qualifying tone of the sentence. The array includes results for any tone whose score is at least 0.5. The array is empty if no tone has a score that meets this threshold. 2016-05-19: Not returned.

    ","parent_name":"SentenceAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV14toneCategoriesSayAA0A8CategoryVGSgvp":{"name":"toneCategories","abstract":"

    2017-09-21:** Not returned. 2016-05-19: An array of ToneCategory objects that provides the results of the tone analysis for the sentence. The service returns results only for the tones specified with the tones parameter of the request.

    ","parent_name":"SentenceAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV9inputFromSiSgvp":{"name":"inputFrom","abstract":"

    2017-09-21:** Not returned. 2016-05-19: The offset of the first character of the sentence in the overall input content.

    ","parent_name":"SentenceAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV7inputToSiSgvp":{"name":"inputTo","abstract":"

    2017-09-21:** Not returned. 2016-05-19: The offset of the last character of the sentence in the overall input content.

    ","parent_name":"SentenceAnalysis"},"Structs/DocumentAnalysis.html#/s:14ToneAnalyzerV316DocumentAnalysisV5tonesSayAA0A5ScoreVGSgvp":{"name":"tones","abstract":"

    2017-09-21:** An array of ToneScore objects that provides the results of the analysis for each qualifying tone of the document. The array includes results for any tone whose score is at least 0.5. The array is empty if no tone has a score that meets this threshold. 2016-05-19: Not returned.

    ","parent_name":"DocumentAnalysis"},"Structs/DocumentAnalysis.html#/s:14ToneAnalyzerV316DocumentAnalysisV14toneCategoriesSayAA0A8CategoryVGSgvp":{"name":"toneCategories","abstract":"

    2017-09-21:** Not returned. 2016-05-19: An array of ToneCategory objects that provides the results of the tone analysis for the full document of the input content. The service returns results only for the tones specified with the tones parameter of the request.

    ","parent_name":"DocumentAnalysis"},"Structs/DocumentAnalysis.html#/s:14ToneAnalyzerV316DocumentAnalysisV7warningSSSgvp":{"name":"warning","abstract":"

    2017-09-21:** A warning message if the overall content exceeds 128 KB or contains more than 1000 sentences. The service analyzes only the first 1000 sentences for document-level analysis and the first 100 sentences for sentence-level analysis. 2016-05-19: Not returned.

    ","parent_name":"DocumentAnalysis"},"Structs.html#/s:14ToneAnalyzerV311JSONWrapperV":{"name":"JSONWrapper","abstract":"

    Used internally to serialize and deserialize JSON."},"Structs/DocumentAnalysis.html":{"name":"DocumentAnalysis","abstract":"

    DocumentAnalysis.

    "},"Structs/SentenceAnalysis.html":{"name":"SentenceAnalysis","abstract":"

    SentenceAnalysis.

    "},"Structs/ToneAnalysis.html":{"name":"ToneAnalysis","abstract":"

    ToneAnalysis.

    "},"Structs/ToneCategory.html":{"name":"ToneCategory","abstract":"

    ToneCategory.

    "},"Structs/ToneChatInput.html":{"name":"ToneChatInput","abstract":"

    ToneChatInput.

    "},"Structs/ToneChatScore.html":{"name":"ToneChatScore","abstract":"

    ToneChatScore.

    "},"Structs/ToneInput.html":{"name":"ToneInput","abstract":"

    ToneInput.

    "},"Structs/ToneScore.html":{"name":"ToneScore","abstract":"

    ToneScore.

    "},"Structs/Utterance.html":{"name":"Utterance","abstract":"

    Utterance.

    "},"Structs/UtteranceAnalyses.html":{"name":"UtteranceAnalyses","abstract":"

    UtteranceAnalyses.

    "},"Structs/UtteranceAnalysis.html":{"name":"UtteranceAnalysis","abstract":"

    UtteranceAnalysis.

    "},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

    No response was received from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

    No data was returned from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO013serializationE0A2CmF":{"name":"serializationError","abstract":"

    Failed to serialize value(s) to data.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO08encodingE0A2CmF":{"name":"encodingError","abstract":"

    Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO011fileManagerE0A2CmF":{"name":"fileManagerError","abstract":"

    FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

    Failed to load the given file.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

    An HTTP error with a status code and description.

    ","parent_name":"RestError"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO4nullA2CmF":{"name":"null","abstract":"

    A null value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

    A boolean value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO6stringACSScACmF":{"name":"string","abstract":"

    A string value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO3intACSicACmF":{"name":"int","abstract":"

    A number value, represented as an integer.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO6doubleACSdcACmF":{"name":"double","abstract":"

    A number value, represented as a double.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

    An array value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

    An object value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Decode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

    Initialize a JSON value from an encodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

    Convert this JSON value to a decodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

    Encode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compare two JSON values for equality.

    ","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

    A JSON value (one of string, number, object, array, true, false, or null).

    "},"Enums/RestError.html":{"name":"RestError","abstract":"

    An error from processing a network request or response.

    "},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

    The base URL to use when contacting the service.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

    The default HTTP headers for all requests to the service.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

    Create a ToneAnalyzer object.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

    Create a ToneAnalyzer object.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

    Create a ToneAnalyzer object.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

    Undocumented

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C4toneyAA0A5InputV0dE0_SbSg9sentencesSaySSGSg5tonesSSSg15contentLanguageAM06acceptI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0A8AnalysisVc7successtF":{"name":"tone(toneInput:sentences:tones:contentLanguage:acceptLanguage:headers:failure:success:)","abstract":"

    Analyze general tone.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C4toneySS4text_SbSg9sentencesSaySSGSg5tonesSSSg15contentLanguageAK06acceptI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0A8AnalysisVc7successtF":{"name":"tone(text:sentences:tones:contentLanguage:acceptLanguage:headers:failure:success:)","abstract":"

    Analyze general tone.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C4toneySS4html_SbSg9sentencesSaySSGSg5tonesSSSg15contentLanguageAK06acceptI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0A8AnalysisVc7successtF":{"name":"tone(html:sentences:tones:contentLanguage:acceptLanguage:headers:failure:success:)","abstract":"

    Analyze general tone.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C8toneChatySayAA9UtteranceVG10utterances_SSSg15contentLanguageAI06acceptI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F8AnalysesVc7successtF":{"name":"toneChat(utterances:contentLanguage:acceptLanguage:headers:failure:success:)","abstract":"

    Analyze customer engagement tone.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html":{"name":"ToneAnalyzer","abstract":"

    The IBM Watson Tone Analyzer service uses linguistic analysis to detect emotional and language tones in written text."},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "}} \ No newline at end of file +{"Structs/UtteranceAnalysis.html#/s:14ToneAnalyzerV317UtteranceAnalysisV11utteranceIDSivp":{"name":"utteranceID","abstract":"

    The unique identifier of the utterance. The first utterance has ID 0, and the ID of each subsequent utterance is","parent_name":"UtteranceAnalysis"},"Structs/UtteranceAnalysis.html#/s:14ToneAnalyzerV317UtteranceAnalysisV13utteranceTextSSvp":{"name":"utteranceText","abstract":"

    The text of the utterance.

    ","parent_name":"UtteranceAnalysis"},"Structs/UtteranceAnalysis.html#/s:14ToneAnalyzerV317UtteranceAnalysisV5tonesSayAA0A9ChatScoreVGvp":{"name":"tones","abstract":"

    An array of ToneChatScore objects that provides results for the most prevalent tones of the utterance. The array","parent_name":"UtteranceAnalysis"},"Structs/UtteranceAnalysis.html#/s:14ToneAnalyzerV317UtteranceAnalysisV5errorSSSgvp":{"name":"error","abstract":"

    2017-09-21: An error message if the utterance contains more than 500 characters. The service does not analyze","parent_name":"UtteranceAnalysis"},"Structs/UtteranceAnalyses.html#/s:14ToneAnalyzerV317UtteranceAnalysesV010utterancesA0SayAA0D8AnalysisVGvp":{"name":"utterancesTone","abstract":"

    An array of UtteranceAnalysis objects that provides the results for each utterance of the input.

    ","parent_name":"UtteranceAnalyses"},"Structs/UtteranceAnalyses.html#/s:14ToneAnalyzerV317UtteranceAnalysesV7warningSSSgvp":{"name":"warning","abstract":"

    2017-09-21: A warning message if the content contains more than 50 utterances. The service analyzes only the","parent_name":"UtteranceAnalyses"},"Structs/Utterance.html#/s:14ToneAnalyzerV39UtteranceV4textSSvp":{"name":"text","abstract":"

    An utterance contributed by a user in the conversation that is to be analyzed. The utterance can contain multiple","parent_name":"Utterance"},"Structs/Utterance.html#/s:14ToneAnalyzerV39UtteranceV4userSSSgvp":{"name":"user","abstract":"

    A string that identifies the user who contributed the utterance specified by the text parameter.

    ","parent_name":"Utterance"},"Structs/Utterance.html#/s:14ToneAnalyzerV39UtteranceVACSS4text_SSSg4usertcfc":{"name":"init(text:user:)","abstract":"

    Initialize a Utterance with member variables.

    ","parent_name":"Utterance"},"Structs/ToneScore.html#/s:14ToneAnalyzerV30A5ScoreV5scoreSdvp":{"name":"score","abstract":"

    The score for the tone.

    ","parent_name":"ToneScore"},"Structs/ToneScore.html#/s:14ToneAnalyzerV30A5ScoreV6toneIDSSvp":{"name":"toneID","abstract":"

    The unique, non-localized identifier of the tone.

    ","parent_name":"ToneScore"},"Structs/ToneScore.html#/s:14ToneAnalyzerV30A5ScoreV8toneNameSSvp":{"name":"toneName","abstract":"

    The user-visible, localized name of the tone.

    ","parent_name":"ToneScore"},"Structs/ToneInput.html#/s:14ToneAnalyzerV30A5InputV4textSSvp":{"name":"text","abstract":"

    The input content that the service is to analyze.

    ","parent_name":"ToneInput"},"Structs/ToneInput.html#/s:14ToneAnalyzerV30A5InputVACSS4text_tcfc":{"name":"init(text:)","abstract":"

    Initialize a ToneInput with member variables.

    ","parent_name":"ToneInput"},"Structs/ToneChatScore.html#/s:14ToneAnalyzerV30A9ChatScoreV5scoreSdvp":{"name":"score","abstract":"

    The score for the tone in the range of 0.5 to 1. A score greater than 0.75 indicates a high likelihood that the","parent_name":"ToneChatScore"},"Structs/ToneChatScore.html#/s:14ToneAnalyzerV30A9ChatScoreV6toneIDSSvp":{"name":"toneID","abstract":"

    The unique, non-localized identifier of the tone for the results. The service can return results for the following","parent_name":"ToneChatScore"},"Structs/ToneChatScore.html#/s:14ToneAnalyzerV30A9ChatScoreV8toneNameSSvp":{"name":"toneName","abstract":"

    The user-visible, localized name of the tone.

    ","parent_name":"ToneChatScore"},"Structs/ToneChatInput.html#/s:14ToneAnalyzerV30A9ChatInputV10utterancesSayAA9UtteranceVGvp":{"name":"utterances","abstract":"

    An array of Utterance objects that provides the input content that the service is to analyze.

    ","parent_name":"ToneChatInput"},"Structs/ToneChatInput.html#/s:14ToneAnalyzerV30A9ChatInputVACSayAA9UtteranceVG10utterances_tcfc":{"name":"init(utterances:)","abstract":"

    Initialize a ToneChatInput with member variables.

    ","parent_name":"ToneChatInput"},"Structs/ToneCategory.html#/s:14ToneAnalyzerV30A8CategoryV5tonesSayAA0A5ScoreVGvp":{"name":"tones","abstract":"

    An array of ToneScore objects that provides the results for the tones of the category.

    ","parent_name":"ToneCategory"},"Structs/ToneCategory.html#/s:14ToneAnalyzerV30A8CategoryV10categoryIDSSvp":{"name":"categoryID","abstract":"

    The unique, non-localized identifier of the category for the results. The service can return results for the","parent_name":"ToneCategory"},"Structs/ToneCategory.html#/s:14ToneAnalyzerV30A8CategoryV12categoryNameSSvp":{"name":"categoryName","abstract":"

    The user-visible, localized name of the category.

    ","parent_name":"ToneCategory"},"Structs/ToneAnalysis.html#/s:14ToneAnalyzerV30A8AnalysisV08documentA0AA08DocumentD0Vvp":{"name":"documentTone","abstract":"

    An object of type DocumentAnalysis that provides the results of the analysis for the full input document.

    ","parent_name":"ToneAnalysis"},"Structs/ToneAnalysis.html#/s:14ToneAnalyzerV30A8AnalysisV09sentencesA0SayAA08SentenceD0VGSgvp":{"name":"sentencesTone","abstract":"

    An array of SentenceAnalysis objects that provides the results of the analysis for the individual sentences of","parent_name":"ToneAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV10sentenceIDSivp":{"name":"sentenceID","abstract":"

    The unique identifier of a sentence of the input content. The first sentence has ID 0, and the ID of each","parent_name":"SentenceAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV4textSSvp":{"name":"text","abstract":"

    The text of the input sentence.

    ","parent_name":"SentenceAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV5tonesSayAA0A5ScoreVGSgvp":{"name":"tones","abstract":"

    2017-09-21: An array of ToneScore objects that provides the results of the analysis for each qualifying","parent_name":"SentenceAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV14toneCategoriesSayAA0A8CategoryVGSgvp":{"name":"toneCategories","abstract":"

    2017-09-21: Not returned. 2016-05-19: An array of ToneCategory objects that provides the results of","parent_name":"SentenceAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV9inputFromSiSgvp":{"name":"inputFrom","abstract":"

    2017-09-21: Not returned. 2016-05-19: The offset of the first character of the sentence in the overall","parent_name":"SentenceAnalysis"},"Structs/SentenceAnalysis.html#/s:14ToneAnalyzerV316SentenceAnalysisV7inputToSiSgvp":{"name":"inputTo","abstract":"

    2017-09-21: Not returned. 2016-05-19: The offset of the last character of the sentence in the overall","parent_name":"SentenceAnalysis"},"Structs/DocumentAnalysis.html#/s:14ToneAnalyzerV316DocumentAnalysisV5tonesSayAA0A5ScoreVGSgvp":{"name":"tones","abstract":"

    2017-09-21: An array of ToneScore objects that provides the results of the analysis for each qualifying","parent_name":"DocumentAnalysis"},"Structs/DocumentAnalysis.html#/s:14ToneAnalyzerV316DocumentAnalysisV14toneCategoriesSayAA0A8CategoryVGSgvp":{"name":"toneCategories","abstract":"

    2017-09-21: Not returned. 2016-05-19: An array of ToneCategory objects that provides the results of","parent_name":"DocumentAnalysis"},"Structs/DocumentAnalysis.html#/s:14ToneAnalyzerV316DocumentAnalysisV7warningSSSgvp":{"name":"warning","abstract":"

    2017-09-21: A warning message if the overall content exceeds 128 KB or contains more than 1000 sentences. The","parent_name":"DocumentAnalysis"},"Structs/DocumentAnalysis.html":{"name":"DocumentAnalysis","abstract":"

    DocumentAnalysis.

    "},"Structs/SentenceAnalysis.html":{"name":"SentenceAnalysis","abstract":"

    SentenceAnalysis.

    "},"Structs/ToneAnalysis.html":{"name":"ToneAnalysis","abstract":"

    ToneAnalysis.

    "},"Structs/ToneCategory.html":{"name":"ToneCategory","abstract":"

    ToneCategory.

    "},"Structs/ToneChatInput.html":{"name":"ToneChatInput","abstract":"

    ToneChatInput.

    "},"Structs/ToneChatScore.html":{"name":"ToneChatScore","abstract":"

    ToneChatScore.

    "},"Structs/ToneInput.html":{"name":"ToneInput","abstract":"

    ToneInput.

    "},"Structs/ToneScore.html":{"name":"ToneScore","abstract":"

    ToneScore.

    "},"Structs/Utterance.html":{"name":"Utterance","abstract":"

    Utterance.

    "},"Structs/UtteranceAnalyses.html":{"name":"UtteranceAnalyses","abstract":"

    UtteranceAnalyses.

    "},"Structs/UtteranceAnalysis.html":{"name":"UtteranceAnalysis","abstract":"

    UtteranceAnalysis.

    "},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

    No response was received from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

    No data was returned from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO013serializationE0A2CmF":{"name":"serializationError","abstract":"

    Failed to serialize value(s) to data.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO08encodingE0A2CmF":{"name":"encodingError","abstract":"

    Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO011fileManagerE0A2CmF":{"name":"fileManagerError","abstract":"

    FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

    Failed to load the given file.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:14ToneAnalyzerV39RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

    An HTTP error with a status code and description.

    ","parent_name":"RestError"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO4nullA2CmF":{"name":"null","abstract":"

    A null value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

    A boolean value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO6stringACSScACmF":{"name":"string","abstract":"

    A string value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO3intACSicACmF":{"name":"int","abstract":"

    A number value, represented as an integer.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO6doubleACSdcACmF":{"name":"double","abstract":"

    A number value, represented as a double.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

    An array value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

    An object value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Decode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

    Initialize a JSON value from an encodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

    Convert this JSON value to a decodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

    Encode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:14ToneAnalyzerV34JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compare two JSON values for equality.

    ","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

    A JSON value (one of string, number, object, array, true, false, or null).

    "},"Enums/RestError.html":{"name":"RestError","abstract":"

    An error from processing a network request or response.

    "},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

    The base URL to use when contacting the service.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

    The default HTTP headers for all requests to the service.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0CACSS8username_SS8passwordSS7versiontcfc":{"name":"init(username:password:version:)","abstract":"

    Create a ToneAnalyzer object.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

    Create a ToneAnalyzer object.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

    Create a ToneAnalyzer object.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

    Undocumented

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C4toneyAA0A5InputV0dE0_SbSg9sentencesSaySSGSg5tonesSSSg15contentLanguageAM06acceptI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0A8AnalysisVc7successtF":{"name":"tone(toneInput:sentences:tones:contentLanguage:acceptLanguage:headers:failure:success:)","abstract":"

    Analyze general tone.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C4toneySS4text_SbSg9sentencesSaySSGSg5tonesSSSg15contentLanguageAK06acceptI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0A8AnalysisVc7successtF":{"name":"tone(text:sentences:tones:contentLanguage:acceptLanguage:headers:failure:success:)","abstract":"

    Analyze general tone.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C4toneySS4html_SbSg9sentencesSaySSGSg5tonesSSSg15contentLanguageAK06acceptI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0A8AnalysisVc7successtF":{"name":"tone(html:sentences:tones:contentLanguage:acceptLanguage:headers:failure:success:)","abstract":"

    Analyze general tone.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html#/s:14ToneAnalyzerV30aB0C8toneChatySayAA9UtteranceVG10utterances_SSSg15contentLanguageAI06acceptI0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0F8AnalysesVc7successtF":{"name":"toneChat(utterances:contentLanguage:acceptLanguage:headers:failure:success:)","abstract":"

    Analyze customer engagement tone.

    ","parent_name":"ToneAnalyzer"},"Classes/ToneAnalyzer.html":{"name":"ToneAnalyzer","abstract":"

    The IBM Watson™ Tone Analyzer service uses linguistic analysis to detect emotional and language tones in written"},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "}} \ No newline at end of file diff --git a/docs/swift-api/services/VisualRecognitionV3/Classes.html b/docs/swift-api/services/VisualRecognitionV3/Classes.html index 5aeb258f7..e7679e0c1 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Classes.html +++ b/docs/swift-api/services/VisualRecognitionV3/Classes.html @@ -98,9 +98,6 @@ - @@ -134,8 +131,8 @@

    Classes

    -

    The IBM Watson Visual Recognition service uses deep learning algorithms to identify scenes, objects, and faces in -images you upload to the service. You can create and train a custom classifier to identify subjects that suit your +

    The IBM Watson™ Visual Recognition service uses deep learning algorithms to identify scenes, objects, and faces +in images you upload to the service. You can create and train a custom classifier to identify subjects that suit your needs.

    See more @@ -156,7 +153,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Classes/VisualRecognition.html b/docs/swift-api/services/VisualRecognitionV3/Classes/VisualRecognition.html index cb8d84222..bae44a377 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Classes/VisualRecognition.html +++ b/docs/swift-api/services/VisualRecognitionV3/Classes/VisualRecognition.html @@ -98,9 +98,6 @@ - @@ -121,8 +118,8 @@

    VisualRecognition

    -

    The IBM Watson Visual Recognition service uses deep learning algorithms to identify scenes, objects, and faces in -images you upload to the service. You can create and train a custom classifier to identify subjects that suit your +

    The IBM Watson™ Visual Recognition service uses deep learning algorithms to identify scenes, objects, and faces +in images you upload to the service. You can create and train a custom classifier to identify subjects that suit your needs.

    @@ -416,11 +413,6 @@

    Declaration

    Classify images with built-in or custom classifiers.

    -
      -
    • food: (Beta) Enhances specificity and accuracy for images of food items. - explicit: (Beta) Evaluates whether -the image might be pornographic.
    • -
    -

    Declaration

    @@ -453,8 +445,8 @@

    Parameters

    An image file (.jpg, .png) or .zip file with images. Maximum image size is 10 MB. Include no more than 20 images and limit the .zip file to 100 MB. Encode the image and .zip file names in UTF-8 if they contain non-ASCII -characters. The service assumes UTF-8 encoding if it encounters non-ASCII characters. You can also include an -image with the url parameter.

    +characters. The service assumes UTF-8 encoding if it encounters non-ASCII characters. +You can also include an image with the url parameter.

    @@ -467,8 +459,9 @@

    Parameters

    The language of the output class names. The full set of languages is supported only for the built-in default -classifier ID. The class names of custom classifiers are not translated. The response might not be in the -specified language when the requested language is not supported or when there is no translation for the class name.

    +classifier ID. The class names of custom classifiers are not translated. +The response might not be in the specified language when the requested language is not supported or when there is +no translation for the class name.

    @@ -481,8 +474,8 @@

    Parameters

    The URL of an image to analyze. Must be in .jpg, or .png format. The minimum recommended pixel density is 32X32 -pixels per inch, and the maximum image size is 10 MB. You can also include images with the images_file -parameter.

    +pixels per inch, and the maximum image size is 10 MB. +You can also include images with the images_file parameter.

    @@ -508,10 +501,10 @@

    Parameters

    The categories of classifiers to apply. Use IBM to classify against the default general classifier, and use -me to classify against your custom classifiers. To analyze the image against both classifier categories, set the -value to both IBM and me. The built-in default classifier is used if both classifier_ids and owners -parameters are empty. The classifier_ids parameter overrides owners, so make sure that classifier_ids -is empty.

    +me to classify against your custom classifiers. To analyze the image against both classifier categories, set +the value to both IBM and me. +The built-in default classifier is used if both classifier_ids and owners parameters are empty. +The classifier_ids parameter overrides owners, so make sure that classifier_ids is empty.

    @@ -523,9 +516,16 @@

    Parameters

    -

    Which classifiers to apply. Overrides the owners parameter. You can specify both custom and built-in classifier -IDs. The built-in default classifier is used if both classifier_ids and owners parameters are empty. The -following built-in classifier IDs require no training: - default: Returns classes from thousands of general tags.

    +

    Which classifiers to apply. Overrides the owners parameter. You can specify both custom and built-in +classifier IDs. The built-in default classifier is used if both classifier_ids and owners parameters +are empty. +The following built-in classifier IDs require no training: + +

      +
    • default: Returns classes from thousands of general tags.
    • +
    • food: (Beta) Enhances specificity and accuracy for images of food items.
    • +
    • explicit: (Beta) Evaluates whether the image might be pornographic.
    • +

    @@ -601,9 +601,10 @@

    Parameters

    Important: On April 2, 2018, the identity information in the response to calls to the Face model was removed. The identity information refers to the name of the person, score, and type_hierarchy knowledge graph. For details about the enhanced Face model, see the Release -notes. Analyze and -get data about faces in images. Responses can include estimated age and gender. This feature uses a built-in model, -so no training is necessary. The Detect faces method does not support general biometric facial recognition. +notes. +Analyze and get data about faces in images. Responses can include estimated age and gender. This feature uses a +built-in model, so no training is necessary. The Detect faces method does not support general biometric facial +recognition. Supported image formats include .gif, .jpg, .png, and .tif. The maximum image size is 10 MB. The minimum recommended pixel density is 32X32 pixels per inch.

    @@ -634,9 +635,10 @@

    Parameters

    An image file (gif, .jpg, .png, .tif.) or .zip file with images. Limit the .zip file to 100 MB. You can include a -maximum of 15 images in a request. Encode the image and .zip file names in UTF-8 if they contain non-ASCII -characters. The service assumes UTF-8 encoding if it encounters non-ASCII characters. You can also include an -image with the url parameter.

    +maximum of 15 images in a request. +Encode the image and .zip file names in UTF-8 if they contain non-ASCII characters. The service assumes UTF-8 +encoding if it encounters non-ASCII characters. +You can also include an image with the url parameter.

    @@ -648,9 +650,22 @@

    Parameters

    -

    The URL of an image to analyze. Must be in .gif, .jpg, .png, or .tif format. The minimum recommended pixel density -is 32X32 pixels per inch, and the maximum image size is 10 MB. Redirects are followed, so you can use a shortened -URL. You can also include images with the images_file parameter.

    +

    The URL of an image to analyze. Must be in .gif, .jpg, .png, or .tif format. The minimum recommended pixel +density is 32X32 pixels per inch, and the maximum image size is 10 MB. Redirects are followed, so you can use a +shortened URL. +You can also include images with the images_file parameter.

    +
    + + + + + + imagesFileContentType + + + +
    +

    The content type of imagesFile.

    @@ -713,9 +728,9 @@

    Parameters

    Train a new multi-faceted classifier on the uploaded image data. Create your custom classifier with positive or negative examples. Include at least two sets of examples, either two positive example files or one positive and one -negative file. You can upload a maximum of 256 MB per call. Encode all names in UTF-8 if they contain non-ASCII -characters (.zip and image file names, and classifier and class names). The service assumes UTF-8 encoding if it -encounters non-ASCII characters.

    +negative file. You can upload a maximum of 256 MB per call. +Encode all names in UTF-8 if they contain non-ASCII characters (.zip and image file names, and classifier and class +names). The service assumes UTF-8 encoding if it encounters non-ASCII characters.

    @@ -756,10 +771,12 @@

    Parameters

    -

    An array of positive examples, each with a name and a compressed -(.zip) file of images that depict the visual subject for a class within the new classifier. Include at least -10 images in .jpg or .png format. The minimum recommended image resolution is 32X32 pixels. The maximum number -of images is 10,000 images or 100 MB per .zip file.

    +

    An array of of positive examples, each with a name and a compressed +(.zip) file of images that depict the visual subject of a class in the new classifier. You can include more than +one positive example file in a call. +Include at least 10 images in .jpg or .png format. The minimum recommended image resolution is 32X32 pixels. The +maximum number of images is 10,000 images or 100 MB per .zip file. +Encode special characters in the file name in UTF-8.

    @@ -772,7 +789,8 @@

    Parameters

    A .zip file of images that do not depict the visual subject of any of the classes of the new classifier. Must -contain a minimum of 10 images. Encode special characters in the file name in UTF-8.

    +contain a minimum of 10 images. +Encode special characters in the file name in UTF-8.

    @@ -871,7 +889,8 @@

    Parameters

    -

    Specify true to return details about the classifiers. Omit this parameter to return a brief list of classifiers.

    +

    Specify true to return details about the classifiers. Omit this parameter to return a brief list of +classifiers.

    @@ -1024,11 +1043,11 @@

    Parameters

    existing classes. You must supply at least one set of positive or negative examples. For details, see Updating custom classifiers. - Encode all names in UTF-8 if they contain non-ASCII characters (.zip and image file names, and classifier and -class names). The service assumes UTF-8 encoding if it encounters non-ASCII characters. Tip: Don’t make -retraining calls on a classifier until the status is ready. When you submit retraining requests in parallel, the -last request overwrites the previous requests. The retrained property shows the last time the classifier retraining -finished.

    +Encode all names in UTF-8 if they contain non-ASCII characters (.zip and image file names, and classifier and class +names). The service assumes UTF-8 encoding if it encounters non-ASCII characters. +Tip: Don’t make retraining calls on a classifier until the status is ready. When you submit retraining requests +in parallel, the last request overwrites the previous requests. The retrained property shows the last time the +classifier retraining finished.

    @@ -1070,9 +1089,11 @@

    Parameters

    An array of positive examples, each with a name and a compressed -(.zip) file of images that depict the visual subject for a class within the new classifier. Include at least -10 images in .jpg or .png format. The minimum recommended image resolution is 32X32 pixels. The maximum number -of images is 10,000 images or 100 MB per .zip file.

    +(.zip) file of images that depict the visual subject of a class in the classifier. The positive examples create +or update classes in the classifier. You can include more than one positive example file in a call. +Include at least 10 images in .jpg or .png format. The minimum recommended image resolution is 32X32 pixels. The +maximum number of images is 10,000 images or 100 MB per .zip file. +Encode special characters in the file name in UTF-8.

    @@ -1085,7 +1106,8 @@

    Parameters

    A .zip file of images that do not depict the visual subject of any of the classes of the new classifier. Must -contain a minimum of 10 images. Encode special characters in the file name in UTF-8.

    +contain a minimum of 10 images. +Encode special characters in the file name in UTF-8.

    @@ -1322,8 +1344,9 @@

    Parameters

    Delete labeled data.

    Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with -the customer ID. You associate a customer ID with data by passing the X-Watson-Metadata header with a request -that passes data. For more information about personal data and customer IDs, see Information +the customer ID. +You associate a customer ID with data by passing the X-Watson-Metadata header with a request that passes data. +For more information about personal data and customer IDs, see Information security.

    @@ -1971,7 +1994,7 @@

    Parameters

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Enums.html b/docs/swift-api/services/VisualRecognitionV3/Enums.html index 711c91066..d03371643 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Enums.html +++ b/docs/swift-api/services/VisualRecognitionV3/Enums.html @@ -98,9 +98,6 @@ - @@ -186,7 +183,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Enums/JSON.html b/docs/swift-api/services/VisualRecognitionV3/Enums/JSON.html index 893189209..1505018eb 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Enums/JSON.html +++ b/docs/swift-api/services/VisualRecognitionV3/Enums/JSON.html @@ -98,9 +98,6 @@ - @@ -456,7 +453,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Enums/RestError.html b/docs/swift-api/services/VisualRecognitionV3/Enums/RestError.html index 4622505d7..494847dbc 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Enums/RestError.html +++ b/docs/swift-api/services/VisualRecognitionV3/Enums/RestError.html @@ -98,9 +98,6 @@ - @@ -323,7 +320,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Structs.html b/docs/swift-api/services/VisualRecognitionV3/Structs.html index 96c75c0bf..22f9787fb 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Structs.html +++ b/docs/swift-api/services/VisualRecognitionV3/Structs.html @@ -98,9 +98,6 @@ - @@ -119,45 +116,6 @@

    Structures

    -
    -
    - - - -

    JSON

    -
    -
    -
      -
    • -
      - - - - JSONWrapper - -
      -
      -
      -
      -
      -
      -

      Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public struct JSONWrapper
      - -
      -
      -
      -
      -
    • -
    -
    • @@ -705,7 +663,7 @@

      Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Structs/Class.html b/docs/swift-api/services/VisualRecognitionV3/Structs/Class.html index 2384d7f33..25fb3350b 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Structs/Class.html +++ b/docs/swift-api/services/VisualRecognitionV3/Structs/Class.html @@ -98,9 +98,6 @@ - @@ -159,7 +156,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Structs/ClassResult.html b/docs/swift-api/services/VisualRecognitionV3/Structs/ClassResult.html index b0393e0ce..f0634fc5c 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Structs/ClassResult.html +++ b/docs/swift-api/services/VisualRecognitionV3/Structs/ClassResult.html @@ -98,9 +98,6 @@ - @@ -167,7 +164,8 @@

    Declaration

    -

    Confidence score for the property in the range of 0 to 1. A higher score indicates greater likelihood that the class is depicted in the image. The default threshold for returning scores from a classifier is 0.5.

    +

    Confidence score for the property in the range of 0 to 1. A higher score indicates greater likelihood that the +class is depicted in the image. The default threshold for returning scores from a classifier is 0.5.

    @@ -194,7 +192,8 @@

    Declaration

    -

    Knowledge graph of the property. For example, /fruit/pome/apple/eating apple/Granny Smith. Included only if identified.

    +

    Knowledge graph of the property. For example, /fruit/pome/apple/eating apple/Granny Smith. Included only if +identified.

    @@ -213,7 +212,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Structs/ClassifiedImage.html b/docs/swift-api/services/VisualRecognitionV3/Structs/ClassifiedImage.html index 2bdaf8f35..090747ef0 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Structs/ClassifiedImage.html +++ b/docs/swift-api/services/VisualRecognitionV3/Structs/ClassifiedImage.html @@ -98,9 +98,6 @@ - @@ -221,7 +218,8 @@

    Declaration

    -

    Information about what might have caused a failure, such as an image that is too large. Not returned when there is no error.

    +

    Information about what might have caused a failure, such as an image that is too large. Not returned when there is +no error.

    @@ -267,7 +265,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Structs/ClassifiedImages.html b/docs/swift-api/services/VisualRecognitionV3/Structs/ClassifiedImages.html index d776fed53..587589292 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Structs/ClassifiedImages.html +++ b/docs/swift-api/services/VisualRecognitionV3/Structs/ClassifiedImages.html @@ -98,9 +98,6 @@ - @@ -221,7 +218,9 @@

    Declaration

    -

    Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file and a list of image URLs will still complete, but does not return the expected output. Not returned when there is no warning.

    +

    Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file +and a list of image URLs will still complete, but does not return the expected output. Not returned when there is +no warning.

    @@ -240,7 +239,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Structs/Classifier.html b/docs/swift-api/services/VisualRecognitionV3/Structs/Classifier.html index 50685be67..43d4a6a36 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Structs/Classifier.html +++ b/docs/swift-api/services/VisualRecognitionV3/Structs/Classifier.html @@ -98,9 +98,6 @@ - @@ -222,7 +219,8 @@

    Declaration

    -

    Unique ID of the account who owns the classifier. Returned when verbose=true. Might not be returned by some requests.

    +

    Unique ID of the account who owns the classifier. Returned when verbose=true. Might not be returned by some +requests.

    @@ -266,9 +264,9 @@

    Declaration

  • @@ -283,7 +281,7 @@

    Declaration

    Declaration

    Swift

    -
    public var coreMlEnabled: Bool
    +
    public var coreMlEnabled: Bool?
    @@ -384,7 +382,8 @@

    Declaration

    -

    Date and time in Coordinated Universal Time (UTC) that the classifier was updated. Returned when verbose=true. Might not be returned by some requests. Identical to updated and retained for backward compatibility.

    +

    Date and time in Coordinated Universal Time (UTC) that the classifier was updated. Returned when verbose=true. +Might not be returned by some requests. Identical to updated and retained for backward compatibility.

    @@ -411,7 +410,8 @@

    Declaration

    -

    Date and time in Coordinated Universal Time (UTC) that the classifier was most recently updated. The field matches either retrained or created. Returned when verbose=true. Might not be returned by some requests.

    +

    Date and time in Coordinated Universal Time (UTC) that the classifier was most recently updated. The field matches +either retrained or created. Returned when verbose=true. Might not be returned by some requests.

    @@ -430,7 +430,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Structs/Classifier/Status.html b/docs/swift-api/services/VisualRecognitionV3/Structs/Classifier/Status.html index c84a2832e..a26332421 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Structs/Classifier/Status.html +++ b/docs/swift-api/services/VisualRecognitionV3/Structs/Classifier/Status.html @@ -98,9 +98,6 @@
  • - @@ -240,7 +237,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Structs/ClassifierResult.html b/docs/swift-api/services/VisualRecognitionV3/Structs/ClassifierResult.html index e20d49af6..d1a3c8de9 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Structs/ClassifierResult.html +++ b/docs/swift-api/services/VisualRecognitionV3/Structs/ClassifierResult.html @@ -98,9 +98,6 @@ - @@ -213,7 +210,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Structs/Classifiers.html b/docs/swift-api/services/VisualRecognitionV3/Structs/Classifiers.html index 314f60619..5ceaca849 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Structs/Classifiers.html +++ b/docs/swift-api/services/VisualRecognitionV3/Structs/Classifiers.html @@ -98,9 +98,6 @@ - @@ -159,7 +156,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Structs/DetectedFaces.html b/docs/swift-api/services/VisualRecognitionV3/Structs/DetectedFaces.html index 299ad7bba..6e503dc36 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Structs/DetectedFaces.html +++ b/docs/swift-api/services/VisualRecognitionV3/Structs/DetectedFaces.html @@ -98,9 +98,6 @@ - @@ -194,7 +191,9 @@

    Declaration

    -

    Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file and a list of image URLs will still complete, but does not return the expected output. Not returned when there is no warning.

    +

    Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file +and a list of image URLs will still complete, but does not return the expected output. Not returned when there is +no warning.

    @@ -213,7 +212,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Structs/ErrorInfo.html b/docs/swift-api/services/VisualRecognitionV3/Structs/ErrorInfo.html index ea009301c..c283f2ac4 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Structs/ErrorInfo.html +++ b/docs/swift-api/services/VisualRecognitionV3/Structs/ErrorInfo.html @@ -98,9 +98,6 @@ - @@ -213,7 +210,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Structs/Face.html b/docs/swift-api/services/VisualRecognitionV3/Structs/Face.html index 9a51bed12..017ee8083 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Structs/Face.html +++ b/docs/swift-api/services/VisualRecognitionV3/Structs/Face.html @@ -98,9 +98,6 @@ - @@ -221,7 +218,7 @@

    Declaration

    -

    Undocumented

    +

    deprecated

    @@ -240,7 +237,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Structs/FaceAge.html b/docs/swift-api/services/VisualRecognitionV3/Structs/FaceAge.html index 51bed32c3..61cfcd3f5 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Structs/FaceAge.html +++ b/docs/swift-api/services/VisualRecognitionV3/Structs/FaceAge.html @@ -98,9 +98,6 @@ - @@ -194,7 +191,8 @@

    Declaration

    -

    Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the property.

    +

    Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the +property.

    @@ -213,7 +211,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Structs/FaceGender.html b/docs/swift-api/services/VisualRecognitionV3/Structs/FaceGender.html index 2ac0d9aba..c63fa3a66 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Structs/FaceGender.html +++ b/docs/swift-api/services/VisualRecognitionV3/Structs/FaceGender.html @@ -98,9 +98,6 @@ - @@ -167,7 +164,8 @@

    Declaration

    -

    Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the property.

    +

    Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the +property.

    @@ -186,7 +184,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Structs/FaceIdentity.html b/docs/swift-api/services/VisualRecognitionV3/Structs/FaceIdentity.html index 2843b45ea..b15253b1c 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Structs/FaceIdentity.html +++ b/docs/swift-api/services/VisualRecognitionV3/Structs/FaceIdentity.html @@ -98,9 +98,6 @@ - @@ -343,7 +340,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Structs/FaceLocation.html b/docs/swift-api/services/VisualRecognitionV3/Structs/FaceLocation.html index 5db74672b..42261b055 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Structs/FaceLocation.html +++ b/docs/swift-api/services/VisualRecognitionV3/Structs/FaceLocation.html @@ -98,9 +98,6 @@ - @@ -240,7 +237,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Structs/ImageWithFaces.html b/docs/swift-api/services/VisualRecognitionV3/Structs/ImageWithFaces.html index 5e352b608..e9985a8f5 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Structs/ImageWithFaces.html +++ b/docs/swift-api/services/VisualRecognitionV3/Structs/ImageWithFaces.html @@ -98,9 +98,6 @@ - @@ -248,7 +245,8 @@

    Declaration

    -

    Information about what might have caused a failure, such as an image that is too large. Not returned when there is no error.

    +

    Information about what might have caused a failure, such as an image that is too large. Not returned when there is +no error.

    @@ -267,7 +265,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Structs/PositiveExample.html b/docs/swift-api/services/VisualRecognitionV3/Structs/PositiveExample.html index 525418fdf..612820d83 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Structs/PositiveExample.html +++ b/docs/swift-api/services/VisualRecognitionV3/Structs/PositiveExample.html @@ -98,9 +98,6 @@ - @@ -246,7 +243,7 @@

    Parameters

    diff --git a/docs/swift-api/services/VisualRecognitionV3/Structs/WarningInfo.html b/docs/swift-api/services/VisualRecognitionV3/Structs/WarningInfo.html index 7c2a5ab14..5c2ab07d8 100644 --- a/docs/swift-api/services/VisualRecognitionV3/Structs/WarningInfo.html +++ b/docs/swift-api/services/VisualRecognitionV3/Structs/WarningInfo.html @@ -98,9 +98,6 @@ - @@ -186,7 +183,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Classes.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Classes.html index 5aeb258f7..e7679e0c1 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Classes.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Classes.html @@ -98,9 +98,6 @@ - @@ -134,8 +131,8 @@

    Classes

    -

    The IBM Watson Visual Recognition service uses deep learning algorithms to identify scenes, objects, and faces in -images you upload to the service. You can create and train a custom classifier to identify subjects that suit your +

    The IBM Watson™ Visual Recognition service uses deep learning algorithms to identify scenes, objects, and faces +in images you upload to the service. You can create and train a custom classifier to identify subjects that suit your needs.

    See more @@ -156,7 +153,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Classes/VisualRecognition.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Classes/VisualRecognition.html index cb8d84222..bae44a377 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Classes/VisualRecognition.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Classes/VisualRecognition.html @@ -98,9 +98,6 @@ - @@ -121,8 +118,8 @@

    VisualRecognition

    -

    The IBM Watson Visual Recognition service uses deep learning algorithms to identify scenes, objects, and faces in -images you upload to the service. You can create and train a custom classifier to identify subjects that suit your +

    The IBM Watson™ Visual Recognition service uses deep learning algorithms to identify scenes, objects, and faces +in images you upload to the service. You can create and train a custom classifier to identify subjects that suit your needs.

    @@ -416,11 +413,6 @@

    Declaration

    Classify images with built-in or custom classifiers.

    -
      -
    • food: (Beta) Enhances specificity and accuracy for images of food items. - explicit: (Beta) Evaluates whether -the image might be pornographic.
    • -
    -

    Declaration

    @@ -453,8 +445,8 @@

    Parameters

    An image file (.jpg, .png) or .zip file with images. Maximum image size is 10 MB. Include no more than 20 images and limit the .zip file to 100 MB. Encode the image and .zip file names in UTF-8 if they contain non-ASCII -characters. The service assumes UTF-8 encoding if it encounters non-ASCII characters. You can also include an -image with the url parameter.

    +characters. The service assumes UTF-8 encoding if it encounters non-ASCII characters. +You can also include an image with the url parameter.

    @@ -467,8 +459,9 @@

    Parameters

    The language of the output class names. The full set of languages is supported only for the built-in default -classifier ID. The class names of custom classifiers are not translated. The response might not be in the -specified language when the requested language is not supported or when there is no translation for the class name.

    +classifier ID. The class names of custom classifiers are not translated. +The response might not be in the specified language when the requested language is not supported or when there is +no translation for the class name.

    @@ -481,8 +474,8 @@

    Parameters

    The URL of an image to analyze. Must be in .jpg, or .png format. The minimum recommended pixel density is 32X32 -pixels per inch, and the maximum image size is 10 MB. You can also include images with the images_file -parameter.

    +pixels per inch, and the maximum image size is 10 MB. +You can also include images with the images_file parameter.

    @@ -508,10 +501,10 @@

    Parameters

    The categories of classifiers to apply. Use IBM to classify against the default general classifier, and use -me to classify against your custom classifiers. To analyze the image against both classifier categories, set the -value to both IBM and me. The built-in default classifier is used if both classifier_ids and owners -parameters are empty. The classifier_ids parameter overrides owners, so make sure that classifier_ids -is empty.

    +me to classify against your custom classifiers. To analyze the image against both classifier categories, set +the value to both IBM and me. +The built-in default classifier is used if both classifier_ids and owners parameters are empty. +The classifier_ids parameter overrides owners, so make sure that classifier_ids is empty.

    @@ -523,9 +516,16 @@

    Parameters

    -

    Which classifiers to apply. Overrides the owners parameter. You can specify both custom and built-in classifier -IDs. The built-in default classifier is used if both classifier_ids and owners parameters are empty. The -following built-in classifier IDs require no training: - default: Returns classes from thousands of general tags.

    +

    Which classifiers to apply. Overrides the owners parameter. You can specify both custom and built-in +classifier IDs. The built-in default classifier is used if both classifier_ids and owners parameters +are empty. +The following built-in classifier IDs require no training: + +

      +
    • default: Returns classes from thousands of general tags.
    • +
    • food: (Beta) Enhances specificity and accuracy for images of food items.
    • +
    • explicit: (Beta) Evaluates whether the image might be pornographic.
    • +

    @@ -601,9 +601,10 @@

    Parameters

    Important: On April 2, 2018, the identity information in the response to calls to the Face model was removed. The identity information refers to the name of the person, score, and type_hierarchy knowledge graph. For details about the enhanced Face model, see the Release -notes. Analyze and -get data about faces in images. Responses can include estimated age and gender. This feature uses a built-in model, -so no training is necessary. The Detect faces method does not support general biometric facial recognition. +notes. +Analyze and get data about faces in images. Responses can include estimated age and gender. This feature uses a +built-in model, so no training is necessary. The Detect faces method does not support general biometric facial +recognition. Supported image formats include .gif, .jpg, .png, and .tif. The maximum image size is 10 MB. The minimum recommended pixel density is 32X32 pixels per inch.

    @@ -634,9 +635,10 @@

    Parameters

    An image file (gif, .jpg, .png, .tif.) or .zip file with images. Limit the .zip file to 100 MB. You can include a -maximum of 15 images in a request. Encode the image and .zip file names in UTF-8 if they contain non-ASCII -characters. The service assumes UTF-8 encoding if it encounters non-ASCII characters. You can also include an -image with the url parameter.

    +maximum of 15 images in a request. +Encode the image and .zip file names in UTF-8 if they contain non-ASCII characters. The service assumes UTF-8 +encoding if it encounters non-ASCII characters. +You can also include an image with the url parameter.

    @@ -648,9 +650,22 @@

    Parameters

    -

    The URL of an image to analyze. Must be in .gif, .jpg, .png, or .tif format. The minimum recommended pixel density -is 32X32 pixels per inch, and the maximum image size is 10 MB. Redirects are followed, so you can use a shortened -URL. You can also include images with the images_file parameter.

    +

    The URL of an image to analyze. Must be in .gif, .jpg, .png, or .tif format. The minimum recommended pixel +density is 32X32 pixels per inch, and the maximum image size is 10 MB. Redirects are followed, so you can use a +shortened URL. +You can also include images with the images_file parameter.

    +
    + + + + + + imagesFileContentType + + + +
    +

    The content type of imagesFile.

    @@ -713,9 +728,9 @@

    Parameters

    Train a new multi-faceted classifier on the uploaded image data. Create your custom classifier with positive or negative examples. Include at least two sets of examples, either two positive example files or one positive and one -negative file. You can upload a maximum of 256 MB per call. Encode all names in UTF-8 if they contain non-ASCII -characters (.zip and image file names, and classifier and class names). The service assumes UTF-8 encoding if it -encounters non-ASCII characters.

    +negative file. You can upload a maximum of 256 MB per call. +Encode all names in UTF-8 if they contain non-ASCII characters (.zip and image file names, and classifier and class +names). The service assumes UTF-8 encoding if it encounters non-ASCII characters.

    @@ -756,10 +771,12 @@

    Parameters

    -

    An array of positive examples, each with a name and a compressed -(.zip) file of images that depict the visual subject for a class within the new classifier. Include at least -10 images in .jpg or .png format. The minimum recommended image resolution is 32X32 pixels. The maximum number -of images is 10,000 images or 100 MB per .zip file.

    +

    An array of of positive examples, each with a name and a compressed +(.zip) file of images that depict the visual subject of a class in the new classifier. You can include more than +one positive example file in a call. +Include at least 10 images in .jpg or .png format. The minimum recommended image resolution is 32X32 pixels. The +maximum number of images is 10,000 images or 100 MB per .zip file. +Encode special characters in the file name in UTF-8.

    @@ -772,7 +789,8 @@

    Parameters

    A .zip file of images that do not depict the visual subject of any of the classes of the new classifier. Must -contain a minimum of 10 images. Encode special characters in the file name in UTF-8.

    +contain a minimum of 10 images. +Encode special characters in the file name in UTF-8.

    @@ -871,7 +889,8 @@

    Parameters

    -

    Specify true to return details about the classifiers. Omit this parameter to return a brief list of classifiers.

    +

    Specify true to return details about the classifiers. Omit this parameter to return a brief list of +classifiers.

    @@ -1024,11 +1043,11 @@

    Parameters

    existing classes. You must supply at least one set of positive or negative examples. For details, see Updating custom classifiers. - Encode all names in UTF-8 if they contain non-ASCII characters (.zip and image file names, and classifier and -class names). The service assumes UTF-8 encoding if it encounters non-ASCII characters. Tip: Don’t make -retraining calls on a classifier until the status is ready. When you submit retraining requests in parallel, the -last request overwrites the previous requests. The retrained property shows the last time the classifier retraining -finished.

    +Encode all names in UTF-8 if they contain non-ASCII characters (.zip and image file names, and classifier and class +names). The service assumes UTF-8 encoding if it encounters non-ASCII characters. +Tip: Don’t make retraining calls on a classifier until the status is ready. When you submit retraining requests +in parallel, the last request overwrites the previous requests. The retrained property shows the last time the +classifier retraining finished.

    @@ -1070,9 +1089,11 @@

    Parameters

    An array of positive examples, each with a name and a compressed -(.zip) file of images that depict the visual subject for a class within the new classifier. Include at least -10 images in .jpg or .png format. The minimum recommended image resolution is 32X32 pixels. The maximum number -of images is 10,000 images or 100 MB per .zip file.

    +(.zip) file of images that depict the visual subject of a class in the classifier. The positive examples create +or update classes in the classifier. You can include more than one positive example file in a call. +Include at least 10 images in .jpg or .png format. The minimum recommended image resolution is 32X32 pixels. The +maximum number of images is 10,000 images or 100 MB per .zip file. +Encode special characters in the file name in UTF-8.

    @@ -1085,7 +1106,8 @@

    Parameters

    A .zip file of images that do not depict the visual subject of any of the classes of the new classifier. Must -contain a minimum of 10 images. Encode special characters in the file name in UTF-8.

    +contain a minimum of 10 images. +Encode special characters in the file name in UTF-8.

    @@ -1322,8 +1344,9 @@

    Parameters

    Delete labeled data.

    Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with -the customer ID. You associate a customer ID with data by passing the X-Watson-Metadata header with a request -that passes data. For more information about personal data and customer IDs, see Information +the customer ID. +You associate a customer ID with data by passing the X-Watson-Metadata header with a request that passes data. +For more information about personal data and customer IDs, see Information security.

    @@ -1971,7 +1994,7 @@

    Parameters

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Enums.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Enums.html index 711c91066..d03371643 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Enums.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Enums.html @@ -98,9 +98,6 @@ - @@ -186,7 +183,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html index 893189209..1505018eb 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Enums/JSON.html @@ -98,9 +98,6 @@ - @@ -456,7 +453,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html index 4622505d7..494847dbc 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Enums/RestError.html @@ -98,9 +98,6 @@ - @@ -323,7 +320,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs.html index 96c75c0bf..22f9787fb 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs.html @@ -98,9 +98,6 @@ - @@ -119,45 +116,6 @@

    Structures

    -
    -
    - - - -

    JSON

    -
    -
    -
      -
    • -
      - - - - JSONWrapper - -
      -
      -
      -
      -
      -
      -

      Used internally to serialize and deserialize JSON. -Will soon be removed in favor of Swift 4’s Codable protocol.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public struct JSONWrapper
      - -
      -
      -
      -
      -
    • -
    -
    • @@ -705,7 +663,7 @@

      Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/Class.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/Class.html index 2384d7f33..25fb3350b 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/Class.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/Class.html @@ -98,9 +98,6 @@ - @@ -159,7 +156,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ClassResult.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ClassResult.html index b0393e0ce..f0634fc5c 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ClassResult.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ClassResult.html @@ -98,9 +98,6 @@ - @@ -167,7 +164,8 @@

    Declaration

    -

    Confidence score for the property in the range of 0 to 1. A higher score indicates greater likelihood that the class is depicted in the image. The default threshold for returning scores from a classifier is 0.5.

    +

    Confidence score for the property in the range of 0 to 1. A higher score indicates greater likelihood that the +class is depicted in the image. The default threshold for returning scores from a classifier is 0.5.

    @@ -194,7 +192,8 @@

    Declaration

    -

    Knowledge graph of the property. For example, /fruit/pome/apple/eating apple/Granny Smith. Included only if identified.

    +

    Knowledge graph of the property. For example, /fruit/pome/apple/eating apple/Granny Smith. Included only if +identified.

    @@ -213,7 +212,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ClassifiedImage.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ClassifiedImage.html index 2bdaf8f35..090747ef0 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ClassifiedImage.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ClassifiedImage.html @@ -98,9 +98,6 @@ - @@ -221,7 +218,8 @@

    Declaration

    -

    Information about what might have caused a failure, such as an image that is too large. Not returned when there is no error.

    +

    Information about what might have caused a failure, such as an image that is too large. Not returned when there is +no error.

    @@ -267,7 +265,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ClassifiedImages.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ClassifiedImages.html index d776fed53..587589292 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ClassifiedImages.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ClassifiedImages.html @@ -98,9 +98,6 @@ - @@ -221,7 +218,9 @@

    Declaration

    -

    Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file and a list of image URLs will still complete, but does not return the expected output. Not returned when there is no warning.

    +

    Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file +and a list of image URLs will still complete, but does not return the expected output. Not returned when there is +no warning.

    @@ -240,7 +239,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/Classifier.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/Classifier.html index 50685be67..43d4a6a36 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/Classifier.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/Classifier.html @@ -98,9 +98,6 @@ - @@ -222,7 +219,8 @@

    Declaration

    -

    Unique ID of the account who owns the classifier. Returned when verbose=true. Might not be returned by some requests.

    +

    Unique ID of the account who owns the classifier. Returned when verbose=true. Might not be returned by some +requests.

    @@ -266,9 +264,9 @@

    Declaration

  • @@ -283,7 +281,7 @@

    Declaration

    Declaration

    Swift

    -
    public var coreMlEnabled: Bool
    +
    public var coreMlEnabled: Bool?
    @@ -384,7 +382,8 @@

    Declaration

    -

    Date and time in Coordinated Universal Time (UTC) that the classifier was updated. Returned when verbose=true. Might not be returned by some requests. Identical to updated and retained for backward compatibility.

    +

    Date and time in Coordinated Universal Time (UTC) that the classifier was updated. Returned when verbose=true. +Might not be returned by some requests. Identical to updated and retained for backward compatibility.

    @@ -411,7 +410,8 @@

    Declaration

    -

    Date and time in Coordinated Universal Time (UTC) that the classifier was most recently updated. The field matches either retrained or created. Returned when verbose=true. Might not be returned by some requests.

    +

    Date and time in Coordinated Universal Time (UTC) that the classifier was most recently updated. The field matches +either retrained or created. Returned when verbose=true. Might not be returned by some requests.

    @@ -430,7 +430,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/Classifier/Status.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/Classifier/Status.html index c84a2832e..a26332421 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/Classifier/Status.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/Classifier/Status.html @@ -98,9 +98,6 @@
  • - @@ -240,7 +237,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ClassifierResult.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ClassifierResult.html index e20d49af6..d1a3c8de9 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ClassifierResult.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ClassifierResult.html @@ -98,9 +98,6 @@ - @@ -213,7 +210,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/Classifiers.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/Classifiers.html index 314f60619..5ceaca849 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/Classifiers.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/Classifiers.html @@ -98,9 +98,6 @@ - @@ -159,7 +156,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/DetectedFaces.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/DetectedFaces.html index 299ad7bba..6e503dc36 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/DetectedFaces.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/DetectedFaces.html @@ -98,9 +98,6 @@ - @@ -194,7 +191,9 @@

    Declaration

    -

    Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file and a list of image URLs will still complete, but does not return the expected output. Not returned when there is no warning.

    +

    Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file +and a list of image URLs will still complete, but does not return the expected output. Not returned when there is +no warning.

    @@ -213,7 +212,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ErrorInfo.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ErrorInfo.html index ea009301c..c283f2ac4 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ErrorInfo.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ErrorInfo.html @@ -98,9 +98,6 @@ - @@ -213,7 +210,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/Face.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/Face.html index 9a51bed12..017ee8083 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/Face.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/Face.html @@ -98,9 +98,6 @@ - @@ -221,7 +218,7 @@

    Declaration

    -

    Undocumented

    +

    deprecated

    @@ -240,7 +237,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/FaceAge.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/FaceAge.html index 51bed32c3..61cfcd3f5 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/FaceAge.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/FaceAge.html @@ -98,9 +98,6 @@ - @@ -194,7 +191,8 @@

    Declaration

    -

    Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the property.

    +

    Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the +property.

    @@ -213,7 +211,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/FaceGender.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/FaceGender.html index 2ac0d9aba..c63fa3a66 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/FaceGender.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/FaceGender.html @@ -98,9 +98,6 @@ - @@ -167,7 +164,8 @@

    Declaration

    -

    Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the property.

    +

    Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the +property.

    @@ -186,7 +184,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/FaceIdentity.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/FaceIdentity.html index 2843b45ea..b15253b1c 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/FaceIdentity.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/FaceIdentity.html @@ -98,9 +98,6 @@ - @@ -343,7 +340,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/FaceLocation.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/FaceLocation.html index 5db74672b..42261b055 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/FaceLocation.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/FaceLocation.html @@ -98,9 +98,6 @@ - @@ -240,7 +237,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ImageWithFaces.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ImageWithFaces.html index 5e352b608..e9985a8f5 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ImageWithFaces.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/ImageWithFaces.html @@ -98,9 +98,6 @@ - @@ -248,7 +245,8 @@

    Declaration

    -

    Information about what might have caused a failure, such as an image that is too large. Not returned when there is no error.

    +

    Information about what might have caused a failure, such as an image that is too large. Not returned when there is +no error.

    @@ -267,7 +265,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/PositiveExample.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/PositiveExample.html index 525418fdf..612820d83 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/PositiveExample.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/PositiveExample.html @@ -98,9 +98,6 @@ - @@ -246,7 +243,7 @@

    Parameters

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/WarningInfo.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/WarningInfo.html index 7c2a5ab14..5c2ab07d8 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/WarningInfo.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/Structs/WarningInfo.html @@ -98,9 +98,6 @@ - @@ -186,7 +183,7 @@

    Declaration

    diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/index.html b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/index.html index d3e7524a4..284cd8061 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/index.html +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/index.html @@ -97,9 +97,6 @@ - @@ -154,7 +151,8 @@

    Services

    • Assistant
    • Discovery
    • -
    • Language Translator
    • +
    • Language Translator V2
    • +
    • Language Translator V3
    • Natural Language Classifier
    • Natural Language Understanding
    • Personality Insights
    • @@ -199,7 +197,7 @@

      Swift Package Manager

      Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

      dependencies: [
      -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
      +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
       ]
       

      Service Instances

      @@ -242,7 +240,7 @@

      Username and Password

      API Key

      -

      Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

      +

      Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

      let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
       

      Using IAM

      @@ -477,7 +475,12 @@

      Private Data Collections

    • IBM Discovery - Documentation
    • IBM Discovery - Demo
    -

    Language Translator

    +

    Language Translator V2

    + +

    Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

    The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

    @@ -488,6 +491,25 @@

    Language Translator

    let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} + +

    Language Translator V3

    + +

    The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

    + +

    The following example demonstrates how to use the Language Translator service:

    +
    import LanguageTranslatorV3
    +
    +let username = "your-username-here"
    +let password = "your-password-here"
    +let version = "yyyy-mm-dd" // use today's date for the most recent version
    +let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
    +
     let failure = { (error: Error) in print(error) }
     let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
     languageTranslator.translate(request: request, failure: failure) {
    @@ -878,7 +900,7 @@ 

    Visual Recognition

    let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -886,6 +908,10 @@

    Visual Recognition

    print(classifiedImages) }
    + +

    Note: a different initializer is used for authentication with instances created before May 23, 2018:

    +
    let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
    +

    Using Core ML

    The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

    @@ -937,7 +963,7 @@

    Bundlin diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/search.json b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/search.json index 0ec7f2e84..644419c2f 100644 --- a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/search.json +++ b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/Documents/search.json @@ -1 +1 @@ -{"Structs/WarningInfo.html#/s:19VisualRecognitionV311WarningInfoV9warningIDSSvp":{"name":"warningID","abstract":"

    Codified warning string, such as limit_reached.

    ","parent_name":"WarningInfo"},"Structs/WarningInfo.html#/s:19VisualRecognitionV311WarningInfoV11descriptionSSvp":{"name":"description","abstract":"

    Information about the error.

    ","parent_name":"WarningInfo"},"Structs/PositiveExample.html#/s:19VisualRecognitionV315PositiveExampleV4nameSSvp":{"name":"name","abstract":"

    The name of the class.

    ","parent_name":"PositiveExample"},"Structs/PositiveExample.html#/s:19VisualRecognitionV315PositiveExampleV8examples10Foundation3URLVvp":{"name":"examples","abstract":"

    A compressed (.zip) file of images that prominently","parent_name":"PositiveExample"},"Structs/PositiveExample.html#/s:19VisualRecognitionV315PositiveExampleVACSS4name_10Foundation3URLV8examplestcfc":{"name":"init(name:examples:)","abstract":"

    Define a set of positive examples that shall be recognized by a classifier.

    ","parent_name":"PositiveExample"},"Structs/ImageWithFaces.html#/s:19VisualRecognitionV314ImageWithFacesV5facesSayAA4FaceVGvp":{"name":"faces","abstract":"

    Faces detected in the images.

    ","parent_name":"ImageWithFaces"},"Structs/ImageWithFaces.html#/s:19VisualRecognitionV314ImageWithFacesV5imageSSSgvp":{"name":"image","abstract":"

    Relative path of the image file if uploaded directly. Not returned when the image is passed by URL.

    ","parent_name":"ImageWithFaces"},"Structs/ImageWithFaces.html#/s:19VisualRecognitionV314ImageWithFacesV9sourceUrlSSSgvp":{"name":"sourceUrl","abstract":"

    Source of the image before any redirects. Not returned when the image is uploaded.

    ","parent_name":"ImageWithFaces"},"Structs/ImageWithFaces.html#/s:19VisualRecognitionV314ImageWithFacesV11resolvedUrlSSSgvp":{"name":"resolvedUrl","abstract":"

    Fully resolved URL of the image after redirects are followed. Not returned when the image is uploaded.

    ","parent_name":"ImageWithFaces"},"Structs/ImageWithFaces.html#/s:19VisualRecognitionV314ImageWithFacesV5errorAA9ErrorInfoVSgvp":{"name":"error","abstract":"

    Information about what might have caused a failure, such as an image that is too large. Not returned when there is no error.

    ","parent_name":"ImageWithFaces"},"Structs/FaceLocation.html#/s:19VisualRecognitionV312FaceLocationV5widthSdvp":{"name":"width","abstract":"

    Width in pixels of face region.

    ","parent_name":"FaceLocation"},"Structs/FaceLocation.html#/s:19VisualRecognitionV312FaceLocationV6heightSdvp":{"name":"height","abstract":"

    Height in pixels of face region.

    ","parent_name":"FaceLocation"},"Structs/FaceLocation.html#/s:19VisualRecognitionV312FaceLocationV4leftSdvp":{"name":"left","abstract":"

    X-position of top-left pixel of face region.

    ","parent_name":"FaceLocation"},"Structs/FaceLocation.html#/s:19VisualRecognitionV312FaceLocationV3topSdvp":{"name":"top","abstract":"

    Y-position of top-left pixel of face region.

    ","parent_name":"FaceLocation"},"Structs/FaceIdentity.html#/s:19VisualRecognitionV312FaceIdentityV4nameSSvp":{"name":"name","abstract":"

    Name of the person.

    ","parent_name":"FaceIdentity"},"Structs/FaceIdentity.html#/s:19VisualRecognitionV312FaceIdentityV5scoreSdSgvp":{"name":"score","abstract":"

    Confidence score for the property in the range of 0 to 1. A higher score indicates greater likelihood that the class is depicted in the image. The default threshold for returning scores from a classifier is 0.5.

    ","parent_name":"FaceIdentity"},"Structs/FaceIdentity.html#/s:19VisualRecognitionV312FaceIdentityV13typeHierarchySSSgvp":{"name":"typeHierarchy","abstract":"

    Knowledge graph of the property. For example, People/Leaders/Presidents/USA/Barack Obama. Included only if identified.

    ","parent_name":"FaceIdentity"},"Structs/FaceIdentity.html#/s:19VisualRecognitionV312FaceIdentityVACSS4name_SdSg5scoreSSSg13typeHierarchytcfc":{"name":"init(name:score:typeHierarchy:)","abstract":"

    Initialize a FaceIdentity with member variables.

    ","parent_name":"FaceIdentity"},"Structs/FaceIdentity.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"FaceIdentity"},"Structs/FaceIdentity.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"FaceIdentity"},"Structs/FaceGender.html#/s:19VisualRecognitionV310FaceGenderV6genderSSvp":{"name":"gender","abstract":"

    Gender identified by the face. For example, MALE or FEMALE.

    ","parent_name":"FaceGender"},"Structs/FaceGender.html#/s:19VisualRecognitionV310FaceGenderV5scoreSdSgvp":{"name":"score","abstract":"

    Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the property.

    ","parent_name":"FaceGender"},"Structs/FaceAge.html#/s:19VisualRecognitionV37FaceAgeV3minSiSgvp":{"name":"min","abstract":"

    Estimated minimum age.

    ","parent_name":"FaceAge"},"Structs/FaceAge.html#/s:19VisualRecognitionV37FaceAgeV3maxSiSgvp":{"name":"max","abstract":"

    Estimated maximum age.

    ","parent_name":"FaceAge"},"Structs/FaceAge.html#/s:19VisualRecognitionV37FaceAgeV5scoreSdSgvp":{"name":"score","abstract":"

    Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the property.

    ","parent_name":"FaceAge"},"Structs/Face.html#/s:19VisualRecognitionV34FaceV3ageAA0D3AgeVSgvp":{"name":"age","abstract":"

    Age information about a face.

    ","parent_name":"Face"},"Structs/Face.html#/s:19VisualRecognitionV34FaceV6genderAA0D6GenderVSgvp":{"name":"gender","abstract":"

    Information about the gender of the face.

    ","parent_name":"Face"},"Structs/Face.html#/s:19VisualRecognitionV34FaceV12faceLocationAA0dF0VSgvp":{"name":"faceLocation","abstract":"

    The location of the bounding box around the face.

    ","parent_name":"Face"},"Structs/Face.html#/s:19VisualRecognitionV34FaceV8identityAA0D8IdentityVSgvp":{"name":"identity","abstract":"

    Undocumented

    ","parent_name":"Face"},"Structs/ErrorInfo.html#/s:19VisualRecognitionV39ErrorInfoV4codeSivp":{"name":"code","abstract":"

    HTTP status code.

    ","parent_name":"ErrorInfo"},"Structs/ErrorInfo.html#/s:19VisualRecognitionV39ErrorInfoV11descriptionSSvp":{"name":"description","abstract":"

    Human-readable error description. For example, File size limit exceeded.

    ","parent_name":"ErrorInfo"},"Structs/ErrorInfo.html#/s:19VisualRecognitionV39ErrorInfoV7errorIDSSvp":{"name":"errorID","abstract":"

    Codified error string. For example, limit_exceeded.

    ","parent_name":"ErrorInfo"},"Structs/DetectedFaces.html#/s:19VisualRecognitionV313DetectedFacesV15imagesProcessedSiSgvp":{"name":"imagesProcessed","abstract":"

    Number of images processed for the API call.

    ","parent_name":"DetectedFaces"},"Structs/DetectedFaces.html#/s:19VisualRecognitionV313DetectedFacesV6imagesSayAA09ImageWithE0VGvp":{"name":"images","abstract":"

    The images.

    ","parent_name":"DetectedFaces"},"Structs/DetectedFaces.html#/s:19VisualRecognitionV313DetectedFacesV8warningsSayAA11WarningInfoVGSgvp":{"name":"warnings","abstract":"

    Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file and a list of image URLs will still complete, but does not return the expected output. Not returned when there is no warning.

    ","parent_name":"DetectedFaces"},"Structs/Classifiers.html#/s:19VisualRecognitionV311ClassifiersV11classifiersSayAA10ClassifierVGvp":{"name":"classifiers","abstract":"

    List of classifiers.

    ","parent_name":"Classifiers"},"Structs/ClassifierResult.html#/s:19VisualRecognitionV316ClassifierResultV4nameSSvp":{"name":"name","abstract":"

    Name of the classifier.

    ","parent_name":"ClassifierResult"},"Structs/ClassifierResult.html#/s:19VisualRecognitionV316ClassifierResultV12classifierIDSSvp":{"name":"classifierID","abstract":"

    ID of a classifier identified in the image.

    ","parent_name":"ClassifierResult"},"Structs/ClassifierResult.html#/s:19VisualRecognitionV316ClassifierResultV7classesSayAA05ClassE0VGvp":{"name":"classes","abstract":"

    Classes within the classifier.

    ","parent_name":"ClassifierResult"},"Structs/Classifier/Status.html#/s:19VisualRecognitionV310ClassifierV6StatusO5readyA2EmF":{"name":"ready","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Classifier/Status.html#/s:19VisualRecognitionV310ClassifierV6StatusO8trainingA2EmF":{"name":"training","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Classifier/Status.html#/s:19VisualRecognitionV310ClassifierV6StatusO10retrainingA2EmF":{"name":"retraining","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Classifier/Status.html#/s:19VisualRecognitionV310ClassifierV6StatusO6failedA2EmF":{"name":"failed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Classifier/Status.html":{"name":"Status","abstract":"

    Training status of classifier.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV12classifierIDSSvp":{"name":"classifierID","abstract":"

    ID of a classifier identified in the image.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV4nameSSvp":{"name":"name","abstract":"

    Name of the classifier.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV5ownerSSSgvp":{"name":"owner","abstract":"

    Unique ID of the account who owns the classifier. Returned when verbose=true. Might not be returned by some requests.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV6statusSSSgvp":{"name":"status","abstract":"

    Training status of classifier.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV13coreMlEnabledSbvp":{"name":"coreMlEnabled","abstract":"

    Whether the classifier can be downloaded as a Core ML model after the training status is ready.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV11explanationSSSgvp":{"name":"explanation","abstract":"

    If classifier training has failed, this field may explain why.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV7createdSSSgvp":{"name":"created","abstract":"

    Date and time in Coordinated Universal Time (UTC) that the classifier was created.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV7classesSayAA5ClassVGSgvp":{"name":"classes","abstract":"

    Classes that define a classifier.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV9retrainedSSSgvp":{"name":"retrained","abstract":"

    Date and time in Coordinated Universal Time (UTC) that the classifier was updated. Returned when verbose=true. Might not be returned by some requests. Identical to updated and retained for backward compatibility.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV7updatedSSSgvp":{"name":"updated","abstract":"

    Date and time in Coordinated Universal Time (UTC) that the classifier was most recently updated. The field matches either retrained or created. Returned when verbose=true. Might not be returned by some requests.

    ","parent_name":"Classifier"},"Structs/ClassifiedImages.html#/s:19VisualRecognitionV316ClassifiedImagesV13customClassesSiSgvp":{"name":"customClasses","abstract":"

    Number of custom classes identified in the images.

    ","parent_name":"ClassifiedImages"},"Structs/ClassifiedImages.html#/s:19VisualRecognitionV316ClassifiedImagesV15imagesProcessedSiSgvp":{"name":"imagesProcessed","abstract":"

    Number of images processed for the API call.

    ","parent_name":"ClassifiedImages"},"Structs/ClassifiedImages.html#/s:19VisualRecognitionV316ClassifiedImagesV6imagesSayAA0D5ImageVGvp":{"name":"images","abstract":"

    Classified images.

    ","parent_name":"ClassifiedImages"},"Structs/ClassifiedImages.html#/s:19VisualRecognitionV316ClassifiedImagesV8warningsSayAA11WarningInfoVGSgvp":{"name":"warnings","abstract":"

    Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file and a list of image URLs will still complete, but does not return the expected output. Not returned when there is no warning.

    ","parent_name":"ClassifiedImages"},"Structs/ClassifiedImage.html#/s:19VisualRecognitionV315ClassifiedImageV9sourceUrlSSSgvp":{"name":"sourceUrl","abstract":"

    Source of the image before any redirects. Not returned when the image is uploaded.

    ","parent_name":"ClassifiedImage"},"Structs/ClassifiedImage.html#/s:19VisualRecognitionV315ClassifiedImageV11resolvedUrlSSSgvp":{"name":"resolvedUrl","abstract":"

    Fully resolved URL of the image after redirects are followed. Not returned when the image is uploaded.

    ","parent_name":"ClassifiedImage"},"Structs/ClassifiedImage.html#/s:19VisualRecognitionV315ClassifiedImageV5imageSSSgvp":{"name":"image","abstract":"

    Relative path of the image file if uploaded directly. Not returned when the image is passed by URL.

    ","parent_name":"ClassifiedImage"},"Structs/ClassifiedImage.html#/s:19VisualRecognitionV315ClassifiedImageV5errorAA9ErrorInfoVSgvp":{"name":"error","abstract":"

    Information about what might have caused a failure, such as an image that is too large. Not returned when there is no error.

    ","parent_name":"ClassifiedImage"},"Structs/ClassifiedImage.html#/s:19VisualRecognitionV315ClassifiedImageV11classifiersSayAA16ClassifierResultVGvp":{"name":"classifiers","abstract":"

    The classifiers.

    ","parent_name":"ClassifiedImage"},"Structs/ClassResult.html#/s:19VisualRecognitionV311ClassResultV9classNameSSvp":{"name":"className","abstract":"

    Name of the class.

    ","parent_name":"ClassResult"},"Structs/ClassResult.html#/s:19VisualRecognitionV311ClassResultV5scoreSdSgvp":{"name":"score","abstract":"

    Confidence score for the property in the range of 0 to 1. A higher score indicates greater likelihood that the class is depicted in the image. The default threshold for returning scores from a classifier is 0.5.

    ","parent_name":"ClassResult"},"Structs/ClassResult.html#/s:19VisualRecognitionV311ClassResultV13typeHierarchySSSgvp":{"name":"typeHierarchy","abstract":"

    Knowledge graph of the property. For example, /fruit/pome/apple/eating apple/Granny Smith. Included only if identified.

    ","parent_name":"ClassResult"},"Structs/Class.html#/s:19VisualRecognitionV35ClassV9classNameSSvp":{"name":"className","abstract":"

    The name of the class.

    ","parent_name":"Class"},"Structs.html#/s:19VisualRecognitionV311JSONWrapperV":{"name":"JSONWrapper","abstract":"

    Used internally to serialize and deserialize JSON."},"Structs/Class.html":{"name":"Class","abstract":"

    A category within a classifier.

    "},"Structs/ClassResult.html":{"name":"ClassResult","abstract":"

    Result of a class within a classifier.

    "},"Structs/ClassifiedImage.html":{"name":"ClassifiedImage","abstract":"

    Results for one image.

    "},"Structs/ClassifiedImages.html":{"name":"ClassifiedImages","abstract":"

    Results for all images.

    "},"Structs/Classifier.html":{"name":"Classifier","abstract":"

    Information about a classifier.

    "},"Structs/ClassifierResult.html":{"name":"ClassifierResult","abstract":"

    Classifier and score combination.

    "},"Structs/Classifiers.html":{"name":"Classifiers","abstract":"

    A container for the list of classifiers.

    "},"Structs/DetectedFaces.html":{"name":"DetectedFaces","abstract":"

    Results for all faces.

    "},"Structs/ErrorInfo.html":{"name":"ErrorInfo","abstract":"

    Information about what might have caused a failure, such as an image that is too large. Not returned when there is no error.

    "},"Structs/Face.html":{"name":"Face","abstract":"

    Information about the face.

    "},"Structs/FaceAge.html":{"name":"FaceAge","abstract":"

    Age information about a face.

    "},"Structs/FaceGender.html":{"name":"FaceGender","abstract":"

    Information about the gender of the face.

    "},"Structs/FaceIdentity.html":{"name":"FaceIdentity","abstract":"

    Provides information about a celebrity who is detected in the image. Not returned when a celebrity is not detected.

    "},"Structs/FaceLocation.html":{"name":"FaceLocation","abstract":"

    The location of the bounding box around the face.

    "},"Structs/ImageWithFaces.html":{"name":"ImageWithFaces","abstract":"

    Information about faces in the image.

    "},"Structs/PositiveExample.html":{"name":"PositiveExample","abstract":"

    A class associated with a Visual Recognition classifier.

    "},"Structs/WarningInfo.html":{"name":"WarningInfo","abstract":"

    Information about something that went wrong.

    "},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

    No response was received from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

    No data was returned from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO013serializationE0A2CmF":{"name":"serializationError","abstract":"

    Failed to serialize value(s) to data.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO08encodingE0A2CmF":{"name":"encodingError","abstract":"

    Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO011fileManagerE0A2CmF":{"name":"fileManagerError","abstract":"

    FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

    Failed to load the given file.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

    An HTTP error with a status code and description.

    ","parent_name":"RestError"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO4nullA2CmF":{"name":"null","abstract":"

    A null value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

    A boolean value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO6stringACSScACmF":{"name":"string","abstract":"

    A string value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO3intACSicACmF":{"name":"int","abstract":"

    A number value, represented as an integer.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO6doubleACSdcACmF":{"name":"double","abstract":"

    A number value, represented as a double.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

    An array value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

    An object value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Decode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

    Initialize a JSON value from an encodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

    Convert this JSON value to a decodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

    Encode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compare two JSON values for equality.

    ","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

    A JSON value (one of string, number, object, array, true, false, or null).

    "},"Enums/RestError.html":{"name":"RestError","abstract":"

    An error from processing a network request or response.

    "},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

    The base URL to use when contacting the service.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

    The default HTTP headers for all requests to the service.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0CACSS6apiKey_SS7versiontcfc":{"name":"init(apiKey:version:)","abstract":"

    Create a VisualRecognition object.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

    Create a VisualRecognition object.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

    Create a VisualRecognition object.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

    Undocumented

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C8classifyy10Foundation3URLVSg10imagesFile_SSSg3urlSdSg9thresholdSaySSGSg6ownersAO13classifierIDsAJ14acceptLanguages10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA16ClassifiedImagesVc7successtF":{"name":"classify(imagesFile:url:threshold:owners:classifierIDs:acceptLanguage:headers:failure:success:)","abstract":"

    Classify images.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C11detectFacesy10Foundation3URLVSg10imagesFile_SSSg3urls10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA08DetectedE0Vc7successtF":{"name":"detectFaces(imagesFile:url:headers:failure:success:)","abstract":"

    Detect faces in images.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C16createClassifierySS4name_SayAA15PositiveExampleVG16positiveExamples10Foundation3URLVSg08negativeJ0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0E0Vc7successtF":{"name":"createClassifier(name:positiveExamples:negativeExamples:headers:failure:success:)","abstract":"

    Create a classifier.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C15listClassifiersySaySSGSg6owners_SbSg7verboses10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0E0Vc7successtF":{"name":"listClassifiers(owners:verbose:headers:failure:success:)","abstract":"

    Retrieve a list of classifiers.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C13getClassifierySS12classifierID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0E0Vc7successtF":{"name":"getClassifier(classifierID:headers:failure:success:)","abstract":"

    Retrieve classifier details.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C16updateClassifierySS12classifierID_SayAA15PositiveExampleVGSg16positiveExamples10Foundation3URLVSg08negativeK0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0E0Vc7successtF":{"name":"updateClassifier(classifierID:positiveExamples:negativeExamples:headers:failure:success:)","abstract":"

    Update a classifier.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C16deleteClassifierySS12classifierID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteClassifier(classifierID:headers:failure:success:)","abstract":"

    Delete a classifier.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C14getCoreMlModelySS12classifierID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failurey10Foundation3URLVc7successtF":{"name":"getCoreMlModel(classifierID:headers:failure:success:)","abstract":"

    Retrieve a Core ML model of a classifier.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

    Delete labeled data.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C13getLocalModelSo7MLModelCSS12classifierID_tKF":{"name":"getLocalModel(classifierID:)","abstract":"

    Retrieve a Core ML model from the local filesystem.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C16updateLocalModelySS12classifierID_ys5Error_pcSg7failureyycSg7successtF":{"name":"updateLocalModel(classifierID:failure:success:)","abstract":"

    Download the latest Core ML model to the local filesystem, unless the latest version","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C15listLocalModelsSaySSGyKF":{"name":"listLocalModels()","abstract":"

    List the Core ML models stored in the local filesystem.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C16deleteLocalModelySS12classifierID_tKF":{"name":"deleteLocalModel(classifierID:)","abstract":"

    Delete a Core ML model from the local filesystem.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C22classifyWithLocalModelySo7UIImageC5image_SaySSG13classifierIDsSdSg9thresholdys5Error_pcSg7failureyAA16ClassifiedImagesVc7successtF":{"name":"classifyWithLocalModel(image:classifierIDs:threshold:failure:success:)","abstract":"

    Classify an image using a Core ML model from the local filesystem.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C8classifyySo7UIImageC5image_SdSg9thresholdSaySSGSg6ownersAK13classifierIDsSSSg14acceptLanguageys5Error_pcSg7failureyAA16ClassifiedImagesVc7successtF":{"name":"classify(image:threshold:owners:classifierIDs:acceptLanguage:failure:success:)","abstract":"

    Classify images.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C11detectFacesySo7UIImageC5image_ys5Error_pcSg7failureyAA08DetectedE0Vc7successtF":{"name":"detectFaces(image:failure:success:)","abstract":"

    Detect faces in images.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html":{"name":"VisualRecognition","abstract":"

    The IBM Watson Visual Recognition service uses deep learning algorithms to identify scenes, objects, and faces in"},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "}} \ No newline at end of file +{"Structs/WarningInfo.html#/s:19VisualRecognitionV311WarningInfoV9warningIDSSvp":{"name":"warningID","abstract":"

    Codified warning string, such as limit_reached.

    ","parent_name":"WarningInfo"},"Structs/WarningInfo.html#/s:19VisualRecognitionV311WarningInfoV11descriptionSSvp":{"name":"description","abstract":"

    Information about the error.

    ","parent_name":"WarningInfo"},"Structs/PositiveExample.html#/s:19VisualRecognitionV315PositiveExampleV4nameSSvp":{"name":"name","abstract":"

    The name of the class.

    ","parent_name":"PositiveExample"},"Structs/PositiveExample.html#/s:19VisualRecognitionV315PositiveExampleV8examples10Foundation3URLVvp":{"name":"examples","abstract":"

    A compressed (.zip) file of images that prominently","parent_name":"PositiveExample"},"Structs/PositiveExample.html#/s:19VisualRecognitionV315PositiveExampleVACSS4name_10Foundation3URLV8examplestcfc":{"name":"init(name:examples:)","abstract":"

    Define a set of positive examples that shall be recognized by a classifier.

    ","parent_name":"PositiveExample"},"Structs/ImageWithFaces.html#/s:19VisualRecognitionV314ImageWithFacesV5facesSayAA4FaceVGvp":{"name":"faces","abstract":"

    Faces detected in the images.

    ","parent_name":"ImageWithFaces"},"Structs/ImageWithFaces.html#/s:19VisualRecognitionV314ImageWithFacesV5imageSSSgvp":{"name":"image","abstract":"

    Relative path of the image file if uploaded directly. Not returned when the image is passed by URL.

    ","parent_name":"ImageWithFaces"},"Structs/ImageWithFaces.html#/s:19VisualRecognitionV314ImageWithFacesV9sourceUrlSSSgvp":{"name":"sourceUrl","abstract":"

    Source of the image before any redirects. Not returned when the image is uploaded.

    ","parent_name":"ImageWithFaces"},"Structs/ImageWithFaces.html#/s:19VisualRecognitionV314ImageWithFacesV11resolvedUrlSSSgvp":{"name":"resolvedUrl","abstract":"

    Fully resolved URL of the image after redirects are followed. Not returned when the image is uploaded.

    ","parent_name":"ImageWithFaces"},"Structs/ImageWithFaces.html#/s:19VisualRecognitionV314ImageWithFacesV5errorAA9ErrorInfoVSgvp":{"name":"error","abstract":"

    Information about what might have caused a failure, such as an image that is too large. Not returned when there is","parent_name":"ImageWithFaces"},"Structs/FaceLocation.html#/s:19VisualRecognitionV312FaceLocationV5widthSdvp":{"name":"width","abstract":"

    Width in pixels of face region.

    ","parent_name":"FaceLocation"},"Structs/FaceLocation.html#/s:19VisualRecognitionV312FaceLocationV6heightSdvp":{"name":"height","abstract":"

    Height in pixels of face region.

    ","parent_name":"FaceLocation"},"Structs/FaceLocation.html#/s:19VisualRecognitionV312FaceLocationV4leftSdvp":{"name":"left","abstract":"

    X-position of top-left pixel of face region.

    ","parent_name":"FaceLocation"},"Structs/FaceLocation.html#/s:19VisualRecognitionV312FaceLocationV3topSdvp":{"name":"top","abstract":"

    Y-position of top-left pixel of face region.

    ","parent_name":"FaceLocation"},"Structs/FaceIdentity.html#/s:19VisualRecognitionV312FaceIdentityV4nameSSvp":{"name":"name","abstract":"

    Name of the person.

    ","parent_name":"FaceIdentity"},"Structs/FaceIdentity.html#/s:19VisualRecognitionV312FaceIdentityV5scoreSdSgvp":{"name":"score","abstract":"

    Confidence score for the property in the range of 0 to 1. A higher score indicates greater likelihood that the class is depicted in the image. The default threshold for returning scores from a classifier is 0.5.

    ","parent_name":"FaceIdentity"},"Structs/FaceIdentity.html#/s:19VisualRecognitionV312FaceIdentityV13typeHierarchySSSgvp":{"name":"typeHierarchy","abstract":"

    Knowledge graph of the property. For example, People/Leaders/Presidents/USA/Barack Obama. Included only if identified.

    ","parent_name":"FaceIdentity"},"Structs/FaceIdentity.html#/s:19VisualRecognitionV312FaceIdentityVACSS4name_SdSg5scoreSSSg13typeHierarchytcfc":{"name":"init(name:score:typeHierarchy:)","abstract":"

    Initialize a FaceIdentity with member variables.

    ","parent_name":"FaceIdentity"},"Structs/FaceIdentity.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"FaceIdentity"},"Structs/FaceIdentity.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"FaceIdentity"},"Structs/FaceGender.html#/s:19VisualRecognitionV310FaceGenderV6genderSSvp":{"name":"gender","abstract":"

    Gender identified by the face. For example, MALE or FEMALE.

    ","parent_name":"FaceGender"},"Structs/FaceGender.html#/s:19VisualRecognitionV310FaceGenderV5scoreSdSgvp":{"name":"score","abstract":"

    Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the","parent_name":"FaceGender"},"Structs/FaceAge.html#/s:19VisualRecognitionV37FaceAgeV3minSiSgvp":{"name":"min","abstract":"

    Estimated minimum age.

    ","parent_name":"FaceAge"},"Structs/FaceAge.html#/s:19VisualRecognitionV37FaceAgeV3maxSiSgvp":{"name":"max","abstract":"

    Estimated maximum age.

    ","parent_name":"FaceAge"},"Structs/FaceAge.html#/s:19VisualRecognitionV37FaceAgeV5scoreSdSgvp":{"name":"score","abstract":"

    Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the","parent_name":"FaceAge"},"Structs/Face.html#/s:19VisualRecognitionV34FaceV3ageAA0D3AgeVSgvp":{"name":"age","abstract":"

    Age information about a face.

    ","parent_name":"Face"},"Structs/Face.html#/s:19VisualRecognitionV34FaceV6genderAA0D6GenderVSgvp":{"name":"gender","abstract":"

    Information about the gender of the face.

    ","parent_name":"Face"},"Structs/Face.html#/s:19VisualRecognitionV34FaceV12faceLocationAA0dF0VSgvp":{"name":"faceLocation","abstract":"

    The location of the bounding box around the face.

    ","parent_name":"Face"},"Structs/Face.html#/s:19VisualRecognitionV34FaceV8identityAA0D8IdentityVSgvp":{"name":"identity","abstract":"

    deprecated

    ","parent_name":"Face"},"Structs/ErrorInfo.html#/s:19VisualRecognitionV39ErrorInfoV4codeSivp":{"name":"code","abstract":"

    HTTP status code.

    ","parent_name":"ErrorInfo"},"Structs/ErrorInfo.html#/s:19VisualRecognitionV39ErrorInfoV11descriptionSSvp":{"name":"description","abstract":"

    Human-readable error description. For example, File size limit exceeded.

    ","parent_name":"ErrorInfo"},"Structs/ErrorInfo.html#/s:19VisualRecognitionV39ErrorInfoV7errorIDSSvp":{"name":"errorID","abstract":"

    Codified error string. For example, limit_exceeded.

    ","parent_name":"ErrorInfo"},"Structs/DetectedFaces.html#/s:19VisualRecognitionV313DetectedFacesV15imagesProcessedSiSgvp":{"name":"imagesProcessed","abstract":"

    Number of images processed for the API call.

    ","parent_name":"DetectedFaces"},"Structs/DetectedFaces.html#/s:19VisualRecognitionV313DetectedFacesV6imagesSayAA09ImageWithE0VGvp":{"name":"images","abstract":"

    The images.

    ","parent_name":"DetectedFaces"},"Structs/DetectedFaces.html#/s:19VisualRecognitionV313DetectedFacesV8warningsSayAA11WarningInfoVGSgvp":{"name":"warnings","abstract":"

    Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file","parent_name":"DetectedFaces"},"Structs/Classifiers.html#/s:19VisualRecognitionV311ClassifiersV11classifiersSayAA10ClassifierVGvp":{"name":"classifiers","abstract":"

    List of classifiers.

    ","parent_name":"Classifiers"},"Structs/ClassifierResult.html#/s:19VisualRecognitionV316ClassifierResultV4nameSSvp":{"name":"name","abstract":"

    Name of the classifier.

    ","parent_name":"ClassifierResult"},"Structs/ClassifierResult.html#/s:19VisualRecognitionV316ClassifierResultV12classifierIDSSvp":{"name":"classifierID","abstract":"

    ID of a classifier identified in the image.

    ","parent_name":"ClassifierResult"},"Structs/ClassifierResult.html#/s:19VisualRecognitionV316ClassifierResultV7classesSayAA05ClassE0VGvp":{"name":"classes","abstract":"

    Classes within the classifier.

    ","parent_name":"ClassifierResult"},"Structs/Classifier/Status.html#/s:19VisualRecognitionV310ClassifierV6StatusO5readyA2EmF":{"name":"ready","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Classifier/Status.html#/s:19VisualRecognitionV310ClassifierV6StatusO8trainingA2EmF":{"name":"training","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Classifier/Status.html#/s:19VisualRecognitionV310ClassifierV6StatusO10retrainingA2EmF":{"name":"retraining","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Classifier/Status.html#/s:19VisualRecognitionV310ClassifierV6StatusO6failedA2EmF":{"name":"failed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Classifier/Status.html":{"name":"Status","abstract":"

    Training status of classifier.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV12classifierIDSSvp":{"name":"classifierID","abstract":"

    ID of a classifier identified in the image.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV4nameSSvp":{"name":"name","abstract":"

    Name of the classifier.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV5ownerSSSgvp":{"name":"owner","abstract":"

    Unique ID of the account who owns the classifier. Returned when verbose=true. Might not be returned by some","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV6statusSSSgvp":{"name":"status","abstract":"

    Training status of classifier.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV13coreMlEnabledSbSgvp":{"name":"coreMlEnabled","abstract":"

    Whether the classifier can be downloaded as a Core ML model after the training status is ready.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV11explanationSSSgvp":{"name":"explanation","abstract":"

    If classifier training has failed, this field may explain why.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV7createdSSSgvp":{"name":"created","abstract":"

    Date and time in Coordinated Universal Time (UTC) that the classifier was created.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV7classesSayAA5ClassVGSgvp":{"name":"classes","abstract":"

    Classes that define a classifier.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV9retrainedSSSgvp":{"name":"retrained","abstract":"

    Date and time in Coordinated Universal Time (UTC) that the classifier was updated. Returned when verbose=true.","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV7updatedSSSgvp":{"name":"updated","abstract":"

    Date and time in Coordinated Universal Time (UTC) that the classifier was most recently updated. The field matches","parent_name":"Classifier"},"Structs/ClassifiedImages.html#/s:19VisualRecognitionV316ClassifiedImagesV13customClassesSiSgvp":{"name":"customClasses","abstract":"

    Number of custom classes identified in the images.

    ","parent_name":"ClassifiedImages"},"Structs/ClassifiedImages.html#/s:19VisualRecognitionV316ClassifiedImagesV15imagesProcessedSiSgvp":{"name":"imagesProcessed","abstract":"

    Number of images processed for the API call.

    ","parent_name":"ClassifiedImages"},"Structs/ClassifiedImages.html#/s:19VisualRecognitionV316ClassifiedImagesV6imagesSayAA0D5ImageVGvp":{"name":"images","abstract":"

    Classified images.

    ","parent_name":"ClassifiedImages"},"Structs/ClassifiedImages.html#/s:19VisualRecognitionV316ClassifiedImagesV8warningsSayAA11WarningInfoVGSgvp":{"name":"warnings","abstract":"

    Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file","parent_name":"ClassifiedImages"},"Structs/ClassifiedImage.html#/s:19VisualRecognitionV315ClassifiedImageV9sourceUrlSSSgvp":{"name":"sourceUrl","abstract":"

    Source of the image before any redirects. Not returned when the image is uploaded.

    ","parent_name":"ClassifiedImage"},"Structs/ClassifiedImage.html#/s:19VisualRecognitionV315ClassifiedImageV11resolvedUrlSSSgvp":{"name":"resolvedUrl","abstract":"

    Fully resolved URL of the image after redirects are followed. Not returned when the image is uploaded.

    ","parent_name":"ClassifiedImage"},"Structs/ClassifiedImage.html#/s:19VisualRecognitionV315ClassifiedImageV5imageSSSgvp":{"name":"image","abstract":"

    Relative path of the image file if uploaded directly. Not returned when the image is passed by URL.

    ","parent_name":"ClassifiedImage"},"Structs/ClassifiedImage.html#/s:19VisualRecognitionV315ClassifiedImageV5errorAA9ErrorInfoVSgvp":{"name":"error","abstract":"

    Information about what might have caused a failure, such as an image that is too large. Not returned when there is","parent_name":"ClassifiedImage"},"Structs/ClassifiedImage.html#/s:19VisualRecognitionV315ClassifiedImageV11classifiersSayAA16ClassifierResultVGvp":{"name":"classifiers","abstract":"

    The classifiers.

    ","parent_name":"ClassifiedImage"},"Structs/ClassResult.html#/s:19VisualRecognitionV311ClassResultV9classNameSSvp":{"name":"className","abstract":"

    Name of the class.

    ","parent_name":"ClassResult"},"Structs/ClassResult.html#/s:19VisualRecognitionV311ClassResultV5scoreSdSgvp":{"name":"score","abstract":"

    Confidence score for the property in the range of 0 to 1. A higher score indicates greater likelihood that the","parent_name":"ClassResult"},"Structs/ClassResult.html#/s:19VisualRecognitionV311ClassResultV13typeHierarchySSSgvp":{"name":"typeHierarchy","abstract":"

    Knowledge graph of the property. For example, /fruit/pome/apple/eating apple/Granny Smith. Included only if","parent_name":"ClassResult"},"Structs/Class.html#/s:19VisualRecognitionV35ClassV9classNameSSvp":{"name":"className","abstract":"

    The name of the class.

    ","parent_name":"Class"},"Structs/Class.html":{"name":"Class","abstract":"

    A category within a classifier.

    "},"Structs/ClassResult.html":{"name":"ClassResult","abstract":"

    Result of a class within a classifier.

    "},"Structs/ClassifiedImage.html":{"name":"ClassifiedImage","abstract":"

    Results for one image.

    "},"Structs/ClassifiedImages.html":{"name":"ClassifiedImages","abstract":"

    Results for all images.

    "},"Structs/Classifier.html":{"name":"Classifier","abstract":"

    Information about a classifier.

    "},"Structs/ClassifierResult.html":{"name":"ClassifierResult","abstract":"

    Classifier and score combination.

    "},"Structs/Classifiers.html":{"name":"Classifiers","abstract":"

    A container for the list of classifiers.

    "},"Structs/DetectedFaces.html":{"name":"DetectedFaces","abstract":"

    Results for all faces.

    "},"Structs/ErrorInfo.html":{"name":"ErrorInfo","abstract":"

    Information about what might have caused a failure, such as an image that is too large. Not returned when there is no error.

    "},"Structs/Face.html":{"name":"Face","abstract":"

    Information about the face.

    "},"Structs/FaceAge.html":{"name":"FaceAge","abstract":"

    Age information about a face.

    "},"Structs/FaceGender.html":{"name":"FaceGender","abstract":"

    Information about the gender of the face.

    "},"Structs/FaceIdentity.html":{"name":"FaceIdentity","abstract":"

    Provides information about a celebrity who is detected in the image. Not returned when a celebrity is not detected.

    "},"Structs/FaceLocation.html":{"name":"FaceLocation","abstract":"

    The location of the bounding box around the face.

    "},"Structs/ImageWithFaces.html":{"name":"ImageWithFaces","abstract":"

    Information about faces in the image.

    "},"Structs/PositiveExample.html":{"name":"PositiveExample","abstract":"

    A class associated with a Visual Recognition classifier.

    "},"Structs/WarningInfo.html":{"name":"WarningInfo","abstract":"

    Information about something that went wrong.

    "},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

    No response was received from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

    No data was returned from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO013serializationE0A2CmF":{"name":"serializationError","abstract":"

    Failed to serialize value(s) to data.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO08encodingE0A2CmF":{"name":"encodingError","abstract":"

    Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO011fileManagerE0A2CmF":{"name":"fileManagerError","abstract":"

    FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

    Failed to load the given file.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

    An HTTP error with a status code and description.

    ","parent_name":"RestError"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO4nullA2CmF":{"name":"null","abstract":"

    A null value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

    A boolean value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO6stringACSScACmF":{"name":"string","abstract":"

    A string value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO3intACSicACmF":{"name":"int","abstract":"

    A number value, represented as an integer.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO6doubleACSdcACmF":{"name":"double","abstract":"

    A number value, represented as a double.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

    An array value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

    An object value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Decode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

    Initialize a JSON value from an encodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

    Convert this JSON value to a decodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

    Encode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compare two JSON values for equality.

    ","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

    A JSON value (one of string, number, object, array, true, false, or null).

    "},"Enums/RestError.html":{"name":"RestError","abstract":"

    An error from processing a network request or response.

    "},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

    The base URL to use when contacting the service.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

    The default HTTP headers for all requests to the service.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0CACSS6apiKey_SS7versiontcfc":{"name":"init(apiKey:version:)","abstract":"

    Create a VisualRecognition object.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

    Create a VisualRecognition object.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

    Create a VisualRecognition object.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

    Undocumented

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C8classifyy10Foundation3URLVSg10imagesFile_SSSg3urlSdSg9thresholdSaySSGSg6ownersAO13classifierIDsAJ14acceptLanguages10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA16ClassifiedImagesVc7successtF":{"name":"classify(imagesFile:url:threshold:owners:classifierIDs:acceptLanguage:headers:failure:success:)","abstract":"

    Classify images.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C11detectFacesy10Foundation3URLVSg10imagesFile_SSSg3urls10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA08DetectedE0Vc7successtF":{"name":"detectFaces(imagesFile:url:headers:failure:success:)","abstract":"

    Detect faces in images.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C16createClassifierySS4name_SayAA15PositiveExampleVG16positiveExamples10Foundation3URLVSg08negativeJ0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0E0Vc7successtF":{"name":"createClassifier(name:positiveExamples:negativeExamples:headers:failure:success:)","abstract":"

    Create a classifier.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C15listClassifiersySaySSGSg6owners_SbSg7verboses10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0E0Vc7successtF":{"name":"listClassifiers(owners:verbose:headers:failure:success:)","abstract":"

    Retrieve a list of classifiers.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C13getClassifierySS12classifierID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0E0Vc7successtF":{"name":"getClassifier(classifierID:headers:failure:success:)","abstract":"

    Retrieve classifier details.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C16updateClassifierySS12classifierID_SayAA15PositiveExampleVGSg16positiveExamples10Foundation3URLVSg08negativeK0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0E0Vc7successtF":{"name":"updateClassifier(classifierID:positiveExamples:negativeExamples:headers:failure:success:)","abstract":"

    Update a classifier.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C16deleteClassifierySS12classifierID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteClassifier(classifierID:headers:failure:success:)","abstract":"

    Delete a classifier.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C14getCoreMlModelySS12classifierID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failurey10Foundation3URLVc7successtF":{"name":"getCoreMlModel(classifierID:headers:failure:success:)","abstract":"

    Retrieve a Core ML model of a classifier.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

    Delete labeled data.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C13getLocalModelSo7MLModelCSS12classifierID_tKF":{"name":"getLocalModel(classifierID:)","abstract":"

    Retrieve a Core ML model from the local filesystem.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C16updateLocalModelySS12classifierID_ys5Error_pcSg7failureyycSg7successtF":{"name":"updateLocalModel(classifierID:failure:success:)","abstract":"

    Download the latest Core ML model to the local filesystem, unless the latest version","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C15listLocalModelsSaySSGyKF":{"name":"listLocalModels()","abstract":"

    List the Core ML models stored in the local filesystem.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C16deleteLocalModelySS12classifierID_tKF":{"name":"deleteLocalModel(classifierID:)","abstract":"

    Delete a Core ML model from the local filesystem.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C22classifyWithLocalModelySo7UIImageC5image_SaySSG13classifierIDsSdSg9thresholdys5Error_pcSg7failureyAA16ClassifiedImagesVc7successtF":{"name":"classifyWithLocalModel(image:classifierIDs:threshold:failure:success:)","abstract":"

    Classify an image using a Core ML model from the local filesystem.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C8classifyySo7UIImageC5image_SdSg9thresholdSaySSGSg6ownersAK13classifierIDsSSSg14acceptLanguageys5Error_pcSg7failureyAA16ClassifiedImagesVc7successtF":{"name":"classify(image:threshold:owners:classifierIDs:acceptLanguage:failure:success:)","abstract":"

    Classify images.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C11detectFacesySo7UIImageC5image_ys5Error_pcSg7failureyAA08DetectedE0Vc7successtF":{"name":"detectFaces(image:failure:success:)","abstract":"

    Detect faces in images.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html":{"name":"VisualRecognition","abstract":"

    The IBM Watson™ Visual Recognition service uses deep learning algorithms to identify scenes, objects, and faces"},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "}} \ No newline at end of file diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/docSet.dsidx b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/docSet.dsidx index de19f86bf..03a142195 100644 Binary files a/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/docSet.dsidx and b/docs/swift-api/services/VisualRecognitionV3/docsets/.docset/Contents/Resources/docSet.dsidx differ diff --git a/docs/swift-api/services/VisualRecognitionV3/docsets/.tgz b/docs/swift-api/services/VisualRecognitionV3/docsets/.tgz index c02b4aa4c..3ff08687f 100644 Binary files a/docs/swift-api/services/VisualRecognitionV3/docsets/.tgz and b/docs/swift-api/services/VisualRecognitionV3/docsets/.tgz differ diff --git a/docs/swift-api/services/VisualRecognitionV3/index.html b/docs/swift-api/services/VisualRecognitionV3/index.html index d3e7524a4..284cd8061 100644 --- a/docs/swift-api/services/VisualRecognitionV3/index.html +++ b/docs/swift-api/services/VisualRecognitionV3/index.html @@ -97,9 +97,6 @@ - @@ -154,7 +151,8 @@

    Services

    • Assistant
    • Discovery
    • -
    • Language Translator
    • +
    • Language Translator V2
    • +
    • Language Translator V3
    • Natural Language Classifier
    • Natural Language Understanding
    • Personality Insights
    • @@ -199,7 +197,7 @@

      Swift Package Manager

      Add the following to your Package.swift file to identify the Swift SDK as a dependency. The package manager will clone the Swift SDK when you build your project with swift build.

      dependencies: [
      -    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.26.0")
      +    .package(url: "https://github.com/watson-developer-cloud/swift-sdk", from: "0.28.0")
       ]
       

      Service Instances

      @@ -242,7 +240,7 @@

      Username and Password

      API Key

      -

      Note: This version of instantiation only works with Visual Recognition, as it’s the only service that uses an API key.

      +

      Note: This type of authentication only works with Visual Recognition, and for instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.

      let visualRecognition = VisualRecognition(apiKey: "your-apiKey-here", version: "your-version-here")
       

      Using IAM

      @@ -477,7 +475,12 @@

      Private Data Collections

    • IBM Discovery - Documentation
    • IBM Discovery - Demo
    -

    Language Translator

    +

    Language Translator V2

    + +

    Deprecation Notice: +The IBM Watson Language Translator V2 service has been deprecated and replaced by the IBM Watson Language Translator V3 service. +Please use the LanguageTranslatorV3 class instead of LanguageTranslator. +The LanguageTranslator class will be removed in a future release.

    The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

    @@ -488,6 +491,25 @@

    Language Translator

    let password = "your-password-here" let languageTranslator = LanguageTranslator(username: username, password: password) +let failure = { (error: Error) in print(error) } +let request = TranslateRequest(text: ["Hello"], source: "en", target: "es") +languageTranslator.translate(request: request, failure: failure) { + translation in + print(translation) +} + +

    Language Translator V3

    + +

    The IBM Watson Language Translator service lets you select a domain, customize it, then identify or select the language of text, and then translate the text from one supported language to another.

    + +

    The following example demonstrates how to use the Language Translator service:

    +
    import LanguageTranslatorV3
    +
    +let username = "your-username-here"
    +let password = "your-password-here"
    +let version = "yyyy-mm-dd" // use today's date for the most recent version
    +let languageTranslator = LanguageTranslator(username: username, password: password, version: version)
    +
     let failure = { (error: Error) in print(error) }
     let request = TranslateRequest(text: ["Hello"], source: "en", target: "es")
     languageTranslator.translate(request: request, failure: failure) {
    @@ -878,7 +900,7 @@ 

    Visual Recognition

    let apiKey = "your-apikey-here" let version = "YYYY-MM-DD" // use today's date for the most recent version -let visualRecognition = VisualRecognition(apiKey: apiKey, version: version) +let visualRecognition = VisualRecognition(version: version, apiKey: apiKey) let url = "your-image-url" let failure = { (error: Error) in print(error) } @@ -886,6 +908,10 @@

    Visual Recognition

    print(classifiedImages) }
    + +

    Note: a different initializer is used for authentication with instances created before May 23, 2018:

    +
    let visualRecognition = VisualRecognition(apiKey: apiKey, version: version)
    +

    Using Core ML

    The Watson Swift SDK supports offline image classification using Apple Core ML. Classifiers must be trained or updated with the coreMLEnabled flag set to true. Once the classifier’s coreMLStatus is ready then a Core ML model is available to download and use for offline classification.

    @@ -937,7 +963,7 @@

    Bundlin diff --git a/docs/swift-api/services/VisualRecognitionV3/search.json b/docs/swift-api/services/VisualRecognitionV3/search.json index 0ec7f2e84..644419c2f 100644 --- a/docs/swift-api/services/VisualRecognitionV3/search.json +++ b/docs/swift-api/services/VisualRecognitionV3/search.json @@ -1 +1 @@ -{"Structs/WarningInfo.html#/s:19VisualRecognitionV311WarningInfoV9warningIDSSvp":{"name":"warningID","abstract":"

    Codified warning string, such as limit_reached.

    ","parent_name":"WarningInfo"},"Structs/WarningInfo.html#/s:19VisualRecognitionV311WarningInfoV11descriptionSSvp":{"name":"description","abstract":"

    Information about the error.

    ","parent_name":"WarningInfo"},"Structs/PositiveExample.html#/s:19VisualRecognitionV315PositiveExampleV4nameSSvp":{"name":"name","abstract":"

    The name of the class.

    ","parent_name":"PositiveExample"},"Structs/PositiveExample.html#/s:19VisualRecognitionV315PositiveExampleV8examples10Foundation3URLVvp":{"name":"examples","abstract":"

    A compressed (.zip) file of images that prominently","parent_name":"PositiveExample"},"Structs/PositiveExample.html#/s:19VisualRecognitionV315PositiveExampleVACSS4name_10Foundation3URLV8examplestcfc":{"name":"init(name:examples:)","abstract":"

    Define a set of positive examples that shall be recognized by a classifier.

    ","parent_name":"PositiveExample"},"Structs/ImageWithFaces.html#/s:19VisualRecognitionV314ImageWithFacesV5facesSayAA4FaceVGvp":{"name":"faces","abstract":"

    Faces detected in the images.

    ","parent_name":"ImageWithFaces"},"Structs/ImageWithFaces.html#/s:19VisualRecognitionV314ImageWithFacesV5imageSSSgvp":{"name":"image","abstract":"

    Relative path of the image file if uploaded directly. Not returned when the image is passed by URL.

    ","parent_name":"ImageWithFaces"},"Structs/ImageWithFaces.html#/s:19VisualRecognitionV314ImageWithFacesV9sourceUrlSSSgvp":{"name":"sourceUrl","abstract":"

    Source of the image before any redirects. Not returned when the image is uploaded.

    ","parent_name":"ImageWithFaces"},"Structs/ImageWithFaces.html#/s:19VisualRecognitionV314ImageWithFacesV11resolvedUrlSSSgvp":{"name":"resolvedUrl","abstract":"

    Fully resolved URL of the image after redirects are followed. Not returned when the image is uploaded.

    ","parent_name":"ImageWithFaces"},"Structs/ImageWithFaces.html#/s:19VisualRecognitionV314ImageWithFacesV5errorAA9ErrorInfoVSgvp":{"name":"error","abstract":"

    Information about what might have caused a failure, such as an image that is too large. Not returned when there is no error.

    ","parent_name":"ImageWithFaces"},"Structs/FaceLocation.html#/s:19VisualRecognitionV312FaceLocationV5widthSdvp":{"name":"width","abstract":"

    Width in pixels of face region.

    ","parent_name":"FaceLocation"},"Structs/FaceLocation.html#/s:19VisualRecognitionV312FaceLocationV6heightSdvp":{"name":"height","abstract":"

    Height in pixels of face region.

    ","parent_name":"FaceLocation"},"Structs/FaceLocation.html#/s:19VisualRecognitionV312FaceLocationV4leftSdvp":{"name":"left","abstract":"

    X-position of top-left pixel of face region.

    ","parent_name":"FaceLocation"},"Structs/FaceLocation.html#/s:19VisualRecognitionV312FaceLocationV3topSdvp":{"name":"top","abstract":"

    Y-position of top-left pixel of face region.

    ","parent_name":"FaceLocation"},"Structs/FaceIdentity.html#/s:19VisualRecognitionV312FaceIdentityV4nameSSvp":{"name":"name","abstract":"

    Name of the person.

    ","parent_name":"FaceIdentity"},"Structs/FaceIdentity.html#/s:19VisualRecognitionV312FaceIdentityV5scoreSdSgvp":{"name":"score","abstract":"

    Confidence score for the property in the range of 0 to 1. A higher score indicates greater likelihood that the class is depicted in the image. The default threshold for returning scores from a classifier is 0.5.

    ","parent_name":"FaceIdentity"},"Structs/FaceIdentity.html#/s:19VisualRecognitionV312FaceIdentityV13typeHierarchySSSgvp":{"name":"typeHierarchy","abstract":"

    Knowledge graph of the property. For example, People/Leaders/Presidents/USA/Barack Obama. Included only if identified.

    ","parent_name":"FaceIdentity"},"Structs/FaceIdentity.html#/s:19VisualRecognitionV312FaceIdentityVACSS4name_SdSg5scoreSSSg13typeHierarchytcfc":{"name":"init(name:score:typeHierarchy:)","abstract":"

    Initialize a FaceIdentity with member variables.

    ","parent_name":"FaceIdentity"},"Structs/FaceIdentity.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"FaceIdentity"},"Structs/FaceIdentity.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"FaceIdentity"},"Structs/FaceGender.html#/s:19VisualRecognitionV310FaceGenderV6genderSSvp":{"name":"gender","abstract":"

    Gender identified by the face. For example, MALE or FEMALE.

    ","parent_name":"FaceGender"},"Structs/FaceGender.html#/s:19VisualRecognitionV310FaceGenderV5scoreSdSgvp":{"name":"score","abstract":"

    Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the property.

    ","parent_name":"FaceGender"},"Structs/FaceAge.html#/s:19VisualRecognitionV37FaceAgeV3minSiSgvp":{"name":"min","abstract":"

    Estimated minimum age.

    ","parent_name":"FaceAge"},"Structs/FaceAge.html#/s:19VisualRecognitionV37FaceAgeV3maxSiSgvp":{"name":"max","abstract":"

    Estimated maximum age.

    ","parent_name":"FaceAge"},"Structs/FaceAge.html#/s:19VisualRecognitionV37FaceAgeV5scoreSdSgvp":{"name":"score","abstract":"

    Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the property.

    ","parent_name":"FaceAge"},"Structs/Face.html#/s:19VisualRecognitionV34FaceV3ageAA0D3AgeVSgvp":{"name":"age","abstract":"

    Age information about a face.

    ","parent_name":"Face"},"Structs/Face.html#/s:19VisualRecognitionV34FaceV6genderAA0D6GenderVSgvp":{"name":"gender","abstract":"

    Information about the gender of the face.

    ","parent_name":"Face"},"Structs/Face.html#/s:19VisualRecognitionV34FaceV12faceLocationAA0dF0VSgvp":{"name":"faceLocation","abstract":"

    The location of the bounding box around the face.

    ","parent_name":"Face"},"Structs/Face.html#/s:19VisualRecognitionV34FaceV8identityAA0D8IdentityVSgvp":{"name":"identity","abstract":"

    Undocumented

    ","parent_name":"Face"},"Structs/ErrorInfo.html#/s:19VisualRecognitionV39ErrorInfoV4codeSivp":{"name":"code","abstract":"

    HTTP status code.

    ","parent_name":"ErrorInfo"},"Structs/ErrorInfo.html#/s:19VisualRecognitionV39ErrorInfoV11descriptionSSvp":{"name":"description","abstract":"

    Human-readable error description. For example, File size limit exceeded.

    ","parent_name":"ErrorInfo"},"Structs/ErrorInfo.html#/s:19VisualRecognitionV39ErrorInfoV7errorIDSSvp":{"name":"errorID","abstract":"

    Codified error string. For example, limit_exceeded.

    ","parent_name":"ErrorInfo"},"Structs/DetectedFaces.html#/s:19VisualRecognitionV313DetectedFacesV15imagesProcessedSiSgvp":{"name":"imagesProcessed","abstract":"

    Number of images processed for the API call.

    ","parent_name":"DetectedFaces"},"Structs/DetectedFaces.html#/s:19VisualRecognitionV313DetectedFacesV6imagesSayAA09ImageWithE0VGvp":{"name":"images","abstract":"

    The images.

    ","parent_name":"DetectedFaces"},"Structs/DetectedFaces.html#/s:19VisualRecognitionV313DetectedFacesV8warningsSayAA11WarningInfoVGSgvp":{"name":"warnings","abstract":"

    Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file and a list of image URLs will still complete, but does not return the expected output. Not returned when there is no warning.

    ","parent_name":"DetectedFaces"},"Structs/Classifiers.html#/s:19VisualRecognitionV311ClassifiersV11classifiersSayAA10ClassifierVGvp":{"name":"classifiers","abstract":"

    List of classifiers.

    ","parent_name":"Classifiers"},"Structs/ClassifierResult.html#/s:19VisualRecognitionV316ClassifierResultV4nameSSvp":{"name":"name","abstract":"

    Name of the classifier.

    ","parent_name":"ClassifierResult"},"Structs/ClassifierResult.html#/s:19VisualRecognitionV316ClassifierResultV12classifierIDSSvp":{"name":"classifierID","abstract":"

    ID of a classifier identified in the image.

    ","parent_name":"ClassifierResult"},"Structs/ClassifierResult.html#/s:19VisualRecognitionV316ClassifierResultV7classesSayAA05ClassE0VGvp":{"name":"classes","abstract":"

    Classes within the classifier.

    ","parent_name":"ClassifierResult"},"Structs/Classifier/Status.html#/s:19VisualRecognitionV310ClassifierV6StatusO5readyA2EmF":{"name":"ready","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Classifier/Status.html#/s:19VisualRecognitionV310ClassifierV6StatusO8trainingA2EmF":{"name":"training","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Classifier/Status.html#/s:19VisualRecognitionV310ClassifierV6StatusO10retrainingA2EmF":{"name":"retraining","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Classifier/Status.html#/s:19VisualRecognitionV310ClassifierV6StatusO6failedA2EmF":{"name":"failed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Classifier/Status.html":{"name":"Status","abstract":"

    Training status of classifier.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV12classifierIDSSvp":{"name":"classifierID","abstract":"

    ID of a classifier identified in the image.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV4nameSSvp":{"name":"name","abstract":"

    Name of the classifier.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV5ownerSSSgvp":{"name":"owner","abstract":"

    Unique ID of the account who owns the classifier. Returned when verbose=true. Might not be returned by some requests.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV6statusSSSgvp":{"name":"status","abstract":"

    Training status of classifier.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV13coreMlEnabledSbvp":{"name":"coreMlEnabled","abstract":"

    Whether the classifier can be downloaded as a Core ML model after the training status is ready.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV11explanationSSSgvp":{"name":"explanation","abstract":"

    If classifier training has failed, this field may explain why.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV7createdSSSgvp":{"name":"created","abstract":"

    Date and time in Coordinated Universal Time (UTC) that the classifier was created.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV7classesSayAA5ClassVGSgvp":{"name":"classes","abstract":"

    Classes that define a classifier.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV9retrainedSSSgvp":{"name":"retrained","abstract":"

    Date and time in Coordinated Universal Time (UTC) that the classifier was updated. Returned when verbose=true. Might not be returned by some requests. Identical to updated and retained for backward compatibility.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV7updatedSSSgvp":{"name":"updated","abstract":"

    Date and time in Coordinated Universal Time (UTC) that the classifier was most recently updated. The field matches either retrained or created. Returned when verbose=true. Might not be returned by some requests.

    ","parent_name":"Classifier"},"Structs/ClassifiedImages.html#/s:19VisualRecognitionV316ClassifiedImagesV13customClassesSiSgvp":{"name":"customClasses","abstract":"

    Number of custom classes identified in the images.

    ","parent_name":"ClassifiedImages"},"Structs/ClassifiedImages.html#/s:19VisualRecognitionV316ClassifiedImagesV15imagesProcessedSiSgvp":{"name":"imagesProcessed","abstract":"

    Number of images processed for the API call.

    ","parent_name":"ClassifiedImages"},"Structs/ClassifiedImages.html#/s:19VisualRecognitionV316ClassifiedImagesV6imagesSayAA0D5ImageVGvp":{"name":"images","abstract":"

    Classified images.

    ","parent_name":"ClassifiedImages"},"Structs/ClassifiedImages.html#/s:19VisualRecognitionV316ClassifiedImagesV8warningsSayAA11WarningInfoVGSgvp":{"name":"warnings","abstract":"

    Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file and a list of image URLs will still complete, but does not return the expected output. Not returned when there is no warning.

    ","parent_name":"ClassifiedImages"},"Structs/ClassifiedImage.html#/s:19VisualRecognitionV315ClassifiedImageV9sourceUrlSSSgvp":{"name":"sourceUrl","abstract":"

    Source of the image before any redirects. Not returned when the image is uploaded.

    ","parent_name":"ClassifiedImage"},"Structs/ClassifiedImage.html#/s:19VisualRecognitionV315ClassifiedImageV11resolvedUrlSSSgvp":{"name":"resolvedUrl","abstract":"

    Fully resolved URL of the image after redirects are followed. Not returned when the image is uploaded.

    ","parent_name":"ClassifiedImage"},"Structs/ClassifiedImage.html#/s:19VisualRecognitionV315ClassifiedImageV5imageSSSgvp":{"name":"image","abstract":"

    Relative path of the image file if uploaded directly. Not returned when the image is passed by URL.

    ","parent_name":"ClassifiedImage"},"Structs/ClassifiedImage.html#/s:19VisualRecognitionV315ClassifiedImageV5errorAA9ErrorInfoVSgvp":{"name":"error","abstract":"

    Information about what might have caused a failure, such as an image that is too large. Not returned when there is no error.

    ","parent_name":"ClassifiedImage"},"Structs/ClassifiedImage.html#/s:19VisualRecognitionV315ClassifiedImageV11classifiersSayAA16ClassifierResultVGvp":{"name":"classifiers","abstract":"

    The classifiers.

    ","parent_name":"ClassifiedImage"},"Structs/ClassResult.html#/s:19VisualRecognitionV311ClassResultV9classNameSSvp":{"name":"className","abstract":"

    Name of the class.

    ","parent_name":"ClassResult"},"Structs/ClassResult.html#/s:19VisualRecognitionV311ClassResultV5scoreSdSgvp":{"name":"score","abstract":"

    Confidence score for the property in the range of 0 to 1. A higher score indicates greater likelihood that the class is depicted in the image. The default threshold for returning scores from a classifier is 0.5.

    ","parent_name":"ClassResult"},"Structs/ClassResult.html#/s:19VisualRecognitionV311ClassResultV13typeHierarchySSSgvp":{"name":"typeHierarchy","abstract":"

    Knowledge graph of the property. For example, /fruit/pome/apple/eating apple/Granny Smith. Included only if identified.

    ","parent_name":"ClassResult"},"Structs/Class.html#/s:19VisualRecognitionV35ClassV9classNameSSvp":{"name":"className","abstract":"

    The name of the class.

    ","parent_name":"Class"},"Structs.html#/s:19VisualRecognitionV311JSONWrapperV":{"name":"JSONWrapper","abstract":"

    Used internally to serialize and deserialize JSON."},"Structs/Class.html":{"name":"Class","abstract":"

    A category within a classifier.

    "},"Structs/ClassResult.html":{"name":"ClassResult","abstract":"

    Result of a class within a classifier.

    "},"Structs/ClassifiedImage.html":{"name":"ClassifiedImage","abstract":"

    Results for one image.

    "},"Structs/ClassifiedImages.html":{"name":"ClassifiedImages","abstract":"

    Results for all images.

    "},"Structs/Classifier.html":{"name":"Classifier","abstract":"

    Information about a classifier.

    "},"Structs/ClassifierResult.html":{"name":"ClassifierResult","abstract":"

    Classifier and score combination.

    "},"Structs/Classifiers.html":{"name":"Classifiers","abstract":"

    A container for the list of classifiers.

    "},"Structs/DetectedFaces.html":{"name":"DetectedFaces","abstract":"

    Results for all faces.

    "},"Structs/ErrorInfo.html":{"name":"ErrorInfo","abstract":"

    Information about what might have caused a failure, such as an image that is too large. Not returned when there is no error.

    "},"Structs/Face.html":{"name":"Face","abstract":"

    Information about the face.

    "},"Structs/FaceAge.html":{"name":"FaceAge","abstract":"

    Age information about a face.

    "},"Structs/FaceGender.html":{"name":"FaceGender","abstract":"

    Information about the gender of the face.

    "},"Structs/FaceIdentity.html":{"name":"FaceIdentity","abstract":"

    Provides information about a celebrity who is detected in the image. Not returned when a celebrity is not detected.

    "},"Structs/FaceLocation.html":{"name":"FaceLocation","abstract":"

    The location of the bounding box around the face.

    "},"Structs/ImageWithFaces.html":{"name":"ImageWithFaces","abstract":"

    Information about faces in the image.

    "},"Structs/PositiveExample.html":{"name":"PositiveExample","abstract":"

    A class associated with a Visual Recognition classifier.

    "},"Structs/WarningInfo.html":{"name":"WarningInfo","abstract":"

    Information about something that went wrong.

    "},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

    No response was received from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

    No data was returned from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO013serializationE0A2CmF":{"name":"serializationError","abstract":"

    Failed to serialize value(s) to data.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO08encodingE0A2CmF":{"name":"encodingError","abstract":"

    Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO011fileManagerE0A2CmF":{"name":"fileManagerError","abstract":"

    FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

    Failed to load the given file.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

    An HTTP error with a status code and description.

    ","parent_name":"RestError"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO4nullA2CmF":{"name":"null","abstract":"

    A null value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

    A boolean value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO6stringACSScACmF":{"name":"string","abstract":"

    A string value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO3intACSicACmF":{"name":"int","abstract":"

    A number value, represented as an integer.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO6doubleACSdcACmF":{"name":"double","abstract":"

    A number value, represented as a double.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

    An array value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

    An object value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Decode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

    Initialize a JSON value from an encodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

    Convert this JSON value to a decodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

    Encode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compare two JSON values for equality.

    ","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

    A JSON value (one of string, number, object, array, true, false, or null).

    "},"Enums/RestError.html":{"name":"RestError","abstract":"

    An error from processing a network request or response.

    "},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

    The base URL to use when contacting the service.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

    The default HTTP headers for all requests to the service.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0CACSS6apiKey_SS7versiontcfc":{"name":"init(apiKey:version:)","abstract":"

    Create a VisualRecognition object.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

    Create a VisualRecognition object.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

    Create a VisualRecognition object.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

    Undocumented

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C8classifyy10Foundation3URLVSg10imagesFile_SSSg3urlSdSg9thresholdSaySSGSg6ownersAO13classifierIDsAJ14acceptLanguages10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA16ClassifiedImagesVc7successtF":{"name":"classify(imagesFile:url:threshold:owners:classifierIDs:acceptLanguage:headers:failure:success:)","abstract":"

    Classify images.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C11detectFacesy10Foundation3URLVSg10imagesFile_SSSg3urls10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA08DetectedE0Vc7successtF":{"name":"detectFaces(imagesFile:url:headers:failure:success:)","abstract":"

    Detect faces in images.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C16createClassifierySS4name_SayAA15PositiveExampleVG16positiveExamples10Foundation3URLVSg08negativeJ0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0E0Vc7successtF":{"name":"createClassifier(name:positiveExamples:negativeExamples:headers:failure:success:)","abstract":"

    Create a classifier.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C15listClassifiersySaySSGSg6owners_SbSg7verboses10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0E0Vc7successtF":{"name":"listClassifiers(owners:verbose:headers:failure:success:)","abstract":"

    Retrieve a list of classifiers.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C13getClassifierySS12classifierID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0E0Vc7successtF":{"name":"getClassifier(classifierID:headers:failure:success:)","abstract":"

    Retrieve classifier details.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C16updateClassifierySS12classifierID_SayAA15PositiveExampleVGSg16positiveExamples10Foundation3URLVSg08negativeK0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0E0Vc7successtF":{"name":"updateClassifier(classifierID:positiveExamples:negativeExamples:headers:failure:success:)","abstract":"

    Update a classifier.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C16deleteClassifierySS12classifierID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteClassifier(classifierID:headers:failure:success:)","abstract":"

    Delete a classifier.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C14getCoreMlModelySS12classifierID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failurey10Foundation3URLVc7successtF":{"name":"getCoreMlModel(classifierID:headers:failure:success:)","abstract":"

    Retrieve a Core ML model of a classifier.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

    Delete labeled data.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C13getLocalModelSo7MLModelCSS12classifierID_tKF":{"name":"getLocalModel(classifierID:)","abstract":"

    Retrieve a Core ML model from the local filesystem.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C16updateLocalModelySS12classifierID_ys5Error_pcSg7failureyycSg7successtF":{"name":"updateLocalModel(classifierID:failure:success:)","abstract":"

    Download the latest Core ML model to the local filesystem, unless the latest version","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C15listLocalModelsSaySSGyKF":{"name":"listLocalModels()","abstract":"

    List the Core ML models stored in the local filesystem.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C16deleteLocalModelySS12classifierID_tKF":{"name":"deleteLocalModel(classifierID:)","abstract":"

    Delete a Core ML model from the local filesystem.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C22classifyWithLocalModelySo7UIImageC5image_SaySSG13classifierIDsSdSg9thresholdys5Error_pcSg7failureyAA16ClassifiedImagesVc7successtF":{"name":"classifyWithLocalModel(image:classifierIDs:threshold:failure:success:)","abstract":"

    Classify an image using a Core ML model from the local filesystem.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C8classifyySo7UIImageC5image_SdSg9thresholdSaySSGSg6ownersAK13classifierIDsSSSg14acceptLanguageys5Error_pcSg7failureyAA16ClassifiedImagesVc7successtF":{"name":"classify(image:threshold:owners:classifierIDs:acceptLanguage:failure:success:)","abstract":"

    Classify images.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C11detectFacesySo7UIImageC5image_ys5Error_pcSg7failureyAA08DetectedE0Vc7successtF":{"name":"detectFaces(image:failure:success:)","abstract":"

    Detect faces in images.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html":{"name":"VisualRecognition","abstract":"

    The IBM Watson Visual Recognition service uses deep learning algorithms to identify scenes, objects, and faces in"},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "}} \ No newline at end of file +{"Structs/WarningInfo.html#/s:19VisualRecognitionV311WarningInfoV9warningIDSSvp":{"name":"warningID","abstract":"

    Codified warning string, such as limit_reached.

    ","parent_name":"WarningInfo"},"Structs/WarningInfo.html#/s:19VisualRecognitionV311WarningInfoV11descriptionSSvp":{"name":"description","abstract":"

    Information about the error.

    ","parent_name":"WarningInfo"},"Structs/PositiveExample.html#/s:19VisualRecognitionV315PositiveExampleV4nameSSvp":{"name":"name","abstract":"

    The name of the class.

    ","parent_name":"PositiveExample"},"Structs/PositiveExample.html#/s:19VisualRecognitionV315PositiveExampleV8examples10Foundation3URLVvp":{"name":"examples","abstract":"

    A compressed (.zip) file of images that prominently","parent_name":"PositiveExample"},"Structs/PositiveExample.html#/s:19VisualRecognitionV315PositiveExampleVACSS4name_10Foundation3URLV8examplestcfc":{"name":"init(name:examples:)","abstract":"

    Define a set of positive examples that shall be recognized by a classifier.

    ","parent_name":"PositiveExample"},"Structs/ImageWithFaces.html#/s:19VisualRecognitionV314ImageWithFacesV5facesSayAA4FaceVGvp":{"name":"faces","abstract":"

    Faces detected in the images.

    ","parent_name":"ImageWithFaces"},"Structs/ImageWithFaces.html#/s:19VisualRecognitionV314ImageWithFacesV5imageSSSgvp":{"name":"image","abstract":"

    Relative path of the image file if uploaded directly. Not returned when the image is passed by URL.

    ","parent_name":"ImageWithFaces"},"Structs/ImageWithFaces.html#/s:19VisualRecognitionV314ImageWithFacesV9sourceUrlSSSgvp":{"name":"sourceUrl","abstract":"

    Source of the image before any redirects. Not returned when the image is uploaded.

    ","parent_name":"ImageWithFaces"},"Structs/ImageWithFaces.html#/s:19VisualRecognitionV314ImageWithFacesV11resolvedUrlSSSgvp":{"name":"resolvedUrl","abstract":"

    Fully resolved URL of the image after redirects are followed. Not returned when the image is uploaded.

    ","parent_name":"ImageWithFaces"},"Structs/ImageWithFaces.html#/s:19VisualRecognitionV314ImageWithFacesV5errorAA9ErrorInfoVSgvp":{"name":"error","abstract":"

    Information about what might have caused a failure, such as an image that is too large. Not returned when there is","parent_name":"ImageWithFaces"},"Structs/FaceLocation.html#/s:19VisualRecognitionV312FaceLocationV5widthSdvp":{"name":"width","abstract":"

    Width in pixels of face region.

    ","parent_name":"FaceLocation"},"Structs/FaceLocation.html#/s:19VisualRecognitionV312FaceLocationV6heightSdvp":{"name":"height","abstract":"

    Height in pixels of face region.

    ","parent_name":"FaceLocation"},"Structs/FaceLocation.html#/s:19VisualRecognitionV312FaceLocationV4leftSdvp":{"name":"left","abstract":"

    X-position of top-left pixel of face region.

    ","parent_name":"FaceLocation"},"Structs/FaceLocation.html#/s:19VisualRecognitionV312FaceLocationV3topSdvp":{"name":"top","abstract":"

    Y-position of top-left pixel of face region.

    ","parent_name":"FaceLocation"},"Structs/FaceIdentity.html#/s:19VisualRecognitionV312FaceIdentityV4nameSSvp":{"name":"name","abstract":"

    Name of the person.

    ","parent_name":"FaceIdentity"},"Structs/FaceIdentity.html#/s:19VisualRecognitionV312FaceIdentityV5scoreSdSgvp":{"name":"score","abstract":"

    Confidence score for the property in the range of 0 to 1. A higher score indicates greater likelihood that the class is depicted in the image. The default threshold for returning scores from a classifier is 0.5.

    ","parent_name":"FaceIdentity"},"Structs/FaceIdentity.html#/s:19VisualRecognitionV312FaceIdentityV13typeHierarchySSSgvp":{"name":"typeHierarchy","abstract":"

    Knowledge graph of the property. For example, People/Leaders/Presidents/USA/Barack Obama. Included only if identified.

    ","parent_name":"FaceIdentity"},"Structs/FaceIdentity.html#/s:19VisualRecognitionV312FaceIdentityVACSS4name_SdSg5scoreSSSg13typeHierarchytcfc":{"name":"init(name:score:typeHierarchy:)","abstract":"

    Initialize a FaceIdentity with member variables.

    ","parent_name":"FaceIdentity"},"Structs/FaceIdentity.html#/s:s9DecodablePxs7Decoder_p4from_tKcfc":{"name":"init(from:)","parent_name":"FaceIdentity"},"Structs/FaceIdentity.html#/s:s9EncodableP6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","parent_name":"FaceIdentity"},"Structs/FaceGender.html#/s:19VisualRecognitionV310FaceGenderV6genderSSvp":{"name":"gender","abstract":"

    Gender identified by the face. For example, MALE or FEMALE.

    ","parent_name":"FaceGender"},"Structs/FaceGender.html#/s:19VisualRecognitionV310FaceGenderV5scoreSdSgvp":{"name":"score","abstract":"

    Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the","parent_name":"FaceGender"},"Structs/FaceAge.html#/s:19VisualRecognitionV37FaceAgeV3minSiSgvp":{"name":"min","abstract":"

    Estimated minimum age.

    ","parent_name":"FaceAge"},"Structs/FaceAge.html#/s:19VisualRecognitionV37FaceAgeV3maxSiSgvp":{"name":"max","abstract":"

    Estimated maximum age.

    ","parent_name":"FaceAge"},"Structs/FaceAge.html#/s:19VisualRecognitionV37FaceAgeV5scoreSdSgvp":{"name":"score","abstract":"

    Confidence score in the range of 0 to 1. A higher score indicates greater confidence in the estimated value for the","parent_name":"FaceAge"},"Structs/Face.html#/s:19VisualRecognitionV34FaceV3ageAA0D3AgeVSgvp":{"name":"age","abstract":"

    Age information about a face.

    ","parent_name":"Face"},"Structs/Face.html#/s:19VisualRecognitionV34FaceV6genderAA0D6GenderVSgvp":{"name":"gender","abstract":"

    Information about the gender of the face.

    ","parent_name":"Face"},"Structs/Face.html#/s:19VisualRecognitionV34FaceV12faceLocationAA0dF0VSgvp":{"name":"faceLocation","abstract":"

    The location of the bounding box around the face.

    ","parent_name":"Face"},"Structs/Face.html#/s:19VisualRecognitionV34FaceV8identityAA0D8IdentityVSgvp":{"name":"identity","abstract":"

    deprecated

    ","parent_name":"Face"},"Structs/ErrorInfo.html#/s:19VisualRecognitionV39ErrorInfoV4codeSivp":{"name":"code","abstract":"

    HTTP status code.

    ","parent_name":"ErrorInfo"},"Structs/ErrorInfo.html#/s:19VisualRecognitionV39ErrorInfoV11descriptionSSvp":{"name":"description","abstract":"

    Human-readable error description. For example, File size limit exceeded.

    ","parent_name":"ErrorInfo"},"Structs/ErrorInfo.html#/s:19VisualRecognitionV39ErrorInfoV7errorIDSSvp":{"name":"errorID","abstract":"

    Codified error string. For example, limit_exceeded.

    ","parent_name":"ErrorInfo"},"Structs/DetectedFaces.html#/s:19VisualRecognitionV313DetectedFacesV15imagesProcessedSiSgvp":{"name":"imagesProcessed","abstract":"

    Number of images processed for the API call.

    ","parent_name":"DetectedFaces"},"Structs/DetectedFaces.html#/s:19VisualRecognitionV313DetectedFacesV6imagesSayAA09ImageWithE0VGvp":{"name":"images","abstract":"

    The images.

    ","parent_name":"DetectedFaces"},"Structs/DetectedFaces.html#/s:19VisualRecognitionV313DetectedFacesV8warningsSayAA11WarningInfoVGSgvp":{"name":"warnings","abstract":"

    Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file","parent_name":"DetectedFaces"},"Structs/Classifiers.html#/s:19VisualRecognitionV311ClassifiersV11classifiersSayAA10ClassifierVGvp":{"name":"classifiers","abstract":"

    List of classifiers.

    ","parent_name":"Classifiers"},"Structs/ClassifierResult.html#/s:19VisualRecognitionV316ClassifierResultV4nameSSvp":{"name":"name","abstract":"

    Name of the classifier.

    ","parent_name":"ClassifierResult"},"Structs/ClassifierResult.html#/s:19VisualRecognitionV316ClassifierResultV12classifierIDSSvp":{"name":"classifierID","abstract":"

    ID of a classifier identified in the image.

    ","parent_name":"ClassifierResult"},"Structs/ClassifierResult.html#/s:19VisualRecognitionV316ClassifierResultV7classesSayAA05ClassE0VGvp":{"name":"classes","abstract":"

    Classes within the classifier.

    ","parent_name":"ClassifierResult"},"Structs/Classifier/Status.html#/s:19VisualRecognitionV310ClassifierV6StatusO5readyA2EmF":{"name":"ready","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Classifier/Status.html#/s:19VisualRecognitionV310ClassifierV6StatusO8trainingA2EmF":{"name":"training","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Classifier/Status.html#/s:19VisualRecognitionV310ClassifierV6StatusO10retrainingA2EmF":{"name":"retraining","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Classifier/Status.html#/s:19VisualRecognitionV310ClassifierV6StatusO6failedA2EmF":{"name":"failed","abstract":"

    Undocumented

    ","parent_name":"Status"},"Structs/Classifier/Status.html":{"name":"Status","abstract":"

    Training status of classifier.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV12classifierIDSSvp":{"name":"classifierID","abstract":"

    ID of a classifier identified in the image.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV4nameSSvp":{"name":"name","abstract":"

    Name of the classifier.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV5ownerSSSgvp":{"name":"owner","abstract":"

    Unique ID of the account who owns the classifier. Returned when verbose=true. Might not be returned by some","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV6statusSSSgvp":{"name":"status","abstract":"

    Training status of classifier.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV13coreMlEnabledSbSgvp":{"name":"coreMlEnabled","abstract":"

    Whether the classifier can be downloaded as a Core ML model after the training status is ready.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV11explanationSSSgvp":{"name":"explanation","abstract":"

    If classifier training has failed, this field may explain why.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV7createdSSSgvp":{"name":"created","abstract":"

    Date and time in Coordinated Universal Time (UTC) that the classifier was created.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV7classesSayAA5ClassVGSgvp":{"name":"classes","abstract":"

    Classes that define a classifier.

    ","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV9retrainedSSSgvp":{"name":"retrained","abstract":"

    Date and time in Coordinated Universal Time (UTC) that the classifier was updated. Returned when verbose=true.","parent_name":"Classifier"},"Structs/Classifier.html#/s:19VisualRecognitionV310ClassifierV7updatedSSSgvp":{"name":"updated","abstract":"

    Date and time in Coordinated Universal Time (UTC) that the classifier was most recently updated. The field matches","parent_name":"Classifier"},"Structs/ClassifiedImages.html#/s:19VisualRecognitionV316ClassifiedImagesV13customClassesSiSgvp":{"name":"customClasses","abstract":"

    Number of custom classes identified in the images.

    ","parent_name":"ClassifiedImages"},"Structs/ClassifiedImages.html#/s:19VisualRecognitionV316ClassifiedImagesV15imagesProcessedSiSgvp":{"name":"imagesProcessed","abstract":"

    Number of images processed for the API call.

    ","parent_name":"ClassifiedImages"},"Structs/ClassifiedImages.html#/s:19VisualRecognitionV316ClassifiedImagesV6imagesSayAA0D5ImageVGvp":{"name":"images","abstract":"

    Classified images.

    ","parent_name":"ClassifiedImages"},"Structs/ClassifiedImages.html#/s:19VisualRecognitionV316ClassifiedImagesV8warningsSayAA11WarningInfoVGSgvp":{"name":"warnings","abstract":"

    Information about what might cause less than optimal output. For example, a request sent with a corrupt .zip file","parent_name":"ClassifiedImages"},"Structs/ClassifiedImage.html#/s:19VisualRecognitionV315ClassifiedImageV9sourceUrlSSSgvp":{"name":"sourceUrl","abstract":"

    Source of the image before any redirects. Not returned when the image is uploaded.

    ","parent_name":"ClassifiedImage"},"Structs/ClassifiedImage.html#/s:19VisualRecognitionV315ClassifiedImageV11resolvedUrlSSSgvp":{"name":"resolvedUrl","abstract":"

    Fully resolved URL of the image after redirects are followed. Not returned when the image is uploaded.

    ","parent_name":"ClassifiedImage"},"Structs/ClassifiedImage.html#/s:19VisualRecognitionV315ClassifiedImageV5imageSSSgvp":{"name":"image","abstract":"

    Relative path of the image file if uploaded directly. Not returned when the image is passed by URL.

    ","parent_name":"ClassifiedImage"},"Structs/ClassifiedImage.html#/s:19VisualRecognitionV315ClassifiedImageV5errorAA9ErrorInfoVSgvp":{"name":"error","abstract":"

    Information about what might have caused a failure, such as an image that is too large. Not returned when there is","parent_name":"ClassifiedImage"},"Structs/ClassifiedImage.html#/s:19VisualRecognitionV315ClassifiedImageV11classifiersSayAA16ClassifierResultVGvp":{"name":"classifiers","abstract":"

    The classifiers.

    ","parent_name":"ClassifiedImage"},"Structs/ClassResult.html#/s:19VisualRecognitionV311ClassResultV9classNameSSvp":{"name":"className","abstract":"

    Name of the class.

    ","parent_name":"ClassResult"},"Structs/ClassResult.html#/s:19VisualRecognitionV311ClassResultV5scoreSdSgvp":{"name":"score","abstract":"

    Confidence score for the property in the range of 0 to 1. A higher score indicates greater likelihood that the","parent_name":"ClassResult"},"Structs/ClassResult.html#/s:19VisualRecognitionV311ClassResultV13typeHierarchySSSgvp":{"name":"typeHierarchy","abstract":"

    Knowledge graph of the property. For example, /fruit/pome/apple/eating apple/Granny Smith. Included only if","parent_name":"ClassResult"},"Structs/Class.html#/s:19VisualRecognitionV35ClassV9classNameSSvp":{"name":"className","abstract":"

    The name of the class.

    ","parent_name":"Class"},"Structs/Class.html":{"name":"Class","abstract":"

    A category within a classifier.

    "},"Structs/ClassResult.html":{"name":"ClassResult","abstract":"

    Result of a class within a classifier.

    "},"Structs/ClassifiedImage.html":{"name":"ClassifiedImage","abstract":"

    Results for one image.

    "},"Structs/ClassifiedImages.html":{"name":"ClassifiedImages","abstract":"

    Results for all images.

    "},"Structs/Classifier.html":{"name":"Classifier","abstract":"

    Information about a classifier.

    "},"Structs/ClassifierResult.html":{"name":"ClassifierResult","abstract":"

    Classifier and score combination.

    "},"Structs/Classifiers.html":{"name":"Classifiers","abstract":"

    A container for the list of classifiers.

    "},"Structs/DetectedFaces.html":{"name":"DetectedFaces","abstract":"

    Results for all faces.

    "},"Structs/ErrorInfo.html":{"name":"ErrorInfo","abstract":"

    Information about what might have caused a failure, such as an image that is too large. Not returned when there is no error.

    "},"Structs/Face.html":{"name":"Face","abstract":"

    Information about the face.

    "},"Structs/FaceAge.html":{"name":"FaceAge","abstract":"

    Age information about a face.

    "},"Structs/FaceGender.html":{"name":"FaceGender","abstract":"

    Information about the gender of the face.

    "},"Structs/FaceIdentity.html":{"name":"FaceIdentity","abstract":"

    Provides information about a celebrity who is detected in the image. Not returned when a celebrity is not detected.

    "},"Structs/FaceLocation.html":{"name":"FaceLocation","abstract":"

    The location of the bounding box around the face.

    "},"Structs/ImageWithFaces.html":{"name":"ImageWithFaces","abstract":"

    Information about faces in the image.

    "},"Structs/PositiveExample.html":{"name":"PositiveExample","abstract":"

    A class associated with a Visual Recognition classifier.

    "},"Structs/WarningInfo.html":{"name":"WarningInfo","abstract":"

    Information about something that went wrong.

    "},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO10noResponseA2CmF":{"name":"noResponse","abstract":"

    No response was received from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO6noDataA2CmF":{"name":"noData","abstract":"

    No data was returned from the server.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO013serializationE0A2CmF":{"name":"serializationError","abstract":"

    Failed to serialize value(s) to data.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO08encodingE0A2CmF":{"name":"encodingError","abstract":"

    Failed to replace special characters in the","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO011fileManagerE0A2CmF":{"name":"fileManagerError","abstract":"

    FileManager failed to handle the given file.","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO11invalidFileA2CmF":{"name":"invalidFile","abstract":"

    Failed to load the given file.

    ","parent_name":"RestError"},"Enums/RestError.html#/s:19VisualRecognitionV39RestErrorO7failureACSi_SStcACmF":{"name":"failure","abstract":"

    An HTTP error with a status code and description.

    ","parent_name":"RestError"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO4nullA2CmF":{"name":"null","abstract":"

    A null value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO7booleanACSbcACmF":{"name":"boolean","abstract":"

    A boolean value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO6stringACSScACmF":{"name":"string","abstract":"

    A string value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO3intACSicACmF":{"name":"int","abstract":"

    A number value, represented as an integer.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO6doubleACSdcACmF":{"name":"double","abstract":"

    A number value, represented as a double.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO5arrayACSayACGcACmF":{"name":"array","abstract":"

    An array value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO6objectACs10DictionaryVySSACGcACmF":{"name":"object","abstract":"

    An object value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONOACs7Decoder_p4from_tKcfc":{"name":"init(from:)","abstract":"

    Decode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONOACx4from_tKcs9EncodableRzlufc":{"name":"init(from:)","abstract":"

    Initialize a JSON value from an encodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO7toValuexxmKs9DecodableRzlF":{"name":"toValue(_:)","abstract":"

    Convert this JSON value to a decodable type.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO6encodeys7Encoder_p2to_tKF":{"name":"encode(to:)","abstract":"

    Encode a JSON value.

    ","parent_name":"JSON"},"Enums/JSON.html#/s:19VisualRecognitionV34JSONO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compare two JSON values for equality.

    ","parent_name":"JSON"},"Enums/JSON.html":{"name":"JSON","abstract":"

    A JSON value (one of string, number, object, array, true, false, or null).

    "},"Enums/RestError.html":{"name":"RestError","abstract":"

    An error from processing a network request or response.

    "},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C10serviceURLSSvp":{"name":"serviceURL","abstract":"

    The base URL to use when contacting the service.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C14defaultHeaderss10DictionaryVyS2SGvp":{"name":"defaultHeaders","abstract":"

    The default HTTP headers for all requests to the service.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0CACSS6apiKey_SS7versiontcfc":{"name":"init(apiKey:version:)","abstract":"

    Create a VisualRecognition object.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0CACSS7version_SS6apiKeySSSg6iamUrltcfc":{"name":"init(version:apiKey:iamUrl:)","abstract":"

    Create a VisualRecognition object.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0CACSS7version_SS11accessTokentcfc":{"name":"init(version:accessToken:)","abstract":"

    Create a VisualRecognition object.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C11accessTokenySSF":{"name":"accessToken(_:)","abstract":"

    Undocumented

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C8classifyy10Foundation3URLVSg10imagesFile_SSSg3urlSdSg9thresholdSaySSGSg6ownersAO13classifierIDsAJ14acceptLanguages10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA16ClassifiedImagesVc7successtF":{"name":"classify(imagesFile:url:threshold:owners:classifierIDs:acceptLanguage:headers:failure:success:)","abstract":"

    Classify images.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C11detectFacesy10Foundation3URLVSg10imagesFile_SSSg3urls10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA08DetectedE0Vc7successtF":{"name":"detectFaces(imagesFile:url:headers:failure:success:)","abstract":"

    Detect faces in images.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C16createClassifierySS4name_SayAA15PositiveExampleVG16positiveExamples10Foundation3URLVSg08negativeJ0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0E0Vc7successtF":{"name":"createClassifier(name:positiveExamples:negativeExamples:headers:failure:success:)","abstract":"

    Create a classifier.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C15listClassifiersySaySSGSg6owners_SbSg7verboses10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0E0Vc7successtF":{"name":"listClassifiers(owners:verbose:headers:failure:success:)","abstract":"

    Retrieve a list of classifiers.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C13getClassifierySS12classifierID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0E0Vc7successtF":{"name":"getClassifier(classifierID:headers:failure:success:)","abstract":"

    Retrieve classifier details.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C16updateClassifierySS12classifierID_SayAA15PositiveExampleVGSg16positiveExamples10Foundation3URLVSg08negativeK0s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyAA0E0Vc7successtF":{"name":"updateClassifier(classifierID:positiveExamples:negativeExamples:headers:failure:success:)","abstract":"

    Update a classifier.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C16deleteClassifierySS12classifierID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteClassifier(classifierID:headers:failure:success:)","abstract":"

    Delete a classifier.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C14getCoreMlModelySS12classifierID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failurey10Foundation3URLVc7successtF":{"name":"getCoreMlModel(classifierID:headers:failure:success:)","abstract":"

    Retrieve a Core ML model of a classifier.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C14deleteUserDataySS10customerID_s10DictionaryVyS2SGSg7headersys5Error_pcSg7failureyyc7successtF":{"name":"deleteUserData(customerID:headers:failure:success:)","abstract":"

    Delete labeled data.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C13getLocalModelSo7MLModelCSS12classifierID_tKF":{"name":"getLocalModel(classifierID:)","abstract":"

    Retrieve a Core ML model from the local filesystem.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C16updateLocalModelySS12classifierID_ys5Error_pcSg7failureyycSg7successtF":{"name":"updateLocalModel(classifierID:failure:success:)","abstract":"

    Download the latest Core ML model to the local filesystem, unless the latest version","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C15listLocalModelsSaySSGyKF":{"name":"listLocalModels()","abstract":"

    List the Core ML models stored in the local filesystem.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C16deleteLocalModelySS12classifierID_tKF":{"name":"deleteLocalModel(classifierID:)","abstract":"

    Delete a Core ML model from the local filesystem.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C22classifyWithLocalModelySo7UIImageC5image_SaySSG13classifierIDsSdSg9thresholdys5Error_pcSg7failureyAA16ClassifiedImagesVc7successtF":{"name":"classifyWithLocalModel(image:classifierIDs:threshold:failure:success:)","abstract":"

    Classify an image using a Core ML model from the local filesystem.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C8classifyySo7UIImageC5image_SdSg9thresholdSaySSGSg6ownersAK13classifierIDsSSSg14acceptLanguageys5Error_pcSg7failureyAA16ClassifiedImagesVc7successtF":{"name":"classify(image:threshold:owners:classifierIDs:acceptLanguage:failure:success:)","abstract":"

    Classify images.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html#/s:19VisualRecognitionV30aB0C11detectFacesySo7UIImageC5image_ys5Error_pcSg7failureyAA08DetectedE0Vc7successtF":{"name":"detectFaces(image:failure:success:)","abstract":"

    Detect faces in images.

    ","parent_name":"VisualRecognition"},"Classes/VisualRecognition.html":{"name":"VisualRecognition","abstract":"

    The IBM Watson™ Visual Recognition service uses deep learning algorithms to identify scenes, objects, and faces"},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "}} \ No newline at end of file diff --git a/docs/swift-api/services/VisualRecognitionV3/undocumented.json b/docs/swift-api/services/VisualRecognitionV3/undocumented.json index 40bdac602..fdf87f976 100644 --- a/docs/swift-api/services/VisualRecognitionV3/undocumented.json +++ b/docs/swift-api/services/VisualRecognitionV3/undocumented.json @@ -2,39 +2,32 @@ "warnings": [ { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/VisualRecognitionV3/Models/Classifier.swift", - "line": 24, + "line": 26, "symbol": "Classifier.Status.ready", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/VisualRecognitionV3/Models/Classifier.swift", - "line": 25, + "line": 27, "symbol": "Classifier.Status.training", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/VisualRecognitionV3/Models/Classifier.swift", - "line": 26, + "line": 28, "symbol": "Classifier.Status.retraining", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/VisualRecognitionV3/Models/Classifier.swift", - "line": 27, + "line": 29, "symbol": "Classifier.Status.failed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, - { - "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/VisualRecognitionV3/Models/Face.swift", - "line": 31, - "symbol": "Face.identity", - "symbol_kind": "source.lang.swift.decl.var.instance", - "warning": "undocumented" - }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/VisualRecognitionV3/VisualRecognition.swift", "line": 74, diff --git a/docs/swift-api/undocumented.json b/docs/swift-api/undocumented.json index 6d93d7c6b..2a2bc1ba7 100644 --- a/docs/swift-api/undocumented.json +++ b/docs/swift-api/undocumented.json @@ -3,39 +3,32 @@ "warnings": [ { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/VisualRecognitionV3/Models/Classifier.swift", - "line": 24, + "line": 26, "symbol": "Classifier.Status.ready", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/VisualRecognitionV3/Models/Classifier.swift", - "line": 25, + "line": 27, "symbol": "Classifier.Status.training", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/VisualRecognitionV3/Models/Classifier.swift", - "line": 26, + "line": 28, "symbol": "Classifier.Status.retraining", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/VisualRecognitionV3/Models/Classifier.swift", - "line": 27, + "line": 29, "symbol": "Classifier.Status.failed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, - { - "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/VisualRecognitionV3/Models/Face.swift", - "line": 31, - "symbol": "Face.identity", - "symbol_kind": "source.lang.swift.decl.var.instance", - "warning": "undocumented" - }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/VisualRecognitionV3/VisualRecognition.swift", "line": 74, @@ -62,308 +55,308 @@ "warnings": [ { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/CreateVoiceModel.swift", - "line": 24, + "line": 26, "symbol": "CreateVoiceModel.Language.deDe", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/CreateVoiceModel.swift", - "line": 25, + "line": 27, "symbol": "CreateVoiceModel.Language.enUs", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/CreateVoiceModel.swift", - "line": 26, + "line": 28, "symbol": "CreateVoiceModel.Language.enGb", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/CreateVoiceModel.swift", - "line": 27, + "line": 29, "symbol": "CreateVoiceModel.Language.esEs", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/CreateVoiceModel.swift", - "line": 28, + "line": 30, "symbol": "CreateVoiceModel.Language.esLa", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/CreateVoiceModel.swift", - "line": 29, + "line": 31, "symbol": "CreateVoiceModel.Language.esUs", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/CreateVoiceModel.swift", - "line": 30, + "line": 32, "symbol": "CreateVoiceModel.Language.frFr", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/CreateVoiceModel.swift", - "line": 31, + "line": 33, "symbol": "CreateVoiceModel.Language.itIt", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/CreateVoiceModel.swift", - "line": 32, + "line": 34, "symbol": "CreateVoiceModel.Language.jaJp", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/CreateVoiceModel.swift", - "line": 33, + "line": 35, "symbol": "CreateVoiceModel.Language.ptBr", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 24, + "line": 29, "symbol": "Translation.PartOfSpeech.josi", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 25, + "line": 30, "symbol": "Translation.PartOfSpeech.mesi", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 26, + "line": 31, "symbol": "Translation.PartOfSpeech.kigo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 27, + "line": 32, "symbol": "Translation.PartOfSpeech.gobi", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 28, + "line": 33, "symbol": "Translation.PartOfSpeech.dosi", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 29, + "line": 34, "symbol": "Translation.PartOfSpeech.jodo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 30, + "line": 35, "symbol": "Translation.PartOfSpeech.koyu", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 31, + "line": 36, "symbol": "Translation.PartOfSpeech.stbi", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 32, + "line": 37, "symbol": "Translation.PartOfSpeech.suji", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 33, + "line": 38, "symbol": "Translation.PartOfSpeech.kedo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 34, + "line": 39, "symbol": "Translation.PartOfSpeech.fuku", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 35, + "line": 40, "symbol": "Translation.PartOfSpeech.keyo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 36, + "line": 41, "symbol": "Translation.PartOfSpeech.stto", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 37, + "line": 42, "symbol": "Translation.PartOfSpeech.reta", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 38, + "line": 43, "symbol": "Translation.PartOfSpeech.stzo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 39, + "line": 44, "symbol": "Translation.PartOfSpeech.kato", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Translation.swift", - "line": 40, + "line": 45, "symbol": "Translation.PartOfSpeech.hoka", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 24, + "line": 29, "symbol": "Word.PartOfSpeech.josi", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 25, + "line": 30, "symbol": "Word.PartOfSpeech.mesi", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 26, + "line": 31, "symbol": "Word.PartOfSpeech.kigo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 27, + "line": 32, "symbol": "Word.PartOfSpeech.gobi", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 28, + "line": 33, "symbol": "Word.PartOfSpeech.dosi", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 29, + "line": 34, "symbol": "Word.PartOfSpeech.jodo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 30, + "line": 35, "symbol": "Word.PartOfSpeech.koyu", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 31, + "line": 36, "symbol": "Word.PartOfSpeech.stbi", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 32, + "line": 37, "symbol": "Word.PartOfSpeech.suji", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 33, + "line": 38, "symbol": "Word.PartOfSpeech.kedo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 34, + "line": 39, "symbol": "Word.PartOfSpeech.fuku", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 35, + "line": 40, "symbol": "Word.PartOfSpeech.keyo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 36, + "line": 41, "symbol": "Word.PartOfSpeech.stto", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 37, + "line": 42, "symbol": "Word.PartOfSpeech.reta", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 38, + "line": 43, "symbol": "Word.PartOfSpeech.stzo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 39, + "line": 44, "symbol": "Word.PartOfSpeech.kato", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/TextToSpeechV1/Models/Word.swift", - "line": 40, + "line": 45, "symbol": "Word.PartOfSpeech.hoka", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" @@ -382,406 +375,413 @@ "warnings": [ { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AcousticModel.swift", - "line": 24, + "line": 33, "symbol": "AcousticModel.Status.pending", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AcousticModel.swift", - "line": 25, + "line": 34, "symbol": "AcousticModel.Status.ready", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AcousticModel.swift", - "line": 26, + "line": 35, "symbol": "AcousticModel.Status.training", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AcousticModel.swift", - "line": 27, + "line": 36, "symbol": "AcousticModel.Status.available", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AcousticModel.swift", - "line": 28, + "line": 37, "symbol": "AcousticModel.Status.upgrading", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AcousticModel.swift", - "line": 29, + "line": 38, "symbol": "AcousticModel.Status.failed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioDetails.swift", - "line": 24, + "line": 30, "symbol": "AudioDetails.ModelType.audio", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioDetails.swift", - "line": 25, + "line": 31, "symbol": "AudioDetails.ModelType.archive", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioDetails.swift", - "line": 30, + "line": 32, + "symbol": "AudioDetails.ModelType.undetermined", + "symbol_kind": "source.lang.swift.decl.enumelement", + "warning": "undocumented" + }, + { + "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioDetails.swift", + "line": 42, "symbol": "AudioDetails.Compression.zip", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioDetails.swift", - "line": 31, + "line": 43, "symbol": "AudioDetails.Compression.gzip", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioListing.swift", - "line": 24, + "line": 33, "symbol": "AudioListing.Status.ok", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioListing.swift", - "line": 25, + "line": 34, "symbol": "AudioListing.Status.beingProcessed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioListing.swift", - "line": 26, + "line": 35, "symbol": "AudioListing.Status.invalid", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioResource.swift", - "line": 24, + "line": 33, "symbol": "AudioResource.Status.ok", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioResource.swift", - "line": 25, + "line": 34, "symbol": "AudioResource.Status.beingProcessed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/AudioResource.swift", - "line": 26, + "line": 35, "symbol": "AudioResource.Status.invalid", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/Corpus.swift", - "line": 24, + "line": 31, "symbol": "Corpus.Status.analyzed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/Corpus.swift", - "line": 25, + "line": 32, "symbol": "Corpus.Status.beingProcessed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/Corpus.swift", - "line": 26, + "line": 33, "symbol": "Corpus.Status.undetermined", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 24, + "line": 29, "symbol": "CreateAcousticModel.BaseModelName.arArBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 25, + "line": 30, "symbol": "CreateAcousticModel.BaseModelName.enGbBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 26, + "line": 31, "symbol": "CreateAcousticModel.BaseModelName.enGbNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 27, + "line": 32, "symbol": "CreateAcousticModel.BaseModelName.enUsBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 28, + "line": 33, "symbol": "CreateAcousticModel.BaseModelName.enUsNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 29, + "line": 34, "symbol": "CreateAcousticModel.BaseModelName.esEsBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 30, + "line": 35, "symbol": "CreateAcousticModel.BaseModelName.esEsNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 31, + "line": 36, "symbol": "CreateAcousticModel.BaseModelName.frFrBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 32, + "line": 37, "symbol": "CreateAcousticModel.BaseModelName.jaJpBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 33, + "line": 38, "symbol": "CreateAcousticModel.BaseModelName.jaJpNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 34, + "line": 39, "symbol": "CreateAcousticModel.BaseModelName.koKrBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 35, + "line": 40, "symbol": "CreateAcousticModel.BaseModelName.koKrNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 36, + "line": 41, "symbol": "CreateAcousticModel.BaseModelName.ptBrBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 37, + "line": 42, "symbol": "CreateAcousticModel.BaseModelName.ptBrNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 38, + "line": 43, "symbol": "CreateAcousticModel.BaseModelName.zhCnBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateAcousticModel.swift", - "line": 39, + "line": 44, "symbol": "CreateAcousticModel.BaseModelName.zhCnNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 24, + "line": 30, "symbol": "CreateLanguageModel.BaseModelName.enGbBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 25, + "line": 31, "symbol": "CreateLanguageModel.BaseModelName.enGbNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 26, + "line": 32, "symbol": "CreateLanguageModel.BaseModelName.enUsBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 27, + "line": 33, "symbol": "CreateLanguageModel.BaseModelName.enUsNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 28, + "line": 34, "symbol": "CreateLanguageModel.BaseModelName.esEsBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 29, + "line": 35, "symbol": "CreateLanguageModel.BaseModelName.esEsNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 30, + "line": 36, "symbol": "CreateLanguageModel.BaseModelName.frFrBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 31, + "line": 37, "symbol": "CreateLanguageModel.BaseModelName.jaJpBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 32, + "line": 38, "symbol": "CreateLanguageModel.BaseModelName.jaJpNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 33, + "line": 39, "symbol": "CreateLanguageModel.BaseModelName.koKrBroadbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/CreateLanguageModel.swift", - "line": 34, + "line": 40, "symbol": "CreateLanguageModel.BaseModelName.koKrNarrowbandmodel", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/LanguageModel.swift", - "line": 24, + "line": 33, "symbol": "LanguageModel.Status.pending", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/LanguageModel.swift", - "line": 25, + "line": 34, "symbol": "LanguageModel.Status.ready", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/LanguageModel.swift", - "line": 26, + "line": 35, "symbol": "LanguageModel.Status.training", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/LanguageModel.swift", - "line": 27, + "line": 36, "symbol": "LanguageModel.Status.available", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/LanguageModel.swift", - "line": 28, + "line": 37, "symbol": "LanguageModel.Status.upgrading", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/LanguageModel.swift", - "line": 29, + "line": 38, "symbol": "LanguageModel.Status.failed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/RecognitionJob.swift", - "line": 24, + "line": 34, "symbol": "RecognitionJob.Status.waiting", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/RecognitionJob.swift", - "line": 25, + "line": 35, "symbol": "RecognitionJob.Status.processing", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/RecognitionJob.swift", - "line": 26, + "line": 36, "symbol": "RecognitionJob.Status.completed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/RecognitionJob.swift", - "line": 27, + "line": 37, "symbol": "RecognitionJob.Status.failed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/RegisterStatus.swift", - "line": 24, + "line": 28, "symbol": "RegisterStatus.Status.created", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/SpeechToTextV1/Models/RegisterStatus.swift", - "line": 25, + "line": 29, "symbol": "RegisterStatus.Status.alreadyCreated", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" @@ -800,133 +800,133 @@ "warnings": [ { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/ContentItem.swift", - "line": 24, + "line": 27, "symbol": "ContentItem.Contenttype.plain", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/ContentItem.swift", - "line": 25, + "line": 28, "symbol": "ContentItem.Contenttype.html", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/ContentItem.swift", - "line": 30, + "line": 40, "symbol": "ContentItem.Language.ar", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/ContentItem.swift", - "line": 31, + "line": 41, "symbol": "ContentItem.Language.en", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/ContentItem.swift", - "line": 32, + "line": 42, "symbol": "ContentItem.Language.es", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/ContentItem.swift", - "line": 33, + "line": 43, "symbol": "ContentItem.Language.ja", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/ContentItem.swift", - "line": 34, + "line": 44, "symbol": "ContentItem.Language.ko", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Profile.swift", - "line": 24, + "line": 26, "symbol": "Profile.ProcessedLanguage.ar", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Profile.swift", - "line": 25, + "line": 27, "symbol": "Profile.ProcessedLanguage.en", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Profile.swift", - "line": 26, + "line": 28, "symbol": "Profile.ProcessedLanguage.es", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Profile.swift", - "line": 27, + "line": 29, "symbol": "Profile.ProcessedLanguage.ja", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Profile.swift", - "line": 28, + "line": 30, "symbol": "Profile.ProcessedLanguage.ko", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Trait.swift", - "line": 24, + "line": 27, "symbol": "Trait.Category.personality", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Trait.swift", - "line": 25, + "line": 28, "symbol": "Trait.Category.needs", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Trait.swift", - "line": 26, + "line": 29, "symbol": "Trait.Category.values", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Warning.swift", - "line": 24, + "line": 26, "symbol": "Warning.WarningID.wordCountMessage", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Warning.swift", - "line": 25, + "line": 27, "symbol": "Warning.WarningID.jsonAsText", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Warning.swift", - "line": 26, + "line": 28, "symbol": "Warning.WarningID.contentTruncated", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/PersonalityInsightsV3/Models/Warning.swift", - "line": 27, + "line": 29, "symbol": "Warning.WarningID.partialTextUsed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" @@ -959,28 +959,28 @@ }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesAction.swift", - "line": 28, + "line": 32, "symbol": "SemanticRolesAction.verb", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesObject.swift", - "line": 25, + "line": 27, "symbol": "SemanticRolesObject.keywords", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesSubject.swift", - "line": 25, + "line": 27, "symbol": "SemanticRolesSubject.entities", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/NaturalLanguageUnderstandingV1/Models/SemanticRolesSubject.swift", - "line": 27, + "line": 29, "symbol": "SemanticRolesSubject.keywords", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" @@ -999,35 +999,35 @@ "warnings": [ { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/NaturalLanguageClassifierV1/Models/Classifier.swift", - "line": 24, + "line": 26, "symbol": "Classifier.Status.nonExistent", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/NaturalLanguageClassifierV1/Models/Classifier.swift", - "line": 25, + "line": 27, "symbol": "Classifier.Status.training", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/NaturalLanguageClassifierV1/Models/Classifier.swift", - "line": 26, + "line": 28, "symbol": "Classifier.Status.failed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/NaturalLanguageClassifierV1/Models/Classifier.swift", - "line": 27, + "line": 29, "symbol": "Classifier.Status.available", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/NaturalLanguageClassifierV1/Models/Classifier.swift", - "line": 28, + "line": 30, "symbol": "Classifier.Status.unavailable", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" @@ -1046,70 +1046,70 @@ }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/LanguageTranslatorV2/Models/TranslationModel.swift", - "line": 24, + "line": 26, "symbol": "TranslationModel.Status.uploading", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/LanguageTranslatorV2/Models/TranslationModel.swift", - "line": 25, + "line": 27, "symbol": "TranslationModel.Status.uploaded", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/LanguageTranslatorV2/Models/TranslationModel.swift", - "line": 26, + "line": 28, "symbol": "TranslationModel.Status.dispatching", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/LanguageTranslatorV2/Models/TranslationModel.swift", - "line": 27, + "line": 29, "symbol": "TranslationModel.Status.queued", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/LanguageTranslatorV2/Models/TranslationModel.swift", - "line": 28, + "line": 30, "symbol": "TranslationModel.Status.training", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/LanguageTranslatorV2/Models/TranslationModel.swift", - "line": 29, + "line": 31, "symbol": "TranslationModel.Status.trained", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/LanguageTranslatorV2/Models/TranslationModel.swift", - "line": 30, + "line": 32, "symbol": "TranslationModel.Status.publishing", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/LanguageTranslatorV2/Models/TranslationModel.swift", - "line": 31, + "line": 33, "symbol": "TranslationModel.Status.available", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/LanguageTranslatorV2/Models/TranslationModel.swift", - "line": 32, + "line": 34, "symbol": "TranslationModel.Status.deleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/LanguageTranslatorV2/Models/TranslationModel.swift", - "line": 33, + "line": 35, "symbol": "TranslationModel.Status.error", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" @@ -1128,126 +1128,126 @@ }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Calculation.swift", - "line": 25, + "line": 27, "symbol": "Calculation.results", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Collection.swift", - "line": 24, + "line": 26, "symbol": "Collection.Status.active", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Collection.swift", - "line": 25, + "line": 27, "symbol": "Collection.Status.pending", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Collection.swift", - "line": 26, + "line": 28, "symbol": "Collection.Status.maintenance", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/CreateCollectionRequest.swift", - "line": 24, + "line": 26, "symbol": "CreateCollectionRequest.Language.en", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/CreateCollectionRequest.swift", - "line": 25, + "line": 27, "symbol": "CreateCollectionRequest.Language.es", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/CreateCollectionRequest.swift", - "line": 26, + "line": 28, "symbol": "CreateCollectionRequest.Language.de", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/CreateCollectionRequest.swift", - "line": 27, + "line": 29, "symbol": "CreateCollectionRequest.Language.ar", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/CreateCollectionRequest.swift", - "line": 28, + "line": 30, "symbol": "CreateCollectionRequest.Language.fr", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/CreateCollectionRequest.swift", - "line": 29, + "line": 31, "symbol": "CreateCollectionRequest.Language.it", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/CreateCollectionRequest.swift", - "line": 30, + "line": 32, "symbol": "CreateCollectionRequest.Language.ja", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/CreateCollectionRequest.swift", - "line": 31, + "line": 33, "symbol": "CreateCollectionRequest.Language.ko", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/CreateCollectionRequest.swift", - "line": 32, + "line": 34, "symbol": "CreateCollectionRequest.Language.pt", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DeleteCollectionResponse.swift", - "line": 24, + "line": 26, "symbol": "DeleteCollectionResponse.Status.deleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DeleteConfigurationResponse.swift", - "line": 24, + "line": 26, "symbol": "DeleteConfigurationResponse.Status.deleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DeleteDocumentResponse.swift", - "line": 24, + "line": 26, "symbol": "DeleteDocumentResponse.Status.deleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DeleteEnvironmentResponse.swift", - "line": 24, + "line": 26, "symbol": "DeleteEnvironmentResponse.Status.deleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DocumentAccepted.swift", - "line": 24, + "line": 26, "symbol": "DocumentAccepted.Status.processing", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" @@ -1317,161 +1317,161 @@ }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DocumentStatus.swift", - "line": 24, + "line": 26, "symbol": "DocumentStatus.Status.available", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DocumentStatus.swift", - "line": 25, + "line": 27, "symbol": "DocumentStatus.Status.availableWithNotices", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DocumentStatus.swift", - "line": 26, + "line": 28, "symbol": "DocumentStatus.Status.failed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DocumentStatus.swift", - "line": 27, + "line": 29, "symbol": "DocumentStatus.Status.processing", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DocumentStatus.swift", - "line": 32, + "line": 36, "symbol": "DocumentStatus.FileType.pdf", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DocumentStatus.swift", - "line": 33, + "line": 37, "symbol": "DocumentStatus.FileType.html", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DocumentStatus.swift", - "line": 34, + "line": 38, "symbol": "DocumentStatus.FileType.word", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/DocumentStatus.swift", - "line": 35, + "line": 39, "symbol": "DocumentStatus.FileType.json", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Environment.swift", - "line": 24, + "line": 26, "symbol": "Environment.Status.active", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Environment.swift", - "line": 25, + "line": 27, "symbol": "Environment.Status.pending", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Environment.swift", - "line": 26, + "line": 28, "symbol": "Environment.Status.maintenance", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 24, + "line": 26, "symbol": "Field.FieldType.nested", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 25, + "line": 27, "symbol": "Field.FieldType.string", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 26, + "line": 28, "symbol": "Field.FieldType.date", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 27, + "line": 29, "symbol": "Field.FieldType.long", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 28, + "line": 30, "symbol": "Field.FieldType.integer", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 29, + "line": 31, "symbol": "Field.FieldType.short", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 30, + "line": 32, "symbol": "Field.FieldType.byte", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 31, + "line": 33, "symbol": "Field.FieldType.double", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 32, + "line": 34, "symbol": "Field.FieldType.float", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 33, + "line": 35, "symbol": "Field.FieldType.boolean", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Field.swift", - "line": 34, + "line": 36, "symbol": "Field.FieldType.binary", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Filter.swift", - "line": 25, + "line": 27, "symbol": "Filter.results", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" @@ -1527,7 +1527,7 @@ }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Histogram.swift", - "line": 25, + "line": 27, "symbol": "Histogram.results", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" @@ -1576,56 +1576,56 @@ }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Nested.swift", - "line": 25, + "line": 27, "symbol": "Nested.results", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/NormalizationOperation.swift", - "line": 29, + "line": 42, "symbol": "NormalizationOperation.Operation.copy", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/NormalizationOperation.swift", - "line": 30, + "line": 43, "symbol": "NormalizationOperation.Operation.move", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/NormalizationOperation.swift", - "line": 31, + "line": 44, "symbol": "NormalizationOperation.Operation.merge", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/NormalizationOperation.swift", - "line": 32, + "line": 45, "symbol": "NormalizationOperation.Operation.remove", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/NormalizationOperation.swift", - "line": 33, + "line": 46, "symbol": "NormalizationOperation.Operation.removeNulls", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Notice.swift", - "line": 24, + "line": 26, "symbol": "Notice.Severity.warning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Notice.swift", - "line": 25, + "line": 27, "symbol": "Notice.Severity.error", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" @@ -1772,42 +1772,42 @@ }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/QueryNoticesResult.swift", - "line": 24, + "line": 26, "symbol": "QueryNoticesResult.FileType.pdf", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/QueryNoticesResult.swift", - "line": 25, + "line": 27, "symbol": "QueryNoticesResult.FileType.html", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/QueryNoticesResult.swift", - "line": 26, + "line": 28, "symbol": "QueryNoticesResult.FileType.word", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/QueryNoticesResult.swift", - "line": 27, + "line": 29, "symbol": "QueryNoticesResult.FileType.json", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/QueryRelations.swift", - "line": 24, + "line": 27, "symbol": "QueryRelations.Sort.score", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/QueryRelations.swift", - "line": 25, + "line": 28, "symbol": "QueryRelations.Sort.frequency", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" @@ -1863,35 +1863,35 @@ }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Term.swift", - "line": 25, + "line": 27, "symbol": "Term.results", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Term.swift", - "line": 36, + "line": 44, "symbol": "Term.count", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/Timeslice.swift", - "line": 25, + "line": 27, "symbol": "Timeslice.results", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/TopHits.swift", - "line": 25, + "line": 27, "symbol": "TopHits.results", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/DiscoveryV1/Models/TopHits.swift", - "line": 36, + "line": 44, "symbol": "TopHits.hits", "symbol_kind": "source.lang.swift.decl.var.instance", "warning": "undocumented" @@ -2092,700 +2092,700 @@ }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 24, + "line": 26, "symbol": "CreateDialogNode.NodeType.standard", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 25, + "line": 27, "symbol": "CreateDialogNode.NodeType.eventHandler", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 26, + "line": 28, "symbol": "CreateDialogNode.NodeType.frame", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 27, + "line": 29, "symbol": "CreateDialogNode.NodeType.slot", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 28, + "line": 30, "symbol": "CreateDialogNode.NodeType.responseCondition", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 29, + "line": 31, "symbol": "CreateDialogNode.NodeType.folder", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 34, + "line": 38, "symbol": "CreateDialogNode.EventName.focus", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 35, + "line": 39, "symbol": "CreateDialogNode.EventName.input", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 36, + "line": 40, "symbol": "CreateDialogNode.EventName.filled", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 37, + "line": 41, "symbol": "CreateDialogNode.EventName.validate", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 38, + "line": 42, "symbol": "CreateDialogNode.EventName.filledMultiple", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 39, + "line": 43, "symbol": "CreateDialogNode.EventName.generic", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 40, + "line": 44, "symbol": "CreateDialogNode.EventName.nomatch", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 41, + "line": 45, "symbol": "CreateDialogNode.EventName.nomatchResponsesDepleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 42, + "line": 46, "symbol": "CreateDialogNode.EventName.digressionReturnPrompt", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 47, + "line": 53, "symbol": "CreateDialogNode.DigressIn.notAvailable", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 48, + "line": 54, "symbol": "CreateDialogNode.DigressIn.returns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 49, + "line": 55, "symbol": "CreateDialogNode.DigressIn.doesNotReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 54, + "line": 62, "symbol": "CreateDialogNode.DigressOut.returning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 55, + "line": 63, "symbol": "CreateDialogNode.DigressOut.all", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 56, + "line": 64, "symbol": "CreateDialogNode.DigressOut.allNeverReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 61, + "line": 71, "symbol": "CreateDialogNode.DigressOutSlots.notAllowed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 62, + "line": 72, "symbol": "CreateDialogNode.DigressOutSlots.allowReturning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateDialogNode.swift", - "line": 63, + "line": 73, "symbol": "CreateDialogNode.DigressOutSlots.allowAll", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateValue.swift", - "line": 24, + "line": 26, "symbol": "CreateValue.ValueType.synonyms", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/CreateValue.swift", - "line": 25, + "line": 27, "symbol": "CreateValue.ValueType.patterns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 24, + "line": 26, "symbol": "DialogNode.NodeType.standard", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 25, + "line": 27, "symbol": "DialogNode.NodeType.eventHandler", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 26, + "line": 28, "symbol": "DialogNode.NodeType.frame", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 27, + "line": 29, "symbol": "DialogNode.NodeType.slot", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 28, + "line": 30, "symbol": "DialogNode.NodeType.responseCondition", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 29, + "line": 31, "symbol": "DialogNode.NodeType.folder", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 34, + "line": 38, "symbol": "DialogNode.EventName.focus", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 35, + "line": 39, "symbol": "DialogNode.EventName.input", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 36, + "line": 40, "symbol": "DialogNode.EventName.filled", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 37, + "line": 41, "symbol": "DialogNode.EventName.validate", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 38, + "line": 42, "symbol": "DialogNode.EventName.filledMultiple", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 39, + "line": 43, "symbol": "DialogNode.EventName.generic", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 40, + "line": 44, "symbol": "DialogNode.EventName.nomatch", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 41, + "line": 45, "symbol": "DialogNode.EventName.nomatchResponsesDepleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 42, + "line": 46, "symbol": "DialogNode.EventName.digressionReturnPrompt", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 47, + "line": 53, "symbol": "DialogNode.DigressIn.notAvailable", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 48, + "line": 54, "symbol": "DialogNode.DigressIn.returns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 49, + "line": 55, "symbol": "DialogNode.DigressIn.doesNotReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 54, + "line": 62, "symbol": "DialogNode.DigressOut.returning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 55, + "line": 63, "symbol": "DialogNode.DigressOut.all", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 56, + "line": 64, "symbol": "DialogNode.DigressOut.allNeverReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 61, + "line": 71, "symbol": "DialogNode.DigressOutSlots.notAllowed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 62, + "line": 72, "symbol": "DialogNode.DigressOutSlots.allowReturning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNode.swift", - "line": 63, + "line": 73, "symbol": "DialogNode.DigressOutSlots.allowAll", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeAction.swift", - "line": 24, + "line": 26, "symbol": "DialogNodeAction.ActionType.client", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeAction.swift", - "line": 25, + "line": 27, "symbol": "DialogNodeAction.ActionType.server", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeNextStep.swift", - "line": 24, + "line": 44, "symbol": "DialogNodeNextStep.Behavior.getUserInput", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeNextStep.swift", - "line": 25, + "line": 45, "symbol": "DialogNodeNextStep.Behavior.skipUserInput", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeNextStep.swift", - "line": 26, + "line": 46, "symbol": "DialogNodeNextStep.Behavior.jumpTo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeNextStep.swift", - "line": 27, + "line": 47, "symbol": "DialogNodeNextStep.Behavior.reprompt", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeNextStep.swift", - "line": 28, + "line": 48, "symbol": "DialogNodeNextStep.Behavior.skipSlot", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeNextStep.swift", - "line": 29, + "line": 49, "symbol": "DialogNodeNextStep.Behavior.skipAllSlots", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeNextStep.swift", - "line": 34, + "line": 56, "symbol": "DialogNodeNextStep.Selector.condition", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeNextStep.swift", - "line": 35, + "line": 57, "symbol": "DialogNodeNextStep.Selector.client", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeNextStep.swift", - "line": 36, + "line": 58, "symbol": "DialogNodeNextStep.Selector.userInput", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/DialogNodeNextStep.swift", - "line": 37, + "line": 59, "symbol": "DialogNodeNextStep.Selector.body", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/LogMessage.swift", - "line": 24, + "line": 26, "symbol": "LogMessage.Level.info", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/LogMessage.swift", - "line": 25, + "line": 27, "symbol": "LogMessage.Level.error", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/LogMessage.swift", - "line": 26, + "line": 28, "symbol": "LogMessage.Level.warn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 24, + "line": 26, "symbol": "UpdateDialogNode.NodeType.standard", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 25, + "line": 27, "symbol": "UpdateDialogNode.NodeType.eventHandler", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 26, + "line": 28, "symbol": "UpdateDialogNode.NodeType.frame", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 27, + "line": 29, "symbol": "UpdateDialogNode.NodeType.slot", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 28, + "line": 30, "symbol": "UpdateDialogNode.NodeType.responseCondition", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 29, + "line": 31, "symbol": "UpdateDialogNode.NodeType.folder", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 34, + "line": 38, "symbol": "UpdateDialogNode.EventName.focus", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 35, + "line": 39, "symbol": "UpdateDialogNode.EventName.input", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 36, + "line": 40, "symbol": "UpdateDialogNode.EventName.filled", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 37, + "line": 41, "symbol": "UpdateDialogNode.EventName.validate", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 38, + "line": 42, "symbol": "UpdateDialogNode.EventName.filledMultiple", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 39, + "line": 43, "symbol": "UpdateDialogNode.EventName.generic", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 40, + "line": 44, "symbol": "UpdateDialogNode.EventName.nomatch", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 41, + "line": 45, "symbol": "UpdateDialogNode.EventName.nomatchResponsesDepleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 42, + "line": 46, "symbol": "UpdateDialogNode.EventName.digressionReturnPrompt", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 47, + "line": 53, "symbol": "UpdateDialogNode.DigressIn.notAvailable", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 48, + "line": 54, "symbol": "UpdateDialogNode.DigressIn.returns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 49, + "line": 55, "symbol": "UpdateDialogNode.DigressIn.doesNotReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 54, + "line": 62, "symbol": "UpdateDialogNode.DigressOut.returning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 55, + "line": 63, "symbol": "UpdateDialogNode.DigressOut.all", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 56, + "line": 64, "symbol": "UpdateDialogNode.DigressOut.allNeverReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 61, + "line": 71, "symbol": "UpdateDialogNode.DigressOutSlots.notAllowed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 62, + "line": 72, "symbol": "UpdateDialogNode.DigressOutSlots.allowReturning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateDialogNode.swift", - "line": 63, + "line": 73, "symbol": "UpdateDialogNode.DigressOutSlots.allowAll", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateValue.swift", - "line": 24, + "line": 26, "symbol": "UpdateValue.ValueType.synonyms", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/UpdateValue.swift", - "line": 25, + "line": 27, "symbol": "UpdateValue.ValueType.patterns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/Value.swift", - "line": 24, + "line": 26, "symbol": "Value.ValueType.synonyms", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/Value.swift", - "line": 25, + "line": 27, "symbol": "Value.ValueType.patterns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/ValueExport.swift", - "line": 24, + "line": 26, "symbol": "ValueExport.ValueType.synonyms", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/ValueExport.swift", - "line": 25, + "line": 27, "symbol": "ValueExport.ValueType.patterns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/WorkspaceExport.swift", - "line": 24, + "line": 26, "symbol": "WorkspaceExport.Status.nonExistent", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/WorkspaceExport.swift", - "line": 25, + "line": 27, "symbol": "WorkspaceExport.Status.training", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/WorkspaceExport.swift", - "line": 26, + "line": 28, "symbol": "WorkspaceExport.Status.failed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/WorkspaceExport.swift", - "line": 27, + "line": 29, "symbol": "WorkspaceExport.Status.available", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/ConversationV1/Models/WorkspaceExport.swift", - "line": 28, + "line": 30, "symbol": "WorkspaceExport.Status.unavailable", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" @@ -2804,700 +2804,700 @@ }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 24, + "line": 26, "symbol": "CreateDialogNode.NodeType.standard", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 25, + "line": 27, "symbol": "CreateDialogNode.NodeType.eventHandler", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 26, + "line": 28, "symbol": "CreateDialogNode.NodeType.frame", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 27, + "line": 29, "symbol": "CreateDialogNode.NodeType.slot", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 28, + "line": 30, "symbol": "CreateDialogNode.NodeType.responseCondition", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 29, + "line": 31, "symbol": "CreateDialogNode.NodeType.folder", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 34, + "line": 38, "symbol": "CreateDialogNode.EventName.focus", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 35, + "line": 39, "symbol": "CreateDialogNode.EventName.input", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 36, + "line": 40, "symbol": "CreateDialogNode.EventName.filled", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 37, + "line": 41, "symbol": "CreateDialogNode.EventName.validate", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 38, + "line": 42, "symbol": "CreateDialogNode.EventName.filledMultiple", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 39, + "line": 43, "symbol": "CreateDialogNode.EventName.generic", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 40, + "line": 44, "symbol": "CreateDialogNode.EventName.nomatch", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 41, + "line": 45, "symbol": "CreateDialogNode.EventName.nomatchResponsesDepleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 42, + "line": 46, "symbol": "CreateDialogNode.EventName.digressionReturnPrompt", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 47, + "line": 53, "symbol": "CreateDialogNode.DigressIn.notAvailable", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 48, + "line": 54, "symbol": "CreateDialogNode.DigressIn.returns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 49, + "line": 55, "symbol": "CreateDialogNode.DigressIn.doesNotReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 54, + "line": 62, "symbol": "CreateDialogNode.DigressOut.returning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 55, + "line": 63, "symbol": "CreateDialogNode.DigressOut.all", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 56, + "line": 64, "symbol": "CreateDialogNode.DigressOut.allNeverReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 61, + "line": 71, "symbol": "CreateDialogNode.DigressOutSlots.notAllowed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 62, + "line": 72, "symbol": "CreateDialogNode.DigressOutSlots.allowReturning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateDialogNode.swift", - "line": 63, + "line": 73, "symbol": "CreateDialogNode.DigressOutSlots.allowAll", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateValue.swift", - "line": 24, + "line": 26, "symbol": "CreateValue.ValueType.synonyms", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/CreateValue.swift", - "line": 25, + "line": 27, "symbol": "CreateValue.ValueType.patterns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 24, + "line": 26, "symbol": "DialogNode.NodeType.standard", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 25, + "line": 27, "symbol": "DialogNode.NodeType.eventHandler", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 26, + "line": 28, "symbol": "DialogNode.NodeType.frame", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 27, + "line": 29, "symbol": "DialogNode.NodeType.slot", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 28, + "line": 30, "symbol": "DialogNode.NodeType.responseCondition", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 29, + "line": 31, "symbol": "DialogNode.NodeType.folder", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 34, + "line": 38, "symbol": "DialogNode.EventName.focus", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 35, + "line": 39, "symbol": "DialogNode.EventName.input", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 36, + "line": 40, "symbol": "DialogNode.EventName.filled", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 37, + "line": 41, "symbol": "DialogNode.EventName.validate", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 38, + "line": 42, "symbol": "DialogNode.EventName.filledMultiple", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 39, + "line": 43, "symbol": "DialogNode.EventName.generic", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 40, + "line": 44, "symbol": "DialogNode.EventName.nomatch", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 41, + "line": 45, "symbol": "DialogNode.EventName.nomatchResponsesDepleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 42, + "line": 46, "symbol": "DialogNode.EventName.digressionReturnPrompt", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 47, + "line": 53, "symbol": "DialogNode.DigressIn.notAvailable", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 48, + "line": 54, "symbol": "DialogNode.DigressIn.returns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 49, + "line": 55, "symbol": "DialogNode.DigressIn.doesNotReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 54, + "line": 62, "symbol": "DialogNode.DigressOut.returning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 55, + "line": 63, "symbol": "DialogNode.DigressOut.all", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 56, + "line": 64, "symbol": "DialogNode.DigressOut.allNeverReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 61, + "line": 71, "symbol": "DialogNode.DigressOutSlots.notAllowed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 62, + "line": 72, "symbol": "DialogNode.DigressOutSlots.allowReturning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNode.swift", - "line": 63, + "line": 73, "symbol": "DialogNode.DigressOutSlots.allowAll", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeAction.swift", - "line": 24, + "line": 26, "symbol": "DialogNodeAction.ActionType.client", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeAction.swift", - "line": 25, + "line": 27, "symbol": "DialogNodeAction.ActionType.server", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeNextStep.swift", - "line": 24, + "line": 44, "symbol": "DialogNodeNextStep.Behavior.getUserInput", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeNextStep.swift", - "line": 25, + "line": 45, "symbol": "DialogNodeNextStep.Behavior.skipUserInput", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeNextStep.swift", - "line": 26, + "line": 46, "symbol": "DialogNodeNextStep.Behavior.jumpTo", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeNextStep.swift", - "line": 27, + "line": 47, "symbol": "DialogNodeNextStep.Behavior.reprompt", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeNextStep.swift", - "line": 28, + "line": 48, "symbol": "DialogNodeNextStep.Behavior.skipSlot", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeNextStep.swift", - "line": 29, + "line": 49, "symbol": "DialogNodeNextStep.Behavior.skipAllSlots", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeNextStep.swift", - "line": 34, + "line": 56, "symbol": "DialogNodeNextStep.Selector.condition", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeNextStep.swift", - "line": 35, + "line": 57, "symbol": "DialogNodeNextStep.Selector.client", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeNextStep.swift", - "line": 36, + "line": 58, "symbol": "DialogNodeNextStep.Selector.userInput", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/DialogNodeNextStep.swift", - "line": 37, + "line": 59, "symbol": "DialogNodeNextStep.Selector.body", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/LogMessage.swift", - "line": 24, + "line": 26, "symbol": "LogMessage.Level.info", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/LogMessage.swift", - "line": 25, + "line": 27, "symbol": "LogMessage.Level.error", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/LogMessage.swift", - "line": 26, + "line": 28, "symbol": "LogMessage.Level.warn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 24, + "line": 26, "symbol": "UpdateDialogNode.NodeType.standard", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 25, + "line": 27, "symbol": "UpdateDialogNode.NodeType.eventHandler", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 26, + "line": 28, "symbol": "UpdateDialogNode.NodeType.frame", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 27, + "line": 29, "symbol": "UpdateDialogNode.NodeType.slot", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 28, + "line": 30, "symbol": "UpdateDialogNode.NodeType.responseCondition", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 29, + "line": 31, "symbol": "UpdateDialogNode.NodeType.folder", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 34, + "line": 38, "symbol": "UpdateDialogNode.EventName.focus", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 35, + "line": 39, "symbol": "UpdateDialogNode.EventName.input", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 36, + "line": 40, "symbol": "UpdateDialogNode.EventName.filled", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 37, + "line": 41, "symbol": "UpdateDialogNode.EventName.validate", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 38, + "line": 42, "symbol": "UpdateDialogNode.EventName.filledMultiple", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 39, + "line": 43, "symbol": "UpdateDialogNode.EventName.generic", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 40, + "line": 44, "symbol": "UpdateDialogNode.EventName.nomatch", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 41, + "line": 45, "symbol": "UpdateDialogNode.EventName.nomatchResponsesDepleted", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 42, + "line": 46, "symbol": "UpdateDialogNode.EventName.digressionReturnPrompt", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 47, + "line": 53, "symbol": "UpdateDialogNode.DigressIn.notAvailable", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 48, + "line": 54, "symbol": "UpdateDialogNode.DigressIn.returns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 49, + "line": 55, "symbol": "UpdateDialogNode.DigressIn.doesNotReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 54, + "line": 62, "symbol": "UpdateDialogNode.DigressOut.returning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 55, + "line": 63, "symbol": "UpdateDialogNode.DigressOut.all", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 56, + "line": 64, "symbol": "UpdateDialogNode.DigressOut.allNeverReturn", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 61, + "line": 71, "symbol": "UpdateDialogNode.DigressOutSlots.notAllowed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 62, + "line": 72, "symbol": "UpdateDialogNode.DigressOutSlots.allowReturning", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateDialogNode.swift", - "line": 63, + "line": 73, "symbol": "UpdateDialogNode.DigressOutSlots.allowAll", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateValue.swift", - "line": 24, + "line": 26, "symbol": "UpdateValue.ValueType.synonyms", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/UpdateValue.swift", - "line": 25, + "line": 27, "symbol": "UpdateValue.ValueType.patterns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/Value.swift", - "line": 24, + "line": 26, "symbol": "Value.ValueType.synonyms", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/Value.swift", - "line": 25, + "line": 27, "symbol": "Value.ValueType.patterns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/ValueExport.swift", - "line": 24, + "line": 26, "symbol": "ValueExport.ValueType.synonyms", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/ValueExport.swift", - "line": 25, + "line": 27, "symbol": "ValueExport.ValueType.patterns", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/WorkspaceExport.swift", - "line": 24, + "line": 26, "symbol": "WorkspaceExport.Status.nonExistent", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/WorkspaceExport.swift", - "line": 25, + "line": 27, "symbol": "WorkspaceExport.Status.training", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/WorkspaceExport.swift", - "line": 26, + "line": 28, "symbol": "WorkspaceExport.Status.failed", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/WorkspaceExport.swift", - "line": 27, + "line": 29, "symbol": "WorkspaceExport.Status.available", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented" }, { "file": "/Users/mkistler/Projects/watson-swift/wdc-swift-sdk/Source/AssistantV1/Models/WorkspaceExport.swift", - "line": 28, + "line": 30, "symbol": "WorkspaceExport.Status.unavailable", "symbol_kind": "source.lang.swift.decl.enumelement", "warning": "undocumented"