@alicloud/gpdb20160503 3.0.1 → 3.0.3

package/src/models/QueryContentResponseBody.ts

@@ -3,45 +3,10 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class QueryContentResponseBodyEntitiesEntities extends $dara.Model {
-  /**
-   * @remarks
-   * Entity description.
-   * 
-   * @example
-   * A former advisor at DeepMind.
-   */
   description?: string;
-  /**
-   * @remarks
-   * The entity name.
-   * 
-   * @example
-   * Dr. Wang
-   */
   entity?: string;
-  /**
-   * @remarks
-   * The file name.
-   * 
-   * @example
-   * my_doc.txt
-   */
   fileName?: string;
-  /**
-   * @remarks
-   * The entity ID.
-   * 
-   * @example
-   * 1
-   */
   id?: string;
-  /**
-   * @remarks
-   * The entity type.
-   * 
-   * @example
-   * Figure
-   */
   type?: string;
   static names(): { [key: string]: string } {
     return {
@@ -125,89 +90,15 @@ export class QueryContentResponseBodyMatchesMatchListVector extends $dara.Model
 }
 
 export class QueryContentResponseBodyMatchesMatchList extends $dara.Model {
-  /**
-   * @remarks
-   * The content that is used for full-text search. If you leave this parameter empty, only vector search is used. If you do not leave this parameter empty, two-way retrieval based on vector search and full-text search is used.
-   * 
-   * >  You must specify at least one of the Content and Vector parameters.
-   * 
-   * @example
-   * Cloud-native data warehouse AnalyticDB PostgreSQL Edition provides a simple, fast, and cost-effective PB-level cloud data warehouse solution.
-   */
   content?: string;
-  /**
-   * @remarks
-   * The name of the document.
-   * 
-   * >  You can call the [ListDocuments](https://help.aliyun.com/document_detail/2618453.html) operation to query a list of documents.
-   * 
-   * @example
-   * my_doc.txt
-   */
   fileName?: string;
-  /**
-   * @remarks
-   * The public URL of the query result image, valid for 2 hours
-   * 
-   * @example
-   * https://xxx-cn-beijing.aliyuncs.com/image/test.png
-   */
   fileURL?: string;
-  /**
-   * @remarks
-   * The unique ID of the vector data.
-   * 
-   * @example
-   * doca-1234
-   */
   id?: string;
-  /**
-   * @remarks
-   * Metadata during document loader loading.
-   * 
-   * @example
-   * {"page_pos": 1}
-   */
   loaderMetadata?: string;
-  /**
-   * @remarks
-   * The metadata.
-   */
   metadata?: { [key: string]: string };
-  /**
-   * @remarks
-   * Re-ranking score.
-   * 
-   * @example
-   * 6.2345
-   */
   rerankScore?: number;
-  /**
-   * @remarks
-   * Source of the retrieval results:
-   * 
-   * - 1 indicates vector retrieval
-   * - 2 indicates full-text retrieval
-   * - 3 indicates dual-path recall
-   * 
-   * @example
-   * 1
-   */
   retrievalSource?: number;
-  /**
-   * @remarks
-   * The similarity score of the data. It is related to the `l2, ip, or cosine` algorithm that is specified when you create an index.
-   * 
-   * @example
-   * 0.12345
-   */
   score?: number;
-  /**
-   * @remarks
-   * The vector data. The length of the value must be the same as that of the Dimension parameter in the [CreateCollection](https://help.aliyun.com/document_detail/2401497.html) operation.
-   * 
-   * >  If you leave this parameter empty, only full-text search results are returned.
-   */
   vector?: QueryContentResponseBodyMatchesMatchListVector;
   static names(): { [key: string]: string } {
     return {
@@ -281,45 +172,10 @@ export class QueryContentResponseBodyMatches extends $dara.Model {
 }
 
 export class QueryContentResponseBodyRelationsRelations extends $dara.Model {
-  /**
-   * @remarks
-   * The description of the relationship edge.
-   * 
-   * @example
-   * Dr. Wang previously served as an advisor at DeepMind.
-   */
   description?: string;
-  /**
-   * @remarks
-   * The file name.
-   * 
-   * @example
-   * my_doc.txt
-   */
   fileName?: string;
-  /**
-   * @remarks
-   * The ID of the relationship edge.
-   * 
-   * @example
-   * 1
-   */
   id?: string;
-  /**
-   * @remarks
-   * The source entity.
-   * 
-   * @example
-   * Former DeepMind consultant
-   */
   sourceEntity?: string;
-  /**
-   * @remarks
-   * The destination entity.
-   * 
-   * @example
-   * Dr. Wang
-   */
   targetEntity?: string;
   static names(): { [key: string]: string } {
     return {
@@ -420,42 +276,10 @@ export class QueryContentResponseBodyUsage extends $dara.Model {
 }
 
 export class QueryContentResponseBodyWindowMatchesWindowMatchesWindowMatchWindowMatch extends $dara.Model {
-  /**
-   * @remarks
-   * Text content.
-   * 
-   * @example
-   * AnalyticDB for PostgreSQL is a cloud-native data warehouse service that provides large-scale parallel processing (MPP) capabilities for massive online data analysis.
-   */
   content?: string;
-  /**
-   * @remarks
-   * File name.
-   * 
-   * @example
-   * my_doc.txt
-   */
   fileName?: string;
-  /**
-   * @remarks
-   * Unique ID of the vector data.
-   * 
-   * @example
-   * doca-2345
-   */
   id?: string;
-  /**
-   * @remarks
-   * Metadata information when the document loader was loaded.
-   * 
-   * @example
-   * {"page_pos": 2}
-   */
   loaderMetadata?: string;
-  /**
-   * @remarks
-   * Metadata map.
-   */
   metadata?: { [key: string]: string };
   static names(): { [key: string]: string } {
     return {
@@ -516,10 +340,6 @@ export class QueryContentResponseBodyWindowMatchesWindowMatchesWindowMatch exten
 }
 
 export class QueryContentResponseBodyWindowMatchesWindowMatches extends $dara.Model {
-  /**
-   * @remarks
-   * List of individual top windowed matches.
-   */
   windowMatch?: QueryContentResponseBodyWindowMatchesWindowMatchesWindowMatch;
   static names(): { [key: string]: string } {
     return {
@@ -582,15 +402,7 @@ export class QueryContentResponseBody extends $dara.Model {
    * 100
    */
   embeddingTokens?: string;
-  /**
-   * @remarks
-   * The entities.
-   */
   entities?: QueryContentResponseBodyEntities;
-  /**
-   * @remarks
-   * The retrieved data.
-   */
   matches?: QueryContentResponseBodyMatches;
   /**
    * @remarks
@@ -600,10 +412,6 @@ export class QueryContentResponseBody extends $dara.Model {
    * success
    */
   message?: string;
-  /**
-   * @remarks
-   * The list of relationship edges.
-   */
   relations?: QueryContentResponseBodyRelations;
   /**
    * @remarks
@@ -629,10 +437,6 @@ export class QueryContentResponseBody extends $dara.Model {
    * Resource usage for this query.
    */
   usage?: QueryContentResponseBodyUsage;
-  /**
-   * @remarks
-   * List of windowed matches.
-   */
   windowMatches?: QueryContentResponseBodyWindowMatches;
   static names(): { [key: string]: string } {
     return {

package/src/models/QueryContentShrinkRequest.ts

@@ -15,6 +15,13 @@ export class QueryContentShrinkRequest extends $dara.Model {
    * document
    */
   collection?: string;
+  /**
+   * @remarks
+   * Text content for retrieval.
+   * 
+   * @example
+   * What is ADBPG?
+   */
   content?: string;
   /**
    * @remarks

package/src/models/QueryKnowledgeBasesContentResponseBody.ts

@@ -3,42 +3,10 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class QueryKnowledgeBasesContentResponseBodyEntitiesEntities extends $dara.Model {
-  /**
-   * @remarks
-   * The entity description.
-   * 
-   * @example
-   * A former advisor at DeepMind.
-   */
   description?: string;
-  /**
-   * @remarks
-   * The name of the entity.
-   * 
-   * @example
-   * Dr. Wang
-   */
   entity?: string;
-  /**
-   * @remarks
-   * The name of the file.
-   * 
-   * @example
-   * my_doc.txt
-   */
   fileName?: string;
-  /**
-   * @remarks
-   * The entity ID.
-   * 
-   * @example
-   * 1
-   */
   id?: string;
-  /**
-   * @remarks
-   * The entity type.
-   */
   type?: string;
   static names(): { [key: string]: string } {
     return {
@@ -96,73 +64,14 @@ export class QueryKnowledgeBasesContentResponseBodyEntities extends $dara.Model
 }
 
 export class QueryKnowledgeBasesContentResponseBodyMatchesMatchList extends $dara.Model {
-  /**
-   * @remarks
-   * The content of the text.
-   */
   content?: string;
-  /**
-   * @remarks
-   * The name of the file.
-   * 
-   * @example
-   * my_doc.txt
-   */
   fileName?: string;
-  /**
-   * @remarks
-   * The public network URL of the image result. By default, the URL is valid for 2 hours.
-   * 
-   * You can use the UrlExpiration parameter to specify a validity period.
-   * 
-   * @example
-   * https://xxx-cn-beijing.aliyuncs.com/image/test.png
-   */
   fileURL?: string;
-  /**
-   * @remarks
-   * The unique ID of the vector data.
-   * 
-   * @example
-   * doca-1234
-   */
   id?: string;
-  /**
-   * @remarks
-   * Document loader metadata.
-   * 
-   * @example
-   * {"page_pos": 1}
-   */
   loaderMetadata?: string;
-  /**
-   * @remarks
-   * The metadata map.
-   */
   metadata?: { [key: string]: string };
-  /**
-   * @remarks
-   * The rerank score.
-   * 
-   * @example
-   * 6.2345
-   */
   rerankScore?: number;
-  /**
-   * @remarks
-   * The source of the retrieval results. 1 indicates vector retrieval, 2 indicates full-text retrieval, and 3 indicates dual-path retrieval.
-   * 
-   * @example
-   * 1
-   */
   retrievalSource?: number;
-  /**
-   * @remarks
-   * The similarity score of the data. It is related to the algorithm (l2, ip, or cosine) that is specified when you create an index.
-   * 
-   * @example
-   * 0.12345
-   */
   score?: number;
   static names(): { [key: string]: string } {
     return {
@@ -231,42 +140,10 @@ export class QueryKnowledgeBasesContentResponseBodyMatches extends $dara.Model {
 }
 
 export class QueryKnowledgeBasesContentResponseBodyRelationsRelations extends $dara.Model {
-  /**
-   * @remarks
-   * The description of the relationship edge.
-   * 
-   * @example
-   * Dr. Wang previously served as an advisor at DeepMind.
-   */
   description?: string;
-  /**
-   * @remarks
-   * The name of the file.
-   * 
-   * @example
-   * my_doc.txt
-   */
   fileName?: string;
-  /**
-   * @remarks
-   * The ID of the link.
-   * 
-   * @example
-   * 1
-   */
   id?: string;
-  /**
-   * @remarks
-   * The source entity.
-   */
   sourceEntity?: string;
-  /**
-   * @remarks
-   * The destination entity.
-   * 
-   * @example
-   * Dr. Wang
-   */
   targetEntity?: string;
   static names(): { [key: string]: string } {
     return {
@@ -378,15 +255,7 @@ export class QueryKnowledgeBasesContentResponseBody extends $dara.Model {
    * 100
    */
   embeddingTokens?: string;
-  /**
-   * @remarks
-   * The details of the entity.
-   */
   entities?: QueryKnowledgeBasesContentResponseBodyEntities;
-  /**
-   * @remarks
-   * A single data record.
-   */
   matches?: QueryKnowledgeBasesContentResponseBodyMatches;
   /**
    * @remarks
@@ -396,10 +265,6 @@ export class QueryKnowledgeBasesContentResponseBody extends $dara.Model {
    * success
    */
   message?: string;
-  /**
-   * @remarks
-   * The details of the relationship edge.
-   */
   relations?: QueryKnowledgeBasesContentResponseBodyRelations;
   /**
    * @remarks

package/src/models/RerankResponseBody.ts

@@ -3,29 +3,8 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class RerankResponseBodyResultsResults extends $dara.Model {
-  /**
-   * @remarks
-   * Re-ordered document information.
-   * 
-   * @example
-   * ADBPG is the OLAP database of Alibaba Cloud.
-   */
   document?: string;
-  /**
-   * @remarks
-   * Index of this document in the request parameter Documents, starting from 0.
-   * 
-   * @example
-   * 1
-   */
   index?: number;
-  /**
-   * @remarks
-   * Rerank similarity score.
-   * 
-   * @example
-   * 2.31412
-   */
   relevanceScore?: number;
   static names(): { [key: string]: string } {
     return {
@@ -95,10 +74,6 @@ export class RerankResponseBody extends $dara.Model {
    * ABB39CC3-4488-4857-905D-2E4A051D0521
    */
   requestId?: string;
-  /**
-   * @remarks
-   * Rerank results.
-   */
   results?: RerankResponseBodyResults;
   /**
    * @remarks

package/src/models/TextEmbeddingResponseBody.ts

@@ -29,18 +29,7 @@ export class TextEmbeddingResponseBodyResultsResultsEmbedding extends $dara.Mode
 }
 
 export class TextEmbeddingResponseBodyResultsResults extends $dara.Model {
-  /**
-   * @remarks
-   * The embedding values.
-   */
   embedding?: TextEmbeddingResponseBodyResultsResultsEmbedding;
-  /**
-   * @remarks
-   * The number of the embedding in the Input request parameter, which starts from 0.
-   * 
-   * @example
-   * 0
-   */
   index?: number;
   static names(): { [key: string]: string } {
     return {
@@ -111,10 +100,6 @@ export class TextEmbeddingResponseBody extends $dara.Model {
    * ABB39CC3-4488-4857-905D-2E4A051D0521
    */
   requestId?: string;
-  /**
-   * @remarks
-   * The embedding results.
-   */
   results?: TextEmbeddingResponseBodyResults;
   /**
    * @remarks

package/src/models/UpsertCollectionDataRequest.ts

@@ -3,7 +3,17 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpsertCollectionDataRequestRowsSparseVector extends $dara.Model {
+  /**
+   * @remarks
+   * The indices.
+   * 
+   * >  The size of indices cannot exceed 4000.
+   */
   indices?: number[];
+  /**
+   * @remarks
+   * The sparse vector values.
+   */
   values?: number[];
   static names(): { [key: string]: string } {
     return {
@@ -35,11 +45,30 @@ export class UpsertCollectionDataRequestRowsSparseVector extends $dara.Model {
 }
 
 export class UpsertCollectionDataRequestRows extends $dara.Model {
+  /**
+   * @remarks
+   * The unique ID of the vector data.
+   * 
+   * >  If you leave this parameter empty, a unique ID is automatically generated by using uuidgen. If you specify a value that is the same as an existing ID, an updated vector data ID is used.
+   * 
+   * @example
+   * doca-1234
+   */
   id?: string;
+  /**
+   * @remarks
+   * The metadata of the vector data. The key field of this parameter must be the same as the key field of Metadata that is specified when you call the [CreateCollection](https://help.aliyun.com/document_detail/2401497.html) operation.
+   */
   metadata?: { [key: string]: string };
+  /**
+   * @remarks
+   * The sparse vector data.
+   */
   sparseVector?: UpsertCollectionDataRequestRowsSparseVector;
   /**
    * @remarks
+   * The vector data. The length of the vector data must be the same as the value of Dimension that is specified when you call the [CreateCollection](https://help.aliyun.com/document_detail/2401497.html) operation.
+   * 
    * This parameter is required.
    */
   vector?: number[];
@@ -133,6 +162,10 @@ export class UpsertCollectionDataRequest extends $dara.Model {
    * cn-hangzhou
    */
   regionId?: string;
+  /**
+   * @remarks
+   * The vector data that you want to upload.
+   */
   rows?: UpsertCollectionDataRequestRows[];
   /**
    * @remarks

package/src/models/UpsertCollectionDataShrinkRequest.ts

@@ -56,6 +56,10 @@ export class UpsertCollectionDataShrinkRequest extends $dara.Model {
    * cn-hangzhou
    */
   regionId?: string;
+  /**
+   * @remarks
+   * The vector data that you want to upload.
+   */
   rowsShrink?: string;
   /**
    * @remarks