Skip to content

Commit d8c041d

Browse files
committed
fix(services): update comments and formatting changes
1 parent 0b47643 commit d8c041d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+792
-643
lines changed

Scripts/Services/Assistant/V1/AssistantService.cs

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2019, 2021.
2+
* (C) Copyright IBM Corp. 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -16,7 +16,7 @@
1616
*/
1717

1818
/**
19-
* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-902c9336-20210513-140138
19+
* IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025
2020
*/
2121

2222
using System.Collections.Generic;
@@ -43,7 +43,7 @@ public partial class AssistantService : BaseService
4343
/// <summary>
4444
/// Gets and sets the version of the service.
4545
/// Release date of the API version you want to use. Specify dates in YYYY-MM-DD format. The current version is
46-
/// `2020-04-01`.
46+
/// `2021-06-14`.
4747
/// </summary>
4848
public string Version
4949
{
@@ -68,30 +68,30 @@ public bool DisableSslVerification
6868
/// AssistantService constructor.
6969
/// </summary>
7070
/// <param name="version">Release date of the API version you want to use. Specify dates in YYYY-MM-DD format.
71-
/// The current version is `2020-04-01`.</param>
71+
/// The current version is `2021-06-14`.</param>
7272
public AssistantService(string version) : this(version, defaultServiceName, ConfigBasedAuthenticatorFactory.GetAuthenticator(defaultServiceName)) {}
7373

7474
/// <summary>
7575
/// AssistantService constructor.
7676
/// </summary>
7777
/// <param name="version">Release date of the API version you want to use. Specify dates in YYYY-MM-DD format.
78-
/// The current version is `2020-04-01`.</param>
78+
/// The current version is `2021-06-14`.</param>
7979
/// <param name="authenticator">The service authenticator.</param>
8080
public AssistantService(string version, Authenticator authenticator) : this(version, defaultServiceName, authenticator) {}
8181

8282
/// <summary>
8383
/// AssistantService constructor.
8484
/// </summary>
8585
/// <param name="version">Release date of the API version you want to use. Specify dates in YYYY-MM-DD format.
86-
/// The current version is `2020-04-01`.</param>
86+
/// The current version is `2021-06-14`.</param>
8787
/// <param name="serviceName">The service name to be used when configuring the client instance</param>
8888
public AssistantService(string version, string serviceName) : this(version, serviceName, ConfigBasedAuthenticatorFactory.GetAuthenticator(serviceName)) {}
8989

9090
/// <summary>
9191
/// AssistantService constructor.
9292
/// </summary>
9393
/// <param name="version">Release date of the API version you want to use. Specify dates in YYYY-MM-DD format.
94-
/// The current version is `2020-04-01`.</param>
94+
/// The current version is `2021-06-14`.</param>
9595
/// <param name="serviceName">The service name to be used when configuring the client instance</param>
9696
/// <param name="authenticator">The service authenticator.</param>
9797
public AssistantService(string version, string serviceName, Authenticator authenticator) : base(authenticator, serviceName)
@@ -4605,8 +4605,8 @@ private void OnListLogsResponse(RESTConnector.Request req, RESTConnector.Respons
46054605
/// <param name="callback">The callback function that is invoked when the operation completes.</param>
46064606
/// <param name="filter">A cacheable parameter that limits the results to those matching the specified filter.
46074607
/// You must specify a filter query that includes a value for `language`, as well as a value for
4608-
/// `request.context.system.assistant_id`, `workspace_id`, or `request.context.metadata.deployment`. For more
4609-
/// information, see the
4608+
/// `request.context.system.assistant_id`, `workspace_id`, or `request.context.metadata.deployment`. These
4609+
/// required filters must be specified using the exact match (`::`) operator. For more information, see the
46104610
/// [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-filter-reference#filter-reference).</param>
46114611
/// <param name="sort">How to sort the returned log events. You can sort by **request_timestamp**. To reverse
46124612
/// the sort order, prefix the parameter value with a minus sign (`-`). (optional)</param>

Scripts/Services/Assistant/V1/Model/RuntimeEntity.cs

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2018, 2020.
2+
* (C) Copyright IBM Corp. 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -47,7 +47,10 @@ public class RuntimeEntity
4747
[JsonProperty("confidence", NullValueHandling = NullValueHandling.Ignore)]
4848
public float? Confidence { get; set; }
4949
/// <summary>
50-
/// Any metadata for the entity.
50+
/// **Deprecated.** Any metadata for the entity.
51+
///
52+
/// Beginning with the `2021-06-14` API version, the `metadata` property is no longer returned. For information
53+
/// about system entities recognized in the user input, see the `interpretation` property.
5154
/// </summary>
5255
[JsonProperty("metadata", NullValueHandling = NullValueHandling.Ignore)]
5356
public Dictionary<string, object> Metadata { get; set; }

Scripts/Services/Assistant/V2/AssistantService.cs

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2019, 2021.
2+
* (C) Copyright IBM Corp. 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -16,7 +16,7 @@
1616
*/
1717

1818
/**
19-
* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-902c9336-20210513-140138
19+
* IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025
2020
*/
2121

2222
using System.Collections.Generic;
@@ -43,7 +43,7 @@ public partial class AssistantService : BaseService
4343
/// <summary>
4444
/// Gets and sets the version of the service.
4545
/// Release date of the API version you want to use. Specify dates in YYYY-MM-DD format. The current version is
46-
/// `2020-09-24`.
46+
/// `2021-06-14`.
4747
/// </summary>
4848
public string Version
4949
{
@@ -68,30 +68,30 @@ public bool DisableSslVerification
6868
/// AssistantService constructor.
6969
/// </summary>
7070
/// <param name="version">Release date of the API version you want to use. Specify dates in YYYY-MM-DD format.
71-
/// The current version is `2020-09-24`.</param>
71+
/// The current version is `2021-06-14`.</param>
7272
public AssistantService(string version) : this(version, defaultServiceName, ConfigBasedAuthenticatorFactory.GetAuthenticator(defaultServiceName)) {}
7373

7474
/// <summary>
7575
/// AssistantService constructor.
7676
/// </summary>
7777
/// <param name="version">Release date of the API version you want to use. Specify dates in YYYY-MM-DD format.
78-
/// The current version is `2020-09-24`.</param>
78+
/// The current version is `2021-06-14`.</param>
7979
/// <param name="authenticator">The service authenticator.</param>
8080
public AssistantService(string version, Authenticator authenticator) : this(version, defaultServiceName, authenticator) {}
8181

8282
/// <summary>
8383
/// AssistantService constructor.
8484
/// </summary>
8585
/// <param name="version">Release date of the API version you want to use. Specify dates in YYYY-MM-DD format.
86-
/// The current version is `2020-09-24`.</param>
86+
/// The current version is `2021-06-14`.</param>
8787
/// <param name="serviceName">The service name to be used when configuring the client instance</param>
8888
public AssistantService(string version, string serviceName) : this(version, serviceName, ConfigBasedAuthenticatorFactory.GetAuthenticator(serviceName)) {}
8989

9090
/// <summary>
9191
/// AssistantService constructor.
9292
/// </summary>
9393
/// <param name="version">Release date of the API version you want to use. Specify dates in YYYY-MM-DD format.
94-
/// The current version is `2020-09-24`.</param>
94+
/// The current version is `2021-06-14`.</param>
9595
/// <param name="serviceName">The service name to be used when configuring the client instance</param>
9696
/// <param name="authenticator">The service authenticator.</param>
9797
public AssistantService(string version, string serviceName, Authenticator authenticator) : base(authenticator, serviceName)

Scripts/Services/Assistant/V2/Model/RuntimeEntity.cs

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2018, 2020.
2+
* (C) Copyright IBM Corp. 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -47,7 +47,10 @@ public class RuntimeEntity
4747
[JsonProperty("confidence", NullValueHandling = NullValueHandling.Ignore)]
4848
public float? Confidence { get; set; }
4949
/// <summary>
50-
/// Any metadata for the entity.
50+
/// **Deprecated.** Any metadata for the entity.
51+
///
52+
/// Beginning with the `2021-06-14` API version, the `metadata` property is no longer returned. For information
53+
/// about system entities recognized in the user input, see the `interpretation` property.
5154
/// </summary>
5255
[JsonProperty("metadata", NullValueHandling = NullValueHandling.Ignore)]
5356
public Dictionary<string, object> Metadata { get; set; }

Scripts/Services/Discovery/V1/DiscoveryService.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2019, 2020.
2+
* (C) Copyright IBM Corp. 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -16,7 +16,7 @@
1616
*/
1717

1818
/**
19-
* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-a45d89ef-20201209-153452
19+
* IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025
2020
*/
2121

2222
using System.Collections.Generic;
@@ -2725,7 +2725,7 @@ private void OnDeleteDocumentResponse(RESTConnector.Request req, RESTConnector.R
27252725
/// are biased towards higher field values. This parameter cannot be used in the same query as the **sort**
27262726
/// parameter. (optional)</param>
27272727
/// <param name="spellingSuggestions">When `true` and the **natural_language_query** parameter is used, the
2728-
/// **natural_languge_query** parameter is spell checked. The most likely correction is retunred in the
2728+
/// **natural_languge_query** parameter is spell checked. The most likely correction is returned in the
27292729
/// **suggested_query** field of the response (if one exists).
27302730
///
27312731
/// **Important:** this parameter is only valid when using the Cloud Pak version of Discovery. (optional,
@@ -3406,7 +3406,7 @@ private void OnFederatedQueryNoticesResponse(RESTConnector.Request req, RESTConn
34063406
/// <param name="environmentId">The ID of the environment.</param>
34073407
/// <param name="collectionId">The ID of the collection.</param>
34083408
/// <param name="prefix">The prefix to use for autocompletion. For example, the prefix `Ho` could autocomplete
3409-
/// to `Hot`, `Housing`, or `How do I upgrade`. Possible completions are.</param>
3409+
/// to `hot`, `housing`, or `how`.</param>
34103410
/// <param name="field">The field in the result documents that autocompletion suggestions are identified from.
34113411
/// (optional)</param>
34123412
/// <param name="count">The number of autocompletion suggestions to return. (optional)</param>

Scripts/Services/Discovery/V1/Model/Calculation.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -23,7 +23,7 @@ namespace IBM.Watson.Discovery.V1.Model
2323
/// <summary>
2424
/// Calculation.
2525
/// </summary>
26-
public class Calculation: QueryAggregation
26+
public class Calculation : QueryAggregation
2727
{
2828
/// <summary>
2929
/// The field where the aggregation is located in the document.

Scripts/Services/Discovery/V1/Model/Enrichment.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2018, 2020.
2+
* (C) Copyright IBM Corp. 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -56,9 +56,9 @@ public class Enrichment
5656
/// When using `natual_language_understanding`, the **options** object must contain Natural Language
5757
/// Understanding options.
5858
///
59-
/// When using `elements` the **options** object must contain Element Classification options. Additionally,
60-
/// when using the `elements` enrichment the configuration specified and files ingested must meet all the
61-
/// criteria specified in [the
59+
/// When using `elements` the **options** object must contain Element Classification options. Additionally, when
60+
/// using the `elements` enrichment the configuration specified and files ingested must meet all the criteria
61+
/// specified in [the
6262
/// documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-element-classification#element-classification).
6363
/// </summary>
6464
[JsonProperty("enrichment", NullValueHandling = NullValueHandling.Ignore)]

Scripts/Services/Discovery/V1/Model/EnrichmentOptions.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -86,7 +86,7 @@ public class LanguageValue
8686
[JsonProperty("features", NullValueHandling = NullValueHandling.Ignore)]
8787
public NluEnrichmentFeatures Features { get; set; }
8888
/// <summary>
89-
/// *For use with `elements` enrichments only.* The element extraction model to use. Models available are:
89+
/// For use with `elements` enrichments only. The element extraction model to use. The only model available is
9090
/// `contract`.
9191
/// </summary>
9292
[JsonProperty("model", NullValueHandling = NullValueHandling.Ignore)]

Scripts/Services/Discovery/V1/Model/Filter.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -23,7 +23,7 @@ namespace IBM.Watson.Discovery.V1.Model
2323
/// <summary>
2424
/// Filter.
2525
/// </summary>
26-
public class Filter: QueryAggregation
26+
public class Filter : QueryAggregation
2727
{
2828
/// <summary>
2929
/// The match the aggregated results queried for.

Scripts/Services/Discovery/V1/Model/Histogram.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -23,7 +23,7 @@ namespace IBM.Watson.Discovery.V1.Model
2323
/// <summary>
2424
/// Histogram.
2525
/// </summary>
26-
public class Histogram: QueryAggregation
26+
public class Histogram : QueryAggregation
2727
{
2828
/// <summary>
2929
/// The field where the aggregation is located in the document.

Scripts/Services/Discovery/V1/Model/Nested.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -23,7 +23,7 @@ namespace IBM.Watson.Discovery.V1.Model
2323
/// <summary>
2424
/// Nested.
2525
/// </summary>
26-
public class Nested: QueryAggregation
26+
public class Nested : QueryAggregation
2727
{
2828
/// <summary>
2929
/// The area of the results the aggregation was restricted to.

Scripts/Services/Discovery/V1/Model/Notice.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -55,7 +55,7 @@ public class SeverityValue
5555
/// `missing_model`, `unsupported_model`, `smart_document_understanding_failed_incompatible_field`,
5656
/// `smart_document_understanding_failed_internal_error`, `smart_document_understanding_failed_internal_error`,
5757
/// `smart_document_understanding_failed_warning`, `smart_document_understanding_page_error`,
58-
/// `smart_document_understanding_page_warning`. **Note:** This is not a complete list, other values might be
58+
/// `smart_document_understanding_page_warning`. **Note:** This is not a complete list; other values might be
5959
/// returned.
6060
/// </summary>
6161
[JsonProperty("notice_id", NullValueHandling = NullValueHandling.Ignore)]
@@ -76,8 +76,8 @@ public class SeverityValue
7676
[JsonProperty("query_id", NullValueHandling = NullValueHandling.Ignore)]
7777
public virtual string QueryId { get; private set; }
7878
/// <summary>
79-
/// Ingestion or training step in which the notice occurred. Typical step values include: `classify_elements`,
80-
/// `smartDocumentUnderstanding`, `ingestion`, `indexing`, `convert`. **Note:** This is not a complete list,
79+
/// Ingestion or training step in which the notice occurred. Typical step values include:
80+
/// `smartDocumentUnderstanding`, `ingestion`, `indexing`, `convert`. **Note:** This is not a complete list;
8181
/// other values might be returned.
8282
/// </summary>
8383
[JsonProperty("step", NullValueHandling = NullValueHandling.Ignore)]

Scripts/Services/Discovery/V1/Model/QueryNoticesResult.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -24,7 +24,7 @@ namespace IBM.Watson.Discovery.V1.Model
2424
/// <summary>
2525
/// Query result object.
2626
/// </summary>
27-
public class QueryNoticesResult: DynamicModel<object>
27+
public class QueryNoticesResult : DynamicModel<object>
2828
{
2929
/// <summary>
3030
/// The type of the original source file.

Scripts/Services/Discovery/V1/Model/QueryResult.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -24,7 +24,7 @@ namespace IBM.Watson.Discovery.V1.Model
2424
/// <summary>
2525
/// Query result object.
2626
/// </summary>
27-
public class QueryResult: DynamicModel<object>
27+
public class QueryResult : DynamicModel<object>
2828
{
2929
/// <summary>
3030
/// The unique identifier of the document.

Scripts/Services/Discovery/V1/Model/Term.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -23,7 +23,7 @@ namespace IBM.Watson.Discovery.V1.Model
2323
/// <summary>
2424
/// Term.
2525
/// </summary>
26-
public class Term: QueryAggregation
26+
public class Term : QueryAggregation
2727
{
2828
/// <summary>
2929
/// The field where the aggregation is located in the document.

Scripts/Services/Discovery/V1/Model/Timeslice.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
2+
* (C) Copyright IBM Corp. 2021.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -23,7 +23,7 @@ namespace IBM.Watson.Discovery.V1.Model
2323
/// <summary>
2424
/// Timeslice.
2525
/// </summary>
26-
public class Timeslice: QueryAggregation
26+
public class Timeslice : QueryAggregation
2727
{
2828
/// <summary>
2929
/// The field where the aggregation is located in the document.

0 commit comments

Comments
 (0)