Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 1234567]

▼NIBM
▼NWatson
▼NAssistant
▶Nv1
▶NExamples
CServiceExample
▶NIntegrationTests
CAssistantServiceIntegrationTests
▶NModel
CAgentAvailabilityMessage	AgentAvailabilityMessage.
CBulkClassifyOutput	BulkClassifyOutput.
CBulkClassifyResponse	BulkClassifyResponse.
CBulkClassifyUtterance	The user input utterance to classify.
CCaptureGroup	A recognized capture group for a pattern-based entity.
CContext	State information for the conversation. To maintain state, include the context from the previous response.
CCounterexample	Counterexample.
CCounterexampleCollection	CounterexampleCollection.
CCreateEntity	CreateEntity.
CCreateIntent	CreateIntent.
▶CCreateValue	CreateValue.
CTypeEnumValue	Specifies the type of entity value.
▶CDialogNode	DialogNode.
CDigressInEnumValue	Whether this top-level dialog node can be digressed into.
CDigressOutEnumValue	Whether this dialog node can be returned to after a digression.
CDigressOutSlotsEnumValue	Whether the user can digress to top-level nodes while filling out slots.
CEventNameEnumValue	How an event_handler node is processed.
CTypeEnumValue	How the dialog node is processed.
▶CDialogNodeAction	DialogNodeAction.
CTypeEnumValue	The type of action to invoke.
CDialogNodeCollection	An array of dialog nodes.
CDialogNodeContext	The context for the dialog node.
▶CDialogNodeNextStep	The next step to execute following this dialog node.
CBehaviorEnumValue	What happens after the dialog node completes. The valid values depend on the node type:
CSelectorEnumValue	Which part of the dialog node to process next.
CDialogNodeOutput	The output of the dialog node. For more information about how to specify dialog node output, see the documentation.
CDialogNodeOutputConnectToAgentTransferInfo	Routing or other contextual information to be used by target service desk systems.
▶CDialogNodeOutputGeneric	DialogNodeOutputGeneric. Classes which extend this class:
CPreferenceEnumValue	The preferred type of control to display, if supported by the channel.
CQueryTypeEnumValue	The type of the search query.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
CSelectionPolicyEnumValue	How a response is selected from the list, if more than one response is specified.
▶CDialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent	An object that describes a response with response type connect_to_agent.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
▶CDialogNodeOutputGenericDialogNodeOutputResponseTypeImage	An object that describes a response with response type image.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
▶CDialogNodeOutputGenericDialogNodeOutputResponseTypeOption	An object that describes a response with response type option.
CPreferenceEnumValue	The preferred type of control to display, if supported by the channel.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
▶CDialogNodeOutputGenericDialogNodeOutputResponseTypePause	An object that describes a response with response type pause.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
▶CDialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill	An object that describes a response with response type search_skill.
CQueryTypeEnumValue	The type of the search query.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel
▶CDialogNodeOutputGenericDialogNodeOutputResponseTypeText	An object that describes a response with response type text.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
CSelectionPolicyEnumValue	How a response is selected from the list, if more than one response is specified.
CDialogNodeOutputModifiers	Options that modify how specified output is handled.
CDialogNodeOutputOptionsElement	DialogNodeOutputOptionsElement.
CDialogNodeOutputOptionsElementValue	An object defining the message input to be sent to the Watson Assistant service if the user selects the corresponding option.
CDialogNodeOutputTextValuesElement	DialogNodeOutputTextValuesElement.
CDialogNodeVisitedDetails	DialogNodeVisitedDetails.
CDialogSuggestion	DialogSuggestion.
CDialogSuggestionValue	An object defining the message input, intents, and entities to be sent to the Watson Assistant service if the user selects the corresponding disambiguation option.
CEntity	Entity.
CEntityCollection	An array of objects describing the entities for the workspace.
CEntityMention	An object describing a contextual entity mention.
CEntityMentionCollection	EntityMentionCollection.
CExample	Example.
CExampleCollection	ExampleCollection.
CIntent	Intent.
CIntentCollection	IntentCollection.
CLog	Log.
CLogCollection	LogCollection.
▶CLogMessage	Log message details.
CLevelEnumValue	The severity of the log message.
CLogPagination	The pagination data for the returned objects.
CMention	A mention of a contextual entity.
CMessageContextMetadata	Metadata related to the message.
CMessageInput	An input object that includes the input text.
CMessageRequest	A request sent to the workspace, including the user input and context.
CMessageResponse	The response sent by the workspace, including the output text, detected intents and entities, and context.
COutputData	An output object that includes the response to the user, the dialog nodes that were triggered, and messages from the log.
CPagination	The pagination data for the returned objects.
CRuntimeEntity	A term from the request that was identified as an entity.
CRuntimeEntityAlternative	An alternative value for the recognized entity.
▶CRuntimeEntityInterpretation	RuntimeEntityInterpretation.
CGranularityEnumValue	The precision or duration of a time range specified by a recognized @sys-time or @sys-date entity.
▶CRuntimeEntityRole	An object describing the role played by a system entity that is specifies the beginning or end of a range recognized in the user input. This property is included only if the new system entities are enabled for the workspace.
CTypeEnumValue	The relationship of the entity to the range.
CRuntimeIntent	An intent identified in the user input.
▶CRuntimeResponseGeneric	RuntimeResponseGeneric. Classes which extend this class:
CPreferenceEnumValue	The preferred type of control to display.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
▶CRuntimeResponseGenericRuntimeResponseTypeConnectToAgent	An object that describes a response with response type connect_to_agent.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
▶CRuntimeResponseGenericRuntimeResponseTypeImage	An object that describes a response with response type image.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
▶CRuntimeResponseGenericRuntimeResponseTypeOption	An object that describes a response with response type option.
CPreferenceEnumValue	The preferred type of control to display.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
▶CRuntimeResponseGenericRuntimeResponseTypePause	An object that describes a response with response type pause.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
▶CRuntimeResponseGenericRuntimeResponseTypeSuggestion	An object that describes a response with response type suggestion.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
▶CRuntimeResponseGenericRuntimeResponseTypeText	An object that describes a response with response type text.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
CSynonym	Synonym.
CSynonymCollection	SynonymCollection.
▶CValue	Value.
CTypeEnumValue	Specifies the type of entity value.
CValueCollection	ValueCollection.
CWebhook	A webhook that can be used by dialog nodes to make programmatic calls to an external function
CWebhookHeader	A key/value pair defining an HTTP header and a value.
▶CWorkspace	Workspace.
CStatusEnumValue	The current status of the workspace.
CWorkspaceCollection	WorkspaceCollection.
CWorkspaceSystemSettings	Global settings for the workspace.
▶CWorkspaceSystemSettingsDisambiguation	Workspace settings related to the disambiguation feature.
CSensitivityEnumValue	The sensitivity of the disambiguation feature to intent detection conflicts. Set to high if you want the disambiguation feature to be triggered more often. This can be useful for testing or demonstration purposes.
CWorkspaceSystemSettingsOffTopic	Workspace settings related to detection of irrelevant input.
CWorkspaceSystemSettingsSystemEntities	Workspace settings related to the behavior of system entities.
CWorkspaceSystemSettingsTooling	Workspace settings related to the Watson Assistant user interface.
▶NUnitTests
CAssistantServiceUnitTests
CAssistantUnitTests
▶CAssistantService
▶CGetWorkspaceEnums	Enum values for GetWorkspace.
CSortValue	Indicates how the returned workspace data will be sorted. This parameter is valid only if export=true. Specify sort=stable to sort all workspace objects by unique identifier, in ascending alphabetical order.
▶CListCounterexamplesEnums	Enum values for ListCounterexamples.
CSortValue	The attribute by which returned counterexamples will be sorted. To reverse the sort order, prefix the value with a minus sign (-).
▶CListDialogNodesEnums	Enum values for ListDialogNodes.
CSortValue	The attribute by which returned dialog nodes will be sorted. To reverse the sort order, prefix the value with a minus sign (-).
▶CListEntitiesEnums	Enum values for ListEntities.
CSortValue	The attribute by which returned entities will be sorted. To reverse the sort order, prefix the value with a minus sign (-).
▶CListExamplesEnums	Enum values for ListExamples.
CSortValue	The attribute by which returned examples will be sorted. To reverse the sort order, prefix the value with a minus sign (-).
▶CListIntentsEnums	Enum values for ListIntents.
CSortValue	The attribute by which returned intents will be sorted. To reverse the sort order, prefix the value with a minus sign (-).
▶CListSynonymsEnums	Enum values for ListSynonyms.
CSortValue	The attribute by which returned entity value synonyms will be sorted. To reverse the sort order, prefix the value with a minus sign (-).
▶CListValuesEnums	Enum values for ListValues.
CSortValue	The attribute by which returned entity values will be sorted. To reverse the sort order, prefix the value with a minus sign (-).
▶CListWorkspacesEnums	Enum values for ListWorkspaces.
CSortValue	The attribute by which returned workspaces will be sorted. To reverse the sort order, prefix the value with a minus sign (-).
CIAssistantService
▶Nv2
▶NExamples
CServiceExample
▶NIntegrationTests
CAssistantServiceIntegrationConfigTests
CAssistantServiceIntegrationTests
▶NModel
CAgentAvailabilityMessage	AgentAvailabilityMessage.
CBulkClassifyOutput	BulkClassifyOutput.
CBulkClassifyResponse	BulkClassifyResponse.
CBulkClassifyUtterance	The user input utterance to classify.
CCaptureGroup	CaptureGroup.
▶CDialogLogMessage	Dialog log message details.
CLevelEnumValue	The severity of the log message.
▶CDialogNodeAction	DialogNodeAction.
CTypeEnumValue	The type of action to invoke.
CDialogNodeOutputConnectToAgentTransferInfo	Routing or other contextual information to be used by target service desk systems.
CDialogNodeOutputOptionsElement	DialogNodeOutputOptionsElement.
CDialogNodeOutputOptionsElementValue	An object defining the message input to be sent to the assistant if the user selects the corresponding option.
CDialogNodesVisited	DialogNodesVisited.
CDialogSuggestion	DialogSuggestion.
CDialogSuggestionValue	An object defining the message input to be sent to the assistant if the user selects the corresponding disambiguation option.
CLog	Log.
CLogCollection	LogCollection.
CLogPagination	The pagination data for the returned objects.
CMessageContext	MessageContext.
CMessageContextGlobal	Session context data that is shared by all skills used by the Assistant.
CMessageContextGlobalStateless	Session context data that is shared by all skills used by the Assistant.
▶CMessageContextGlobalSystem	Built-in system properties that apply to all skills used by the assistant.
CLocaleEnumValue	The language code for localization in the user input. The specified locale overrides the default for the assistant, and is used for interpreting entity values in user input such as date values. For example, 04/03/2018 might be interpreted either as April 3 or March 4, depending on the locale
CMessageContextSkill	Contains information specific to a particular skill used by the Assistant. The property name must be the same as the name of the skill (for example, main skill).
CMessageContextSkillSystem	System context data used by the skill.
CMessageContextStateless	MessageContextStateless.
▶CMessageInput	An input object that includes the input text.
CMessageTypeEnumValue	The type of user input. Currently, only text input is supported.
CMessageInputOptions	Optional properties that control how the assistant responds.
CMessageInputOptionsSpelling	Spelling correction options for the message. Any options specified on an individual message override the settings configured for the skill.
CMessageInputOptionsStateless	Optional properties that control how the assistant responds.
▶CMessageInputStateless	An input object that includes the input text.
CMessageTypeEnumValue	The type of user input. Currently, only text input is supported.
CMessageOutput	Assistant output to be rendered or processed by the client.
▶CMessageOutputDebug	Additional detailed information about a message response and how it was generated.
CBranchExitedReasonEnumValue	When branch_exited is set to true by the Assistant, the branch_exited_reason specifies whether the dialog completed by itself or got interrupted.
CMessageOutputSpelling	Properties describing any spelling corrections in the user input that was received.
CMessageRequest	A stateful message request formatted for the Watson Assistant service.
CMessageResponse	A response from the Watson Assistant service.
CMessageResponseStateless	A stateless response from the Watson Assistant service.
CRuntimeEntity	The entity value that was recognized in the user input.
CRuntimeEntityAlternative	An alternative value for the recognized entity.
▶CRuntimeEntityInterpretation	RuntimeEntityInterpretation.
CGranularityEnumValue	The precision or duration of a time range specified by a recognized @sys-time or @sys-date entity.
▶CRuntimeEntityRole	An object describing the role played by a system entity that is specifies the beginning or end of a range recognized in the user input. This property is included only if the new system entities are enabled for the skill.
CTypeEnumValue	The relationship of the entity to the range.
CRuntimeIntent	An intent identified in the user input.
▶CRuntimeResponseGeneric	RuntimeResponseGeneric. Classes which extend this class:
CPreferenceEnumValue	The preferred type of control to display.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
▶CRuntimeResponseGenericRuntimeResponseTypeConnectToAgent	An object that describes a response with response type connect_to_agent.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
▶CRuntimeResponseGenericRuntimeResponseTypeImage	An object that describes a response with response type image.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
▶CRuntimeResponseGenericRuntimeResponseTypeOption	An object that describes a response with response type option.
CPreferenceEnumValue	The preferred type of control to display.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
▶CRuntimeResponseGenericRuntimeResponseTypePause	An object that describes a response with response type pause.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
▶CRuntimeResponseGenericRuntimeResponseTypeSearch	An object that describes a response with response type search.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
▶CRuntimeResponseGenericRuntimeResponseTypeSuggestion	An object that describes a response with response type suggestion.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
▶CRuntimeResponseGenericRuntimeResponseTypeText	An object that describes a response with response type text.
CResponseTypeEnumValue	The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
CSearchResult	SearchResult.
CSearchResultHighlight	An object containing segments of text from search results with query-matching text highlighted using HTML <em> tags.
CSearchResultMetadata	An object containing search result metadata from the Discovery service.
CSessionResponse	SessionResponse.
▶NUnitTests
CAssistantServiceUnitTests
CAssistantV2UnitTests
CAssistantService
CIAssistantService
▼NCompareComply
▶Nv1
▶NExamples
CServiceExample
▶NIntegrationTests
CCompareComplyServiceIntegrationTests
▶NModel
CAddress	A party's address.
CAlignedElement	AlignedElement.
▶CAttribute	List of document attributes.
CTypeEnumValue	The type of attribute.
CBatches	The results of a successful List Batches request.
▶CBatchStatus	The batch-request status.
CFunctionEnumValue	The method to be run against the documents. Possible values are html_conversion, element_classification, and tables.
CBodyCells	Cells that are not table header, column header, or row header cells.
▶CCategory	Information defining an element's subject matter.
CLabelEnumValue	The category of the associated element.
CModificationEnumValue	The type of modification of the feedback entry in the updated labels response.
▶CCategoryComparison	Information defining an element's subject matter.
CLabelEnumValue	The category of the associated element.
CClassifyReturn	The analysis of objects returned by the Element classification method.
CColumnHeaders	Column-level cells, each applicable as a header to other cells in the same column as itself, of the current table.
CCompareReturn	The comparison of the two submitted documents.
CContact	A contact.
CContexts	Text that is related to the contents of the table and that precedes or follows the current table.
▶CContractAmts	A monetary amount identified in the input document.
CConfidenceLevelEnumValue	The confidence level in the identification of the contract amount.
▶CContractCurrencies	The contract currencies that are declared in the document.
CConfidenceLevelEnumValue	The confidence level in the identification of the contract currency.
▶CContractTerms	The duration or durations of the contract.
CConfidenceLevelEnumValue	The confidence level in the identification of the contract term.
▶CContractTypes	The contract type identified in the input document.
CConfidenceLevelEnumValue	The confidence level in the identification of the contract type.
CDocCounts	Document counts.
CDocInfo	Information about the parsed input document.
CDocStructure	The structure of the input document.
CDocument	Basic information about the input document.
▶CEffectiveDates	An effective date.
CConfidenceLevelEnumValue	The confidence level in the identification of the effective date.
CElement	A component part of the document.
CElementLocations	A list of begin and end indexes that indicate the locations of the elements in the input document.
CElementPair	Details of semantically aligned elements.
CFeedbackDataInput	Feedback data for submission.
CFeedbackDataOutput	Information returned from the Add Feedback method.
CFeedbackDeleted	The status and message of the deletion request.
CFeedbackList	The results of a successful List Feedback request for all feedback.
CFeedbackReturn	Information about the document and the submitted feedback.
CGetFeedback	The results of a successful Get Feedback request for a single feedback entry.
CHTMLReturn	The HTML converted from an input document.
CInterpretation	The details of the normalized text, if applicable. This element is optional; it is returned only if normalized text exists.
CKey	A key in a key-value pair.
CKeyValuePair	Key-value pairs detected across cell boundaries.
CLabel	A pair of nature and party objects. The nature object identifies the effect of the element on the identified party, and the party object identifies the affected party.
CLeadingSentence	The leading sentences in a section or subsection of the input document.
CLocation	The numeric location of the identified element in the document, represented with two integers labeled begin and end.
CMention	A mention of a party.
COriginalLabelsIn	The original labeling from the input document, without the submitted feedback.
COriginalLabelsOut	The original labeling from the input document, without the submitted feedback.
CPagination	Pagination details, if required by the length of the output.
CParagraphs	The locations of each paragraph in the input document.
▶CParties	A party and its corresponding role, including address and contact information if identified.
CImportanceEnumValue	A string that identifies the importance of the party.
▶CPaymentTerms	The document's payment duration or durations.
CConfidenceLevelEnumValue	The confidence level in the identification of the payment term.
CRowHeaders	Row-level cells, each applicable as a header to other cells in the same row as itself, of the current table.
CSectionTitle	The table's section title, if identified.
CSectionTitles	An array containing one object per section or subsection detected in the input document. Sections and subsections are not nested; instead, they are flattened out and can be placed back in order by using the begin and end values of the element and the level value of the section.
CShortDoc	Brief information about the input document.
CTableHeaders	The contents of the current table's header.
CTableReturn	The analysis of the document's tables.
CTables	The contents of the tables extracted from a document.
CTableTitle	If identified, the title or caption of the current table of the form Table x.: .... Empty when no title is identified. When exposed, the title is also excluded from the contexts array of the same table.
▶CTerminationDates	Termination dates identified in the input document.
CConfidenceLevelEnumValue	The confidence level in the identification of the termination date.
▶CTypeLabel	Identification of a specific type.
CModificationEnumValue	The type of modification of the feedback entry in the updated labels response.
CTypeLabelComparison	Identification of a specific type.
CUnalignedElement	Element that does not align semantically between two compared documents.
CUpdatedLabelsIn	The updated labeling from the input document, accounting for the submitted feedback.
CUpdatedLabelsOut	The updated labeling from the input document, accounting for the submitted feedback.
CValue	A value in a key-value pair.
▶NUnitTests
CCompareComplyServiceUnitTests
▶CCompareComplyService
▶CClassifyElementsEnums	Enum values for ClassifyElements.
CFileContentTypeValue	The content type of file.
CModelValue	The analysis model to be used by the service. For the Element classification and Compare two documents methods, the default is contracts. For the Extract tables method, the default is tables. These defaults apply to the standalone methods as well as to the methods' use in batch-processing requests.
▶CCompareDocumentsEnums	Enum values for CompareDocuments.
CFile1ContentTypeValue	The content type of file1.
CFile2ContentTypeValue	The content type of file2.
CModelValue	The analysis model to be used by the service. For the Element classification and Compare two documents methods, the default is contracts. For the Extract tables method, the default is tables. These defaults apply to the standalone methods as well as to the methods' use in batch-processing requests.
▶CConvertToHtmlEnums	Enum values for ConvertToHtml.
CFileContentTypeValue	The content type of file.
CModelValue	The analysis model to be used by the service. For the Element classification and Compare two documents methods, the default is contracts. For the Extract tables method, the default is tables. These defaults apply to the standalone methods as well as to the methods' use in batch-processing requests.
▶CCreateBatchEnums	Enum values for CreateBatch.
CFunctionValue	The Compare and Comply method to run across the submitted input documents.
CModelValue	The analysis model to be used by the service. For the Element classification and Compare two documents methods, the default is contracts. For the Extract tables method, the default is tables. These defaults apply to the standalone methods as well as to the methods' use in batch-processing requests.
▶CDeleteFeedbackEnums	Enum values for DeleteFeedback.
CModelValue	The analysis model to be used by the service. For the Element classification and Compare two documents methods, the default is contracts. For the Extract tables method, the default is tables. These defaults apply to the standalone methods as well as to the methods' use in batch-processing requests.
▶CExtractTablesEnums	Enum values for ExtractTables.
CFileContentTypeValue	The content type of file.
CModelValue	The analysis model to be used by the service. For the Element classification and Compare two documents methods, the default is contracts. For the Extract tables method, the default is tables. These defaults apply to the standalone methods as well as to the methods' use in batch-processing requests.
▶CGetFeedbackEnums	Enum values for GetFeedback.
CModelValue	The analysis model to be used by the service. For the Element classification and Compare two documents methods, the default is contracts. For the Extract tables method, the default is tables. These defaults apply to the standalone methods as well as to the methods' use in batch-processing requests.
▶CUpdateBatchEnums	Enum values for UpdateBatch.
CActionValue	The action you want to perform on the specified batch-processing job.
CModelValue	The analysis model to be used by the service. For the Element classification and Compare two documents methods, the default is contracts. For the Extract tables method, the default is tables. These defaults apply to the standalone methods as well as to the methods' use in batch-processing requests.
CICompareComplyService
▼NDiscovery
▶Nv1
▶NExamples
CServiceExample
▶NIntegrationTests
CDiscoveryCpdIntegrationTests
CDiscoveryIntegrationTests
▶NModel
CAggregationResult	Aggregation results for the specified query.
CCalculation	Calculation.
▶CCollection	A collection for storing documents.
CStatusEnumValue	The status of the collection.
CCollectionCrawlStatus	Object containing information about the crawl status of this collection.
CCollectionDiskUsage	Summary of the disk usage statistics for this collection.
CCollectionUsage	Summary of the collection usage in the environment.
CCompletions	An object containing an array of autocompletion suggestions.
CConfiguration	A custom configuration for the environment.
CConversions	Document conversion settings.
▶CCreateEventResponse	An object defining the event being created.
CTypeEnumValue	The event type that was created.
▶CCredentialDetails	Object containing details of the stored credentials
CCredentialTypeEnumValue	The authentication method for this credentials definition. The credential_type specified must be supported by the source_type. The following combinations are possible:
CSourceVersionEnumValue	The type of Sharepoint repository to connect to. Only valid, and required, with a source_type of sharepoint.
▶CCredentials	Object containing credential information.
CSourceTypeEnumValue	The source that this credentials object connects to
CStatusEnumValue	The current status of this set of credentials. connected indicates that the credentials are available to use with the source configuration of a collection. invalid refers to the credentials (for example, the password provided has expired) and must be corrected before they can be used with a collection.
CCredentialsList	Object containing array of credential definitions.
▶CDeleteCollectionResponse	Response object returned when deleting a colleciton.
CStatusEnumValue	The status of the collection. The status of a successful deletion operation is deleted.
▶CDeleteConfigurationResponse	Information returned when a configuration is deleted.
CStatusEnumValue	Status of the configuration. A deleted configuration has the status deleted.
▶CDeleteCredentials	Object returned after credentials are deleted.
CStatusEnumValue	The status of the deletion request.
▶CDeleteDocumentResponse	Information returned when a document is deleted.
CStatusEnumValue	Status of the document. A deleted document has the status deleted.
▶CDeleteEnvironmentResponse	Response object returned when deleting an environment.
CStatusEnumValue	Status of the environment.
CDiskUsage	Summary of the disk usage statistics for the environment.
▶CDocumentAccepted	Information returned after an uploaded document is accepted.
CStatusEnumValue	Status of the document in the ingestion process. A status of processing is returned for documents that are ingested with a version date before 2019-01-01. The pending status is returned for all others.
CDocumentCounts	Object containing collection document count information.
▶CDocumentStatus	Status information about a submitted document.
CFileTypeEnumValue	The type of the original source file.
CStatusEnumValue	Status of the document in the ingestion process.
CEnrichment	Enrichment step to perform on the document. Each enrichment is performed on the specified field in the order that they are listed in the configuration.
▶CEnrichmentOptions	Options which are specific to a particular enrichment.
CLanguageEnumValue	ISO 639-1 code indicating the language to use for the analysis. This code overrides the automatic language detection performed by the service. Valid codes are ar (Arabic), en (English), fr (French), de (German), it (Italian), pt (Portuguese), ru (Russian), es (Spanish), and sv (Swedish). Note: Not all features support all languages, automatic detection is recommended.
▶CEnvironment	Details about an environment.
CSizeEnumValue	Current size of the environment.
CStatusEnumValue	Current status of the environment. resizing is displayed when a request to increase the environment size has been made, but is still in the process of being completed.
CEnvironmentDocuments	Summary of the document usage statistics for the environment.
CEventData	Query event data object.
CExpansion	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.
CExpansions	The query expansion definitions for the specified collection.
▶CField	Object containing field details.
CTypeEnumValue	The type of the field.
CFilter	Filter.
CFontSetting	Font matching configuration.
▶CGateway	Object describing a specific gateway.
CStatusEnumValue	The current status of the gateway. connected means the gateway is connected to the remotly installed gateway. idle means this gateway is not currently in use.
CGatewayDelete	Gatway deletion confirmation.
CGatewayList	Object containing gateways array.
CHistogram	Histogram.
CHtmlSettings	A list of HTML conversion settings.
CIndexCapacity	Details about the resource usage and capacity of the environment.
CListCollectionFieldsResponse	The list of fetched fields
CListCollectionsResponse	Response object containing an array of collection details.
CListConfigurationsResponse	Object containing an array of available configurations.
CListEnvironmentsResponse	Response object containing an array of configured environments.
CLogQueryResponse	Object containing results that match the requested logs query.
▶CLogQueryResponseResult	Individual result object for a logs query. Each object represents either a query to a Discovery collection or an event that is associated with a query.
CDocumentTypeEnumValue	The type of log entry returned
CEventTypeEnumValue	The type of event that this object respresents. Possible values are
CResultTypeEnumValue	The type of result that this event is associated with. Only returned with logs of type event.
CLogQueryResponseResultDocuments	Object containing result information that was returned by the query used to create this log entry. Only returned with logs of type query.
CLogQueryResponseResultDocumentsResult	Each object in the results array corresponds to an individual document returned by the original query.
CMetricAggregation	An aggregation analyzing log information for queries and events.
CMetricAggregationResult	Aggregation result data for the requested metric.
CMetricResponse	The response generated from a call to a metrics method.
CMetricTokenAggregation	An aggregation analyzing log information for queries and events.
CMetricTokenAggregationResult	Aggregation result data for the requested metric.
CMetricTokenResponse	The response generated from a call to a metrics method that evaluates tokens.
CNested	Nested.
CNluEnrichmentConcepts	An object specifiying the concepts enrichment and related parameters.
CNluEnrichmentEmotion	An object specifying the emotion detection enrichment and related parameters.
CNluEnrichmentEntities	An object speficying the Entities enrichment and related parameters.
CNluEnrichmentFeatures	Object containing Natural Language Understanding features to be used.
CNluEnrichmentKeywords	An object specifying the Keyword enrichment and related parameters.
CNluEnrichmentRelations	An object specifying the relations enrichment and related parameters.
CNluEnrichmentSemanticRoles	An object specifiying the semantic roles enrichment and related parameters.
CNluEnrichmentSentiment	An object specifying the sentiment extraction enrichment and related parameters.
▶CNormalizationOperation	Object containing normalization operations.
COperationEnumValue	Identifies what type of operation to perform
▶CNotice	A notice produced for the collection.
CSeverityEnumValue	Severity level of the notice.
CPdfHeadingDetection	Object containing heading detection conversion settings for PDF documents.
CPdfSettings	A list of PDF conversion settings.
CQueryAggregation	An aggregation produced by Discovery to analyze the input provided.
CQueryNoticesResponse	Object containing notice query results.
▶CQueryNoticesResult	Query result object.
CFileTypeEnumValue	The type of the original source file.
CQueryPassages	A passage query result.
CQueryResponse	A response containing the documents and aggregations for the query.
CQueryResult	Query result object.
CQueryResultMetadata	Metadata of a query result.
▶CRetrievalDetails	An object contain retrieval type information.
CDocumentRetrievalStrategyEnumValue	Indentifies the document retrieval strategy used for this query. relevancy_training indicates that the results were returned using a relevancy trained model. continuous_relevancy_training indicates that the results were returned using the continuous relevancy training model created by result feedback analysis. untrained means the results were returned using the standard untrained model
CSduStatus	Object containing smart document understanding information for this collection.
CSduStatusCustomFields	Information about custom smart document understanding fields that exist in this collection.
▶CSearchStatus	Information about the Continuous Relevancy Training for this environment.
CStatusEnumValue	The current status of Continuous Relevancy Training for this environment.
CSegmentSettings	A list of Document Segmentation settings.
▶CSource	Object containing source parameters for the configuration.
CTypeEnumValue	The type of source to connect to
CSourceOptions	The options object defines which items to crawl from the source system.
CSourceOptionsBuckets	Object defining a cloud object store bucket to crawl.
CSourceOptionsFolder	Object that defines a box folder to crawl with this configuration.
CSourceOptionsObject	Object that defines a Salesforce document object type crawl with this configuration.
CSourceOptionsSiteColl	Object that defines a Microsoft SharePoint site collection to crawl with this configuration.
▶CSourceOptionsWebCrawl	Object defining which URL to crawl and how to crawl it.
CCrawlSpeedEnumValue	The number of concurrent URLs to fetch. gentle means one URL is fetched at a time with a delay between each call. normal means as many as two URLs are fectched concurrently with a short delay between fetch calls. aggressive means that up to ten URLs are fetched concurrently with a short delay between fetch calls.
▶CSourceSchedule	Object containing the schedule information for the source.
CFrequencyEnumValue	The crawl schedule in the specified time_zone
▶CSourceStatus	Object containing source crawl status information.
CStatusEnumValue	The current status of the source crawl for this collection. This field returns not_configured if the default configuration for this source does not have a source object defined
CTerm	Term.
CTimeslice	Timeslice.
CTokenDictRule	An object defining a single tokenizaion rule.
▶CTokenDictStatusResponse	Object describing the current status of the wordlist.
CStatusEnumValue	Current wordlist status for the specified collection.
CTopHits	TopHits.
CTopHitsResults	Top hit information for this query.
CTrainingDataSet	Training information for a specific collection.
CTrainingExample	Training example details.
CTrainingExampleList	Object containing an array of training examples.
CTrainingQuery	Training query details.
CTrainingStatus	Training status details.
CWordHeadingDetection	Object containing heading detection conversion settings for Microsoft Word documents.
CWordSettings	A list of Word conversion settings.
CWordStyle	Microsoft Word styles to convert into a specified HTML head level.
CXPathPatterns	Object containing an array of XPaths.
▶NUnitTests
CDiscoveryServiceUnitTests
CDiscoveryUnitTests
▶CDiscoveryService
▶CAddDocumentEnums	Enum values for AddDocument.
CFileContentTypeValue	The content type of file.
▶CGetMetricsEventRateEnums	Enum values for GetMetricsEventRate.
CResultTypeValue	The type of result to consider when calculating the metric.
▶CGetMetricsQueryEnums	Enum values for GetMetricsQuery.
CResultTypeValue	The type of result to consider when calculating the metric.
▶CGetMetricsQueryEventEnums	Enum values for GetMetricsQueryEvent.
CResultTypeValue	The type of result to consider when calculating the metric.
▶CGetMetricsQueryNoResultsEnums	Enum values for GetMetricsQueryNoResults.
CResultTypeValue	The type of result to consider when calculating the metric.
▶CUpdateDocumentEnums	Enum values for UpdateDocument.
CFileContentTypeValue	The content type of file.
CIDiscoveryService
▶Nv2
▶NExamples
CServiceExample
▶NIntegrationTests
CDiscoveryIntegrationTests
▶NModel
CAnalyzedDocument	An object containing the converted document and any identified enrichments.
CAnalyzedResult	Result of the document analysis.
CCollection	A collection for storing documents.
CCollectionDetails	A collection for storing documents.
CCollectionEnrichment	An object describing an Enrichment for a collection.
CCompletions	An object containing an array of autocompletion suggestions.
▶CComponentSettingsAggregation	Display settings for aggregations.
CVisualizationTypeEnumValue	Type of visualization to use when rendering the aggregation.
CComponentSettingsFieldsShown	Fields shown in the results section of the UI.
CComponentSettingsFieldsShownBody	Body label.
CComponentSettingsFieldsShownTitle	Title label.
CComponentSettingsResponse	The default component settings for this project.
▶CCreateEnrichment	Information about a specific enrichment.
CTypeEnumValue	The type of this enrichment.
CDefaultQueryParams	Default query parameters for this project.
CDefaultQueryParamsPassages	Default settings configuration for passage search options.
CDefaultQueryParamsSuggestedRefinements	Object containing suggested refinement settings.
CDefaultQueryParamsTableResults	Default project query settings for table results.
▶CDeleteDocumentResponse	Information returned when a document is deleted.
CStatusEnumValue	Status of the document. A deleted document has the status deleted.
▶CDocumentAccepted	Information returned after an uploaded document is accepted.
CStatusEnumValue	Status of the document in the ingestion process. A status of processing is returned for documents that are ingested with a version date before 2019-01-01. The pending status is returned for all others.
CDocumentAttribute	List of document attributes.
▶CEnrichment	Information about a specific enrichment.
CTypeEnumValue	The type of this enrichment.
CEnrichmentOptions	A object containing options for the current enrichment.
CEnrichments	An object containing an array of enrichment definitions.
▶CField	Object containing field details.
CTypeEnumValue	The type of the field.
CListCollectionsResponse	Response object containing an array of collection details.
CListFieldsResponse	The list of fetched fields
CListProjectsResponse	A list of projects in this instance.
▶CNotice	A notice produced for the collection.
CSeverityEnumValue	Severity level of the notice.
▶CProjectDetails	Detailed information about the specified project.
CTypeEnumValue	The project type of this project.
▶CProjectListDetails	Details about a specific project.
CTypeEnumValue	The project type of this project.
CProjectListDetailsRelevancyTrainingStatus	Relevancy training status information for this project.
CQueryAggregation	An abstract aggregation type produced by Discovery to analyze the input provided.
CQueryCalculationAggregation	Returns a scalar calculation across all documents for the field specified. Possible calculations include min, max, sum, average, and unique_count.
CQueryFilterAggregation	A modifier that will narrow down the document set of the sub aggregations it precedes.
CQueryGroupByAggregation	Returns the top values for the field specified.
CQueryGroupByAggregationResult	Top value result for the term aggregation.
CQueryHistogramAggregation	Numeric interval segments to categorize documents by using field values from a single numeric field to describe the category.
CQueryHistogramAggregationResult	Histogram numeric interval result.
CQueryLargePassages	Configuration for passage retrieval.
CQueryLargeSuggestedRefinements	Configuration for suggested refinements.
CQueryLargeTableResults	Configuration for table retrieval.
CQueryNestedAggregation	A restriction that alter the document set used for sub aggregations it precedes to nested documents found in the field specified.
CQueryNoticesResponse	Object containing notice query results.
CQueryResponse	A response containing the documents and aggregations for the query.
CQueryResponsePassage	A passage query response.
CQueryResult	Result document for the specified query.
▶CQueryResultMetadata	Metadata of a query result.
CDocumentRetrievalSourceEnumValue	The document retrieval source that produced this search result.
CQueryResultPassage	A passage query result.
CQuerySuggestedRefinement	A suggested additional query term or terms user to filter results.
CQueryTableResult	A tables whose content or context match a search query.
CQueryTermAggregation	Returns the top values for the field specified.
CQueryTermAggregationResult	Top value result for the term aggregation.
CQueryTimesliceAggregation	A specialized histogram aggregation that uses dates to create interval segments.
CQueryTimesliceAggregationResult	A timeslice interval segment.
CQueryTopHitsAggregation	Returns the top documents ranked by the score of the query.
CQueryTopHitsAggregationResult	A query response containing the matching documents for the preceding aggregations.
▶CRetrievalDetails	An object contain retrieval type information.
CDocumentRetrievalStrategyEnumValue	Identifies the document retrieval strategy used for this query. relevancy_training indicates that the results were returned using a relevancy trained model
CTableBodyCells	Cells that are not table header, column header, or row header cells.
CTableCellKey	A key in a key-value pair.
CTableCellValues	A value in a key-value pair.
CTableColumnHeaderIds	An array of values, each being the id value of a column header that is applicable to the current cell.
CTableColumnHeaders	Column-level cells, each applicable as a header to other cells in the same column as itself, of the current table.
CTableColumnHeaderTexts	An array of values, each being the text value of a column header that is applicable to the current cell.
CTableColumnHeaderTextsNormalized	If you provide customization input, the normalized version of the column header texts according to the customization; otherwise, the same value as column_header_texts.
CTableElementLocation	The numeric location of the identified element in the document, represented with two integers labeled begin and end.
CTableHeaders	The contents of the current table's header.
CTableKeyValuePairs	Key-value pairs detected across cell boundaries.
CTableResultTable	Full table object retrieved from Table Understanding Enrichment.
CTableRowHeaderIds	An array of values, each being the id value of a row header that is applicable to this body cell.
CTableRowHeaders	Row-level cells, each applicable as a header to other cells in the same row as itself, of the current table.
CTableRowHeaderTexts	An array of values, each being the text value of a row header that is applicable to this body cell.
CTableRowHeaderTextsNormalized	If you provide customization input, the normalized version of the row header texts according to the customization; otherwise, the same value as row_header_texts.
CTableTextLocation	Text and associated location within a table.
CTrainingExample	Object containing example response details for a training query.
CTrainingQuery	Object containing training query details.
CTrainingQuerySet	Object specifying the training queries contained in the identified training set.
▶NUnitTests
CDiscoveryServiceUnitTests
▶CDiscoveryService
▶CAddDocumentEnums	Enum values for AddDocument.
CFileContentTypeValue	The content type of file.
▶CAnalyzeDocumentEnums	Enum values for AnalyzeDocument.
CFileContentTypeValue	The content type of file.
▶CUpdateDocumentEnums	Enum values for UpdateDocument.
CFileContentTypeValue	The content type of file.
CIDiscoveryService
▼NIntegrationTests
CAdditionalPropertiesTest
CCommonIntegrationTests
CCp4dIntegrationTests
CCustomHeadersTest
CDynamicModel
CExternalCredentialsIntegrationTests
CFoo
CX
CY
▼NLanguageTranslator
▶Nv3
▶NExamples
CServiceExample
▶NIntegrationTests
CLanguageTranslatorServiceIntegrationTests
CLTServiceIntTestBasicAuthIamApikey
▶NModel
CDeleteModelResult	DeleteModelResult.
CDocumentList	DocumentList.
▶CDocumentStatus	Document information, including translation status.
CStatusEnumValue	The status of the translation job associated with a submitted document.
CIdentifiableLanguage	IdentifiableLanguage.
CIdentifiableLanguages	IdentifiableLanguages.
CIdentifiedLanguage	IdentifiedLanguage.
CIdentifiedLanguages	IdentifiedLanguages.
CLanguage	Response payload for languages.
CLanguages	The response type for listing supported languages.
CTranslation	Translation.
▶CTranslationModel	Response payload for models.
CStatusEnumValue	Availability of a model.
CTranslationModels	The response type for listing existing translation models.
CTranslationResult	TranslationResult.
▶NUnitTests
CLanguageTranslatorServiceUnitTest
CLanguageTranslatorServiceUnitTests
CILanguageTranslatorService
▶CLanguageTranslatorService
▶CGetTranslatedDocumentEnums	Enum values for GetTranslatedDocument.
CAcceptValue	The type of the response: application/powerpoint, application/mspowerpoint, application/x-rtf, application/json, application/xml, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-powerpoint, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.oasis.opendocument.spreadsheet, application/vnd.oasis.opendocument.presentation, application/vnd.oasis.opendocument.text, application/pdf, application/rtf, text/html, text/json, text/plain, text/richtext, text/rtf, or text/xml. A character encoding can be specified by including a charset parameter. For example, 'text/html;charset=utf-8'.
▶CTranslateDocumentEnums	Enum values for TranslateDocument.
CFileContentTypeValue	The content type of file.
▼NNaturalLangaugeClassifier
▶Nv1
▶NExamples
CServiceExample
▼NNaturalLanguageClassifier
▶Nv1
▶NIntegrationTests
CNaturalLanguageClassifierServiceIntegrationTests
▶NModel
CClassification	Response from the classifier for a phrase.
CClassificationCollection	Response from the classifier for multiple phrases.
CClassifiedClass	Class and confidence.
▶CClassifier	A classifier for natural language phrases.
CStatusEnumValue	The state of the classifier.
CClassifierList	List of available classifiers.
CClassifyInput	Request payload to classify.
CCollectionItem	Response from the classifier for a phrase in a collection.
▶NUnitTests
CNaturalLanguageClassifierServiceUnitTests
CINaturalLanguageClassifierService
CNaturalLanguageClassifierService
▼NNaturalLanguageUnderstanding
▶Nv1
▶NExamples
CServiceExample
▶NIntegrationTests
CNaturalLanguageUnderstandingIntegrationTests
▶NModel
CAnalysisResults	Results of the analysis, organized by feature.
CAnalysisResultsUsage	API usage information for the request.
CAuthor	The author of the analyzed content.
CCategoriesOptions	Returns a five-level taxonomy of the content. The top three categories are returned
CCategoriesRelevantText	Relevant text that contributed to the categorization.
CCategoriesResult	A categorization of the analyzed text.
CCategoriesResultExplanation	Information that helps to explain what contributed to the categories result.
CConceptsOptions	Returns high-level concepts in the content. For example, a research paper about deep learning might return the concept, "Artificial Intelligence" although the term is not mentioned
CConceptsResult	The general concepts referenced or alluded to in the analyzed text.
CDeleteModelResults	Delete model results.
CDisambiguationResult	Disambiguation information for the entity.
CDocumentEmotionResults	Emotion results for the document as a whole.
CDocumentSentimentResults	DocumentSentimentResults.
CEmotionOptions	Detects anger, disgust, fear, joy, or sadness that is conveyed in the content or by the context around target phrases specified in the targets parameter. You can analyze emotion for detected entities with entities.emotion and for keywords with keywords.emotion
CEmotionResult	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.
CEmotionScores	EmotionScores.
CEntitiesOptions	Identifies people, cities, organizations, and other entities in the content. For more information, see [Entity types and subtypes](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-entity-types)
CEntitiesResult	The important people, places, geopolitical entities and other types of entities in your content.
CEntityMention	EntityMention.
CFeatures	Analysis features and options.
CFeatureSentimentResults	FeatureSentimentResults.
CFeaturesResultsMetadata	Webpage metadata, such as the author and the title of the page.
CFeed	RSS or ATOM feed found on the webpage.
CKeywordsOptions	Returns important keywords in the content
CKeywordsResult	The important keywords in the content, organized by relevance.
CListModelsResults	Custom models that are available for entities and relations.
▶CModel	Model.
CStatusEnumValue	When the status is available, the model is ready to use.
CRelationArgument	RelationArgument.
CRelationEntity	An entity that corresponds with an argument in a relation.
CRelationsOptions	Recognizes when two entities are related and identifies the type of relation. For example, an awardedTo relation might connect the entities "Nobel Prize" and "Albert Einstein". For more information, see Relation types
CRelationsResult	The relations between entities found in the content.
CSemanticRolesEntity	SemanticRolesEntity.
CSemanticRolesKeyword	SemanticRolesKeyword.
CSemanticRolesOptions	Parses sentences into subject, action, and object form
CSemanticRolesResult	The object containing the actions and the objects the actions act upon.
CSemanticRolesResultAction	The extracted action from the sentence.
CSemanticRolesResultObject	The extracted object from the sentence.
CSemanticRolesResultSubject	The extracted subject from the sentence.
CSemanticRolesVerb	SemanticRolesVerb.
CSentenceResult	SentenceResult.
CSentimentOptions	Analyzes the general sentiment of your content or the sentiment toward specific target phrases. You can analyze sentiment for detected entities with entities.sentiment and for keywords with keywords.sentiment
CSentimentResult	The sentiment of the content.
CSyntaxOptions	Returns tokens and sentences from the input text.
CSyntaxOptionsTokens	Tokenization options.
CSyntaxResult	Tokens and sentences returned from syntax analysis.
CTargetedEmotionResults	Emotion results for a specified target.
CTargetedSentimentResults	TargetedSentimentResults.
▶CTokenResult	TokenResult.
CPartOfSpeechEnumValue	The part of speech of the token. For more information about the values, see Universal Dependencies POS tags.
▶NUnitTests
CNaturalLanguageUnderstandingServiceUnitTests
CNaturalLanguageUnderstandingUnitTests
CINaturalLanguageUnderstandingService
CNaturalLanguageUnderstandingService
▼NPersonalityInsights
▶Nv3
▶NExamples
CServiceExample
▶NIntegrationTests
CPersonalityInsightsServiceIntegrationTests
▶NModel
CBehavior	The temporal behavior for the input content.
CConsumptionPreferences	A consumption preference that the service inferred from the input content.
CConsumptionPreferencesCategory	The consumption preferences that the service inferred from the input content.
▶CProfile	The personality profile that the service generated for the input content.
CProcessedLanguageEnumValue	The language model that was used to process the input.
▶CTrait	The characteristics that the service inferred from the input content.
CCategoryEnumValue	The category of the characteristic: personality for Big Five personality characteristics, needs for Needs, and values for Values.
▶CWarning	A warning message that is associated with the input content.
CWarningIdEnumValue	The identifier of the warning message.
▶NUnitTests
CPersonalityInsightsServiceUnitTests
CIPersonalityInsightsService
▶CPersonalityInsightsService
▶CProfileAsCsvEnums	Enum values for ProfileAsCsv.
CAcceptLanguageValue	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.
CContentLanguageValue	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
CContentTypeValue	The type of the input. For more information, see Content types in the method description.
▶CProfileEnums	Enum values for Profile.
CAcceptLanguageValue	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.
CContentLanguageValue	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
CContentTypeValue	The type of the input. For more information, see Content types in the method description.
▼NSpeechToText
▶Nv1
▶NExamples
CServiceExample
▶NIntegrationTests
CSpeechToTextServiceIntegrationTest
▶NModel
▶CAcousticModel	Information about an existing custom acoustic model.
CStatusEnumValue	The current status of the custom acoustic model:
CAcousticModels	Information about existing custom acoustic models.
▶CAudioDetails	Information about an audio resource from a custom acoustic model.
CCompressionEnumValue	For an archive-type resource, the format of the compressed archive:
CTypeEnumValue	The type of the audio resource:
▶CAudioListing	Information about an audio resource from a custom acoustic model.
CStatusEnumValue	For an audio-type resource, the status of the resource:
CAudioMetrics	If audio metrics are requested, information about the signal characteristics of the input audio.
CAudioMetricsDetails	Detailed information about the signal characteristics of the input audio.
CAudioMetricsHistogramBin	A bin with defined boundaries that indicates the number of values in a range of signal characteristics for a histogram. The first and last bins of a histogram are the boundary bins. They cover the intervals between negative infinity and the first boundary, and between the last boundary and positive infinity, respectively.
▶CAudioResource	Information about an audio resource from a custom acoustic model.
CStatusEnumValue	The status of the audio resource:
CAudioResources	Information about the audio resources from a custom acoustic model.
CCorpora	Information about the corpora from a custom language model.
▶CCorpus	Information about a corpus from a custom language model.
CStatusEnumValue	The status of the corpus:
CCustomWord	Information about a word that is to be added to a custom language model.
▶CGrammar	Information about a grammar from a custom language model.
CStatusEnumValue	The status of the grammar:
CGrammars	Information about the grammars from a custom language model.
CKeywordResult	Information about a match for a keyword from speech recognition results.
▶CLanguageModel	Information about an existing custom language model.
CStatusEnumValue	The current status of the custom language model:
CLanguageModels	Information about existing custom language models.
CProcessedAudio	Detailed timing information about the service's processing of the input audio.
CProcessingMetrics	If processing metrics are requested, information about the service's processing of the input audio. Processing metrics are not available with the synchronous Recognize audio method.
▶CRecognitionJob	Information about a current asynchronous speech recognition job.
CStatusEnumValue	The current status of the job:
CRecognitionJobs	Information about current asynchronous speech recognition jobs.
▶CRegisterStatus	Information about a request to register a callback for asynchronous speech recognition.
CStatusEnumValue	The current status of the job:
CSpeakerLabelsResult	Information about the speakers from speech recognition results.
CSpeechModel	Information about an available language model.
CSpeechModels	Information about the available language models.
CSpeechRecognitionAlternative	An alternative transcript from speech recognition results.
▶CSpeechRecognitionResult	Component results for a speech recognition request.
CEndOfUtteranceEnumValue	If the split_transcript_at_phrase_end parameter is true, describes the reason for the split:
CSpeechRecognitionResults	The complete results for a speech recognition request.
CSupportedFeatures	Additional service features that are supported with the model.
CTrainingResponse	The response from training of a custom language or custom acoustic model.
▶CTrainingWarning	A warning from training of a custom language or custom acoustic model.
CCodeEnumValue	An identifier for the type of invalid resources listed in the description field.
CWord	Information about a word from a custom language model.
CWordAlternativeResult	An alternative hypothesis for a word from speech recognition results.
CWordAlternativeResults	Information about alternative hypotheses for words from speech recognition results.
CWordError	An error associated with a word from a custom language model.
CWords	Information about the words from a custom language model.
▶NUnitTests
CSpeechToTextServiceUnitTests
▶NUtil
CMediaTypeUtils
CISpeechToTextService
▶CSpeechToTextService
▶CAddAudioEnums	Enum values for AddAudio.
CContainedContentTypeValue	For an archive-type resource, specify the format of the audio files that are contained in the archive file if they are of type audio/alaw, audio/basic, audio/l16, or audio/mulaw. Include the rate, channels, and endianness parameters where necessary. In this case, all audio files that are contained in the archive file must be of the indicated type
CContentTypeValue	For an audio-type resource, the format (MIME type) of the audio. For more information, see Content types for audio-type resources in the method description
▶CAddGrammarEnums	Enum values for AddGrammar.
CContentTypeValue	The format (MIME type) of the grammar file:
▶CCreateJobEnums	Enum values for CreateJob.
CContentTypeValue	The format (MIME type) of the audio. For more information about specifying an audio format, see Audio formats (content types) in the method description.
CEventsValue	If the job includes a callback URL, a comma-separated list of notification events to which to subscribe. Valid events are
CModelValue	The identifier of the model that is to be used for the recognition request. See Languages and models.
▶CGetModelEnums	Enum values for GetModel.
CModelIdValue	The identifier of the model in the form of its name from the output of the Get a model method.
▶CListAcousticModelsEnums	Enum values for ListAcousticModels.
CLanguageValue	The identifier of the language for which custom language or custom acoustic models are to be returned. Omit the parameter to see all custom language or custom acoustic models that are owned by the requesting credentials
▶CListLanguageModelsEnums	Enum values for ListLanguageModels.
CLanguageValue	The identifier of the language for which custom language or custom acoustic models are to be returned. Omit the parameter to see all custom language or custom acoustic models that are owned by the requesting credentials
▶CListWordsEnums	Enum values for ListWords.
CSortValue	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 the curl command, URL-encode the + symbol as %2B.
CWordTypeValue	The type of words to be listed from the custom language model's words resource:
▶CRecognizeEnums	Enum values for Recognize.
CContentTypeValue	The format (MIME type) of the audio. For more information about specifying an audio format, see Audio formats (content types) in the method description.
CModelValue	The identifier of the model that is to be used for the recognition request. See Languages and models.
▶CTrainLanguageModelEnums	Enum values for TrainLanguageModel.
CWordTypeToAddValue	The type of words from the custom language model's words resource on which to train the model:
▼NTextToSpeech
▶Nv1
▶NExamples
CServiceExample
▶NIntegrationTests
CTextToSpeechServiceIntegrationTests
▶NModel
CCustomModel	Information about an existing custom model.
CCustomModels	Information about existing custom models.
CPronunciation	The pronunciation of the specified text.
CSupportedFeatures	Additional service features that are supported with the voice.
▶CTranslation	Information about the translation for the specified text.
CPartOfSpeechEnumValue	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.
CVoice	Information about an available voice.
CVoices	Information about all available voices.
▶CWord	Information about a word for the custom model.
CPartOfSpeechEnumValue	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.
CWords	For the Add custom words method, one or more words that are to be added or updated for the custom model and the translation for each specified word
▶NUnitTests
CTextToSpeechServiceUnitTests
CITextToSpeechService
▶CTextToSpeechService
▶CGetPronunciationEnums	Enum values for GetPronunciation.
CFormatValue	The phoneme format in which to return the pronunciation. The Arabic, Chinese, Dutch, and Korean languages support only IPA. Omit the parameter to obtain the pronunciation in the default format.
CVoiceValue	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.
▶CGetVoiceEnums	Enum values for GetVoice.
CVoiceValue	The voice for which information is to be returned.
▶CListCustomModelsEnums	Enum values for ListCustomModels.
CLanguageValue	The language for which custom models that are owned by the requesting credentials are to be returned. Omit the parameter to see all custom models that are owned by the requester.
▶CSynthesizeEnums	Enum values for Synthesize.
CAcceptValue	The requested format (MIME type) of the audio. You can use the Accept header or the accept parameter to specify the audio format. For more information about specifying an audio format, see Audio formats (accept types) in the method description.
CVoiceValue	The voice to use for synthesis.
▼NToneAnalyzer
▶Nv3
▶NExamples
CServiceExample
▶NIntegrationTests
CToneAnalyzerServiceIntegrationTests
▶NModel
CDocumentAnalysis	The results of the analysis for the full input content.
CSentenceAnalysis	The results of the analysis for the individual sentences of the input content.
CToneAnalysis	The tone analysis results for the input from the general-purpose endpoint.
CToneCategory	The category for a tone from the input content.
▶CToneChatScore	The score for an utterance from the input content.
CToneIdEnumValue	The unique, non-localized identifier of the tone for the results. The service returns results only for tones whose scores meet a minimum threshold of 0.5.
CToneInput	Input for the general-purpose endpoint.
CToneScore	The score for a tone from the input content.
CUtterance	An utterance for the input of the general-purpose endpoint.
CUtteranceAnalyses	The results of the analysis for the utterances of the input content.
CUtteranceAnalysis	The results of the analysis for an utterance of the input content.
▶NUnitTests
CToneAnalyzerServiceUnitTests
CIToneAnalyzerService
▶CToneAnalyzerService
▶CToneChatEnums	Enum values for ToneChat.
CAcceptLanguageValue	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.
CContentLanguageValue	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
▶CToneEnums	Enum values for Tone.
CAcceptLanguageValue	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.
CContentLanguageValue	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
CContentTypeValue	The type of the input. A character encoding can be specified by including a charset parameter. For example, 'text/plain;charset=utf-8'.
CTonesValue	**2017-09-21:** Deprecated. The service continues to accept the parameter for backward-compatibility, but the parameter no longer affects the response
▼NVisualRecognition
▶Nv3
▶NExamples
CServiceExample
▶NIntegrationTests
CVisualRecognitionServiceIntegrationTests
▶NModel
CClassifiedImage	Results for one image.
CClassifiedImages	Results for all images.
▶CClassifier	Information about a classifier.
CStatusEnumValue	Training status of classifier.
CClassifierResult	Classifier and score combination.
CClassifiers	A container for the list of classifiers.
CClassResult	Result of a class within a classifier.
CErrorInfo	Information about what might have caused a failure, such as an image that is too large. Not returned when there is no error.
CModelClass	A category within a classifier.
CWarningInfo	Information about something that went wrong.
▶NUnitTests
CVisualRecognitionServiceUnitTests
CIVisualRecognitionService
▶CVisualRecognitionService
▶CClassifyEnums	Enum values for Classify.
CAcceptLanguageValue	The desired language of parts of the response. See the response for details.
▶Nv4
▶NExamples
CServiceExample
▶NIntegrationTests
CVisualRecognitionServiceIntegrationTests
▶NModel
CAnalyzeResponse	Results for all images.
CCollection	Details about a collection.
CCollectionObjects	The objects in a collection that are detected in an image.
CCollectionsList	A container for the list of collections.
CCollectionTrainingStatus	Training status information for the collection.
CDetectedObjects	Container for the list of collections that have objects detected in an image.
▶CError	Details about an error.
CCodeEnumValue	Identifier of the problem.
▶CErrorTarget	Details about the specific area of the problem.
CTypeEnumValue	The parameter or property that is the focus of the problem.
CImage	Details about an image.
CImageDetails	Details about an image.
CImageDetailsList	List of information about the images.
CImageDimensions	Height and width of an image.
▶CImageSource	The source type of the image.
CTypeEnumValue	The source type of the image.
CImageSummary	Basic information about an image.
CImageSummaryList	List of images.
CLocation	Defines the location of the bounding box around the object.
CObjectDetail	Details about an object in the collection.
CObjectDetailLocation	Defines the location of the bounding box around the object.
CObjectMetadata	Basic information about an object.
CObjectMetadataList	List of objects.
CObjectTrainingStatus	Training status for the objects in the collection.
CTrainingDataObject	Details about the training data.
CTrainingDataObjects	Training data for all objects.
▶CTrainingEvent	Details about the training event.
CStatusEnumValue	Training status of the training event.
CTypeEnumValue	Trained object type. Only objects is currently supported.
CTrainingEvents	Details about the training events.
CTrainingStatus	Training status information for the collection.
CUpdateObjectMetadata	Basic information about an updated object.
▶CWarning	Details about a problem.
CCodeEnumValue	Identifier of the problem.
▶NUnitTests
CVisualRecognitionServiceUnitTests
CVisualRecognitionUnitTests
CIVisualRecognitionService
▶CVisualRecognitionService
▶CAnalyzeEnums	Enum values for Analyze.
CFeaturesValue	The features to analyze.
▶CGetJpegImageEnums	Enum values for GetJpegImage.
CSizeValue	The image size. Specify thumbnail to return a version that maintains the original aspect ratio but is no larger than 200 pixels in the larger dimension. For example, an original 800 x 1000 image is resized to 160 x 200 pixels.
▶CGetModelFileEnums	Enum values for GetModelFile.
CFeatureValue	The feature for the model.
CModelFormatValue	The format of the returned model.
CCommon
CAutoGeneratedProgram