Skip to content

Commit

Permalink
feat(discoveryengine): update the api
Browse files Browse the repository at this point in the history
#### discoveryengine:v1

The following keys were added:
- schemas.GoogleCloudDiscoveryengineV1ImportDocumentsRequest.properties.forceRefreshContent.type (Total Keys: 1)

#### discoveryengine:v1alpha

The following keys were added:
- schemas.GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest.properties.forceRefreshContent.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaSearchResponse.properties.suggestedQuery.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo.properties.sqlRequest.$ref (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest (Total Keys: 3)
- schemas.GoogleCloudDiscoveryengineV1alphaStartConnectorRunRequest.properties.forceRefreshContent.type (Total Keys: 1)

#### discoveryengine:v1beta

The following keys were added:
- schemas.GoogleCloudDiscoveryengineV1betaImportDocumentsRequest.properties.forceRefreshContent.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1betaSearchResponse.properties.suggestedQuery.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo.properties.sqlRequest.$ref (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest (Total Keys: 3)
  • Loading branch information
yoshi-automation committed Jan 21, 2025
1 parent 6c3ff85 commit 9afd49f
Show file tree
Hide file tree
Showing 18 changed files with 150 additions and 41 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,7 @@ <h3>Method Details</h3>
&quot;gcsStagingDir&quot;: &quot;A String&quot;, # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.
&quot;projectId&quot;: &quot;A String&quot;, # The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
},
&quot;forceRefreshContent&quot;: True or False, # Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content.
&quot;gcsSource&quot;: { # Cloud Storage location for input content. # Cloud Storage location for the input content.
&quot;dataSchema&quot;: &quot;A String&quot;, # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.
&quot;inputUris&quot;: [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,7 @@ <h3>Method Details</h3>
&quot;gcsStagingDir&quot;: &quot;A String&quot;, # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.
&quot;projectId&quot;: &quot;A String&quot;, # The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
},
&quot;forceRefreshContent&quot;: True or False, # Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content.
&quot;gcsSource&quot;: { # Cloud Storage location for input content. # Cloud Storage location for the input content.
&quot;dataSchema&quot;: &quot;A String&quot;, # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.
&quot;inputUris&quot;: [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ <h3>Method Details</h3>
&quot;entities&quot;: [ # Specifies which Third Party Connector entities should be synced. If not specified, all entities will be synced.
&quot;A String&quot;,
],
&quot;forceRefreshContent&quot;: True or False, # Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content.
&quot;healthcareFhirResourceTypes&quot;: [ # The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty.
&quot;A String&quot;,
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -420,6 +420,7 @@ <h3>Method Details</h3>
&quot;gcsStagingDir&quot;: &quot;A String&quot;, # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.
&quot;projectId&quot;: &quot;A String&quot;, # The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
},
&quot;forceRefreshContent&quot;: True or False, # Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content.
&quot;gcsSource&quot;: { # Cloud Storage location for input content. # Cloud Storage location for the input content.
&quot;dataSchema&quot;: &quot;A String&quot;, # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.
&quot;inputUris&quot;: [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1478,6 +1478,9 @@ <h3>Method Details</h3>
&quot;naturalLanguageQueryUnderstandingInfo&quot;: { # Information describing what natural language understanding was done on the input query. # Natural language query understanding information for the returned results.
&quot;extractedFilters&quot;: &quot;A String&quot;, # The filters that were extracted from the input query.
&quot;rewrittenQuery&quot;: &quot;A String&quot;, # Rewritten input query minus the extracted filters.
&quot;sqlRequest&quot;: { # The SQL request that was generated from the natural language query understanding phase. # Optional. The SQL request that was generated from the natural language query understanding phase.
&quot;sqlQuery&quot;: &quot;A String&quot;, # Optional. The SQL query in text format.
},
&quot;structuredExtractedFilter&quot;: { # The filters that were extracted from the input query represented in a structured form. # The filters that were extracted from the input query represented in a structured form.
&quot;expression&quot;: { # The expression denoting the filter that was extracted from the input query. # The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators.
&quot;andExpr&quot;: { # Logical `And` operator. # Logical &quot;And&quot; compound operator connecting multiple expressions.
Expand Down Expand Up @@ -1711,6 +1714,7 @@ <h3>Method Details</h3>
&quot;name&quot;: &quot;A String&quot;, # Name of the session. If the auto-session mode is used (when SearchRequest.session ends with &quot;-&quot;), this field holds the newly generated session name.
&quot;queryId&quot;: &quot;A String&quot;, # Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call.
},
&quot;suggestedQuery&quot;: &quot;A String&quot;, # Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus).
&quot;summary&quot;: { # Summary of the top N search results specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.
&quot;safetyAttributes&quot;: { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
&quot;categories&quot;: [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
Expand Down Expand Up @@ -1998,6 +2002,9 @@ <h3>Method Details</h3>
&quot;naturalLanguageQueryUnderstandingInfo&quot;: { # Information describing what natural language understanding was done on the input query. # Natural language query understanding information for the returned results.
&quot;extractedFilters&quot;: &quot;A String&quot;, # The filters that were extracted from the input query.
&quot;rewrittenQuery&quot;: &quot;A String&quot;, # Rewritten input query minus the extracted filters.
&quot;sqlRequest&quot;: { # The SQL request that was generated from the natural language query understanding phase. # Optional. The SQL request that was generated from the natural language query understanding phase.
&quot;sqlQuery&quot;: &quot;A String&quot;, # Optional. The SQL query in text format.
},
&quot;structuredExtractedFilter&quot;: { # The filters that were extracted from the input query represented in a structured form. # The filters that were extracted from the input query represented in a structured form.
&quot;expression&quot;: { # The expression denoting the filter that was extracted from the input query. # The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators.
&quot;andExpr&quot;: { # Logical `And` operator. # Logical &quot;And&quot; compound operator connecting multiple expressions.
Expand Down Expand Up @@ -2231,6 +2238,7 @@ <h3>Method Details</h3>
&quot;name&quot;: &quot;A String&quot;, # Name of the session. If the auto-session mode is used (when SearchRequest.session ends with &quot;-&quot;), this field holds the newly generated session name.
&quot;queryId&quot;: &quot;A String&quot;, # Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call.
},
&quot;suggestedQuery&quot;: &quot;A String&quot;, # Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus).
&quot;summary&quot;: { # Summary of the top N search results specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.
&quot;safetyAttributes&quot;: { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
&quot;categories&quot;: [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1478,6 +1478,9 @@ <h3>Method Details</h3>
&quot;naturalLanguageQueryUnderstandingInfo&quot;: { # Information describing what natural language understanding was done on the input query. # Natural language query understanding information for the returned results.
&quot;extractedFilters&quot;: &quot;A String&quot;, # The filters that were extracted from the input query.
&quot;rewrittenQuery&quot;: &quot;A String&quot;, # Rewritten input query minus the extracted filters.
&quot;sqlRequest&quot;: { # The SQL request that was generated from the natural language query understanding phase. # Optional. The SQL request that was generated from the natural language query understanding phase.
&quot;sqlQuery&quot;: &quot;A String&quot;, # Optional. The SQL query in text format.
},
&quot;structuredExtractedFilter&quot;: { # The filters that were extracted from the input query represented in a structured form. # The filters that were extracted from the input query represented in a structured form.
&quot;expression&quot;: { # The expression denoting the filter that was extracted from the input query. # The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators.
&quot;andExpr&quot;: { # Logical `And` operator. # Logical &quot;And&quot; compound operator connecting multiple expressions.
Expand Down Expand Up @@ -1711,6 +1714,7 @@ <h3>Method Details</h3>
&quot;name&quot;: &quot;A String&quot;, # Name of the session. If the auto-session mode is used (when SearchRequest.session ends with &quot;-&quot;), this field holds the newly generated session name.
&quot;queryId&quot;: &quot;A String&quot;, # Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call.
},
&quot;suggestedQuery&quot;: &quot;A String&quot;, # Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus).
&quot;summary&quot;: { # Summary of the top N search results specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.
&quot;safetyAttributes&quot;: { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
&quot;categories&quot;: [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
Expand Down Expand Up @@ -1998,6 +2002,9 @@ <h3>Method Details</h3>
&quot;naturalLanguageQueryUnderstandingInfo&quot;: { # Information describing what natural language understanding was done on the input query. # Natural language query understanding information for the returned results.
&quot;extractedFilters&quot;: &quot;A String&quot;, # The filters that were extracted from the input query.
&quot;rewrittenQuery&quot;: &quot;A String&quot;, # Rewritten input query minus the extracted filters.
&quot;sqlRequest&quot;: { # The SQL request that was generated from the natural language query understanding phase. # Optional. The SQL request that was generated from the natural language query understanding phase.
&quot;sqlQuery&quot;: &quot;A String&quot;, # Optional. The SQL query in text format.
},
&quot;structuredExtractedFilter&quot;: { # The filters that were extracted from the input query represented in a structured form. # The filters that were extracted from the input query represented in a structured form.
&quot;expression&quot;: { # The expression denoting the filter that was extracted from the input query. # The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators.
&quot;andExpr&quot;: { # Logical `And` operator. # Logical &quot;And&quot; compound operator connecting multiple expressions.
Expand Down Expand Up @@ -2231,6 +2238,7 @@ <h3>Method Details</h3>
&quot;name&quot;: &quot;A String&quot;, # Name of the session. If the auto-session mode is used (when SearchRequest.session ends with &quot;-&quot;), this field holds the newly generated session name.
&quot;queryId&quot;: &quot;A String&quot;, # Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call.
},
&quot;suggestedQuery&quot;: &quot;A String&quot;, # Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus).
&quot;summary&quot;: { # Summary of the top N search results specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.
&quot;safetyAttributes&quot;: { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
&quot;categories&quot;: [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
Expand Down
Loading

0 comments on commit 9afd49f

Please sign in to comment.