diff --git a/DeveloperKnowledge/metadata/V1/Developerknowledge.php b/DeveloperKnowledge/metadata/V1/Developerknowledge.php index b6cc3dc7596..4940dd98090 100644 --- a/DeveloperKnowledge/metadata/V1/Developerknowledge.php +++ b/DeveloperKnowledge/metadata/V1/Developerknowledge.php @@ -20,7 +20,7 @@ public static function initOnce() { \GPBMetadata\Google\Api\Resource::initOnce(); \GPBMetadata\Google\Protobuf\Timestamp::initOnce(); $pool->internalAddGeneratedFile( - "\x0A\x83\x1A\x0A7google/developers/knowledge/v1/developerknowledge.proto\x12\x1Egoogle.developers.knowledge.v1\x1A\x17google/api/client.proto\x1A\x1Fgoogle/api/field_behavior.proto\x1A\x19google/api/resource.proto\x1A\x1Fgoogle/protobuf/timestamp.proto\"\x83\x03\x0A\x08Document\x12\x11\x0A\x04name\x18\x01 \x01(\x09B\x03\xE0A\x08\x12\x10\x0A\x03uri\x18\x02 \x01(\x09B\x03\xE0A\x03\x12\x14\x0A\x07content\x18\x03 \x01(\x09B\x03\xE0A\x03\x12\x18\x0A\x0Bdescription\x18\x04 \x01(\x09B\x03\xE0A\x03\x12\x18\x0A\x0Bdata_source\x18\x05 \x01(\x09B\x03\xE0A\x03\x12\x12\x0A\x05title\x18\x06 \x01(\x09B\x03\xE0A\x03\x124\x0A\x0Bupdate_time\x18\x07 \x01(\x0B2\x1A.google.protobuf.TimestampB\x03\xE0A\x03\x12?\x0A\x04view\x18\x08 \x01(\x0E2,.google.developers.knowledge.v1.DocumentViewB\x03\xE0A\x03\x12!\x0A\x14content_length_bytes\x18\x09 \x01(\x05B\x03\xE0A\x03:Z\xEAAW\x0A*developerknowledge.googleapis.com/Document\x12\x14documents/{document}*\x09documents2\x08document\"w\x0A\x1BSearchDocumentChunksRequest\x12\x12\x0A\x05query\x18\x01 \x01(\x09B\x03\xE0A\x02\x12\x16\x0A\x09page_size\x18\x02 \x01(\x05B\x03\xE0A\x01\x12\x17\x0A\x0Apage_token\x18\x03 \x01(\x09B\x03\xE0A\x01\x12\x13\x0A\x06filter\x18\x04 \x01(\x09B\x03\xE0A\x01\"|\x0A\x1CSearchDocumentChunksResponse\x12>\x0A\x07results\x18\x01 \x03(\x0B2-.google.developers.knowledge.v1.DocumentChunk\x12\x1C\x0A\x0Fnext_page_token\x18\x02 \x01(\x09B\x03\xE0A\x01\"\x97\x01\x0A\x12GetDocumentRequest\x12@\x0A\x04name\x18\x01 \x01(\x09B2\xE0A\x02\xFAA,\x0A*developerknowledge.googleapis.com/Document\x12?\x0A\x04view\x18\x02 \x01(\x0E2,.google.developers.knowledge.v1.DocumentViewB\x03\xE0A\x01\"\x9E\x01\x0A\x18BatchGetDocumentsRequest\x12A\x0A\x05names\x18\x01 \x03(\x09B2\xE0A\x02\xFAA,\x0A*developerknowledge.googleapis.com/Document\x12?\x0A\x04view\x18\x02 \x01(\x0E2,.google.developers.knowledge.v1.DocumentViewB\x03\xE0A\x01\"X\x0A\x19BatchGetDocumentsResponse\x12;\x0A\x09documents\x18\x01 \x03(\x0B2(.google.developers.knowledge.v1.Document\"(\x0A\x12AnswerQueryRequest\x12\x12\x0A\x05query\x18\x01 \x01(\x09B\x03\xE0A\x02\"M\x0A\x13AnswerQueryResponse\x126\x0A\x06answer\x18\x01 \x01(\x0B2&.google.developers.knowledge.v1.Answer\"\xDB\x04\x0A\x06Answer\x12\x13\x0A\x0Banswer_text\x18\x01 \x01(\x09\x12M\x0A\x09citations\x18\x02 \x03(\x0B25.google.developers.knowledge.v1.Answer.AnswerCitationB\x03\xE0A\x03\x12O\x0A\x0Areferences\x18\x03 \x03(\x0B26.google.developers.knowledge.v1.Answer.AnswerReferenceB\x03\xE0A\x03\x1A\x8F\x01\x0A\x0EAnswerCitation\x12\x18\x0A\x0Bstart_index\x18\x01 \x01(\x05B\x03\xE0A\x03\x12\x16\x0A\x09end_index\x18\x02 \x01(\x05B\x03\xE0A\x03\x12K\x0A\x07sources\x18\x03 \x03(\x0B25.google.developers.knowledge.v1.Answer.CitationSourceB\x03\xE0A\x03\x1A.\x0A\x0ECitationSource\x12\x1C\x0A\x0Freference_index\x18\x01 \x01(\x05B\x03\xE0A\x03\x1Ay\x0A\x0FAnswerReference\x12[\x0A\x12document_reference\x18\x01 \x01(\x0B28.google.developers.knowledge.v1.Answer.DocumentReferenceB\x03\xE0A\x03H\x00B\x09\x0A\x07content\x1A_\x0A\x11DocumentReference\x12J\x0A\x0Edocument_chunk\x18\x01 \x01(\x0B2-.google.developers.knowledge.v1.DocumentChunkB\x03\xE0A\x03\"\xBB\x01\x0A\x0DDocumentChunk\x12B\x0A\x06parent\x18\x01 \x01(\x09B2\xE0A\x03\xFAA,\x0A*developerknowledge.googleapis.com/Document\x12\x0F\x0A\x02id\x18\x02 \x01(\x09B\x03\xE0A\x03\x12\x14\x0A\x07content\x18\x03 \x01(\x09B\x03\xE0A\x03\x12?\x0A\x08document\x18\x04 \x01(\x0B2(.google.developers.knowledge.v1.DocumentB\x03\xE0A\x03*y\x0A\x0CDocumentView\x12\x1D\x0A\x19DOCUMENT_VIEW_UNSPECIFIED\x10\x00\x12\x17\x0A\x13DOCUMENT_VIEW_BASIC\x10\x01\x12\x16\x0A\x12DOCUMENT_VIEW_FULL\x10\x02\x12\x19\x0A\x15DOCUMENT_VIEW_CONTENT\x10\x032\x81\x06\x0A\x12DeveloperKnowledge\x12\xBD\x01\x0A\x14SearchDocumentChunks\x12;.google.developers.knowledge.v1.SearchDocumentChunksRequest\x1A<.google.developers.knowledge.v1.SearchDocumentChunksResponse\"*\x82\xD3\xE4\x93\x02\$\x12\"/v1/documents:searchDocumentChunks\x12\x93\x01\x0A\x0BGetDocument\x122.google.developers.knowledge.v1.GetDocumentRequest\x1A(.google.developers.knowledge.v1.Document\"&\xDAA\x04name\x82\xD3\xE4\x93\x02\x19\x12\x17/v1/{name=documents/**}\x12\xA8\x01\x0A\x11BatchGetDocuments\x128.google.developers.knowledge.v1.BatchGetDocumentsRequest\x1A9.google.developers.knowledge.v1.BatchGetDocumentsResponse\"\x1E\x82\xD3\xE4\x93\x02\x18\x12\x16/v1/documents:batchGet\x12\x92\x01\x0A\x0BAnswerQuery\x122.google.developers.knowledge.v1.AnswerQueryRequest\x1A3.google.developers.knowledge.v1.AnswerQueryResponse\"\x1A\x82\xD3\xE4\x93\x02\x14\"\x0F/v1:answerQuery:\x01*\x1AU\xCAA!developerknowledge.googleapis.com\xD2A.https://www.googleapis.com/auth/cloud-platformB\x83\x02\x0A\"com.google.developers.knowledge.v1B\x17DeveloperKnowledgeProtoP\x01ZAcloud.google.com/go/developerknowledge/apiv1/developerknowledgepb\xAA\x02'Google.Developers.DeveloperKnowledge.V1\xCA\x02'Google\\Developers\\DeveloperKnowledge\\V1\xEA\x02*Google::Developers::DeveloperKnowledge::V1b\x06proto3" + "\x0A\xFE\x19\x0A7google/developers/knowledge/v1/developerknowledge.proto\x12\x1Egoogle.developers.knowledge.v1\x1A\x17google/api/client.proto\x1A\x1Fgoogle/api/field_behavior.proto\x1A\x19google/api/resource.proto\x1A\x1Fgoogle/protobuf/timestamp.proto\"\x83\x03\x0A\x08Document\x12\x11\x0A\x04name\x18\x01 \x01(\x09B\x03\xE0A\x08\x12\x10\x0A\x03uri\x18\x02 \x01(\x09B\x03\xE0A\x03\x12\x14\x0A\x07content\x18\x03 \x01(\x09B\x03\xE0A\x03\x12\x18\x0A\x0Bdescription\x18\x04 \x01(\x09B\x03\xE0A\x03\x12\x18\x0A\x0Bdata_source\x18\x05 \x01(\x09B\x03\xE0A\x03\x12\x12\x0A\x05title\x18\x06 \x01(\x09B\x03\xE0A\x03\x124\x0A\x0Bupdate_time\x18\x07 \x01(\x0B2\x1A.google.protobuf.TimestampB\x03\xE0A\x03\x12?\x0A\x04view\x18\x08 \x01(\x0E2,.google.developers.knowledge.v1.DocumentViewB\x03\xE0A\x03\x12!\x0A\x14content_length_bytes\x18\x09 \x01(\x05B\x03\xE0A\x03:Z\xEAAW\x0A*developerknowledge.googleapis.com/Document\x12\x14documents/{document}*\x09documents2\x08document\"w\x0A\x1BSearchDocumentChunksRequest\x12\x12\x0A\x05query\x18\x01 \x01(\x09B\x03\xE0A\x02\x12\x16\x0A\x09page_size\x18\x02 \x01(\x05B\x03\xE0A\x01\x12\x17\x0A\x0Apage_token\x18\x03 \x01(\x09B\x03\xE0A\x01\x12\x13\x0A\x06filter\x18\x04 \x01(\x09B\x03\xE0A\x01\"w\x0A\x1CSearchDocumentChunksResponse\x12>\x0A\x07results\x18\x01 \x03(\x0B2-.google.developers.knowledge.v1.DocumentChunk\x12\x17\x0A\x0Fnext_page_token\x18\x02 \x01(\x09\"\x97\x01\x0A\x12GetDocumentRequest\x12@\x0A\x04name\x18\x01 \x01(\x09B2\xE0A\x02\xFAA,\x0A*developerknowledge.googleapis.com/Document\x12?\x0A\x04view\x18\x02 \x01(\x0E2,.google.developers.knowledge.v1.DocumentViewB\x03\xE0A\x01\"\x9E\x01\x0A\x18BatchGetDocumentsRequest\x12A\x0A\x05names\x18\x01 \x03(\x09B2\xE0A\x02\xFAA,\x0A*developerknowledge.googleapis.com/Document\x12?\x0A\x04view\x18\x02 \x01(\x0E2,.google.developers.knowledge.v1.DocumentViewB\x03\xE0A\x01\"X\x0A\x19BatchGetDocumentsResponse\x12;\x0A\x09documents\x18\x01 \x03(\x0B2(.google.developers.knowledge.v1.Document\"(\x0A\x12AnswerQueryRequest\x12\x12\x0A\x05query\x18\x01 \x01(\x09B\x03\xE0A\x02\"M\x0A\x13AnswerQueryResponse\x126\x0A\x06answer\x18\x01 \x01(\x0B2&.google.developers.knowledge.v1.Answer\"\xDB\x04\x0A\x06Answer\x12\x13\x0A\x0Banswer_text\x18\x01 \x01(\x09\x12M\x0A\x09citations\x18\x02 \x03(\x0B25.google.developers.knowledge.v1.Answer.AnswerCitationB\x03\xE0A\x03\x12O\x0A\x0Areferences\x18\x03 \x03(\x0B26.google.developers.knowledge.v1.Answer.AnswerReferenceB\x03\xE0A\x03\x1A\x8F\x01\x0A\x0EAnswerCitation\x12\x18\x0A\x0Bstart_index\x18\x01 \x01(\x05B\x03\xE0A\x03\x12\x16\x0A\x09end_index\x18\x02 \x01(\x05B\x03\xE0A\x03\x12K\x0A\x07sources\x18\x03 \x03(\x0B25.google.developers.knowledge.v1.Answer.CitationSourceB\x03\xE0A\x03\x1A.\x0A\x0ECitationSource\x12\x1C\x0A\x0Freference_index\x18\x01 \x01(\x05B\x03\xE0A\x03\x1Ay\x0A\x0FAnswerReference\x12[\x0A\x12document_reference\x18\x01 \x01(\x0B28.google.developers.knowledge.v1.Answer.DocumentReferenceB\x03\xE0A\x03H\x00B\x09\x0A\x07content\x1A_\x0A\x11DocumentReference\x12J\x0A\x0Edocument_chunk\x18\x01 \x01(\x0B2-.google.developers.knowledge.v1.DocumentChunkB\x03\xE0A\x03\"\xBB\x01\x0A\x0DDocumentChunk\x12B\x0A\x06parent\x18\x01 \x01(\x09B2\xE0A\x03\xFAA,\x0A*developerknowledge.googleapis.com/Document\x12\x0F\x0A\x02id\x18\x02 \x01(\x09B\x03\xE0A\x03\x12\x14\x0A\x07content\x18\x03 \x01(\x09B\x03\xE0A\x03\x12?\x0A\x08document\x18\x04 \x01(\x0B2(.google.developers.knowledge.v1.DocumentB\x03\xE0A\x03*y\x0A\x0CDocumentView\x12\x1D\x0A\x19DOCUMENT_VIEW_UNSPECIFIED\x10\x00\x12\x17\x0A\x13DOCUMENT_VIEW_BASIC\x10\x01\x12\x16\x0A\x12DOCUMENT_VIEW_FULL\x10\x02\x12\x19\x0A\x15DOCUMENT_VIEW_CONTENT\x10\x032\x81\x06\x0A\x12DeveloperKnowledge\x12\xBD\x01\x0A\x14SearchDocumentChunks\x12;.google.developers.knowledge.v1.SearchDocumentChunksRequest\x1A<.google.developers.knowledge.v1.SearchDocumentChunksResponse\"*\x82\xD3\xE4\x93\x02\$\x12\"/v1/documents:searchDocumentChunks\x12\x93\x01\x0A\x0BGetDocument\x122.google.developers.knowledge.v1.GetDocumentRequest\x1A(.google.developers.knowledge.v1.Document\"&\xDAA\x04name\x82\xD3\xE4\x93\x02\x19\x12\x17/v1/{name=documents/**}\x12\xA8\x01\x0A\x11BatchGetDocuments\x128.google.developers.knowledge.v1.BatchGetDocumentsRequest\x1A9.google.developers.knowledge.v1.BatchGetDocumentsResponse\"\x1E\x82\xD3\xE4\x93\x02\x18\x12\x16/v1/documents:batchGet\x12\x92\x01\x0A\x0BAnswerQuery\x122.google.developers.knowledge.v1.AnswerQueryRequest\x1A3.google.developers.knowledge.v1.AnswerQueryResponse\"\x1A\x82\xD3\xE4\x93\x02\x14\"\x0F/v1:answerQuery:\x01*\x1AU\xCAA!developerknowledge.googleapis.com\xD2A.https://www.googleapis.com/auth/cloud-platformB\x83\x02\x0A\"com.google.developers.knowledge.v1B\x17DeveloperKnowledgeProtoP\x01ZAcloud.google.com/go/developerknowledge/apiv1/developerknowledgepb\xAA\x02'Google.Developers.DeveloperKnowledge.V1\xCA\x02'Google\\Developers\\DeveloperKnowledge\\V1\xEA\x02*Google::Developers::DeveloperKnowledge::V1b\x06proto3" , true); static::$is_initialized = true; diff --git a/DeveloperKnowledge/samples/V1/DeveloperKnowledgeClient/batch_get_documents.php b/DeveloperKnowledge/samples/V1/DeveloperKnowledgeClient/batch_get_documents.php index a778eb9627a..b6bf89d828c 100644 --- a/DeveloperKnowledge/samples/V1/DeveloperKnowledgeClient/batch_get_documents.php +++ b/DeveloperKnowledge/samples/V1/DeveloperKnowledgeClient/batch_get_documents.php @@ -38,6 +38,9 @@ * Format: `documents/{uri_without_scheme}` * Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` * + * Each name must not exceed 500 characters; values longer than 500 characters + * will result in an `INVALID_ARGUMENT` error. + * * Please see {@see DeveloperKnowledgeClient::documentName()} for help formatting this field. */ function batch_get_documents_sample(string $formattedNamesElement): void diff --git a/DeveloperKnowledge/samples/V1/DeveloperKnowledgeClient/get_document.php b/DeveloperKnowledge/samples/V1/DeveloperKnowledgeClient/get_document.php index 16d5c083c1c..c759247fd78 100644 --- a/DeveloperKnowledge/samples/V1/DeveloperKnowledgeClient/get_document.php +++ b/DeveloperKnowledge/samples/V1/DeveloperKnowledgeClient/get_document.php @@ -34,7 +34,10 @@ * @param string $formattedName Specifies the name of the document to retrieve. * Format: `documents/{uri_without_scheme}` * Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` - * Please see {@see DeveloperKnowledgeClient::documentName()} for help formatting this field. + * + * The name must not exceed 500 characters; values longer than 500 characters + * will result in an `INVALID_ARGUMENT` error. Please see + * {@see DeveloperKnowledgeClient::documentName()} for help formatting this field. */ function get_document_sample(string $formattedName): void { diff --git a/DeveloperKnowledge/samples/V1/DeveloperKnowledgeClient/search_document_chunks.php b/DeveloperKnowledge/samples/V1/DeveloperKnowledgeClient/search_document_chunks.php index 3ae0b5c9275..ee96f12c710 100644 --- a/DeveloperKnowledge/samples/V1/DeveloperKnowledgeClient/search_document_chunks.php +++ b/DeveloperKnowledge/samples/V1/DeveloperKnowledgeClient/search_document_chunks.php @@ -44,7 +44,9 @@ * [SearchDocumentChunksResponse.results][google.developers.knowledge.v1.SearchDocumentChunksResponse.results]. * * @param string $query Provides the raw query string provided by the user, such as "How - * to create a Cloud Storage bucket?". + * to create a Cloud Storage bucket?". The query must not exceed 500 + * characters; values longer than 500 characters will result in an + * `INVALID_ARGUMENT` error. */ function search_document_chunks_sample(string $query): void { diff --git a/DeveloperKnowledge/src/V1/BatchGetDocumentsRequest.php b/DeveloperKnowledge/src/V1/BatchGetDocumentsRequest.php index ffa22bb77e6..88abc2f0769 100644 --- a/DeveloperKnowledge/src/V1/BatchGetDocumentsRequest.php +++ b/DeveloperKnowledge/src/V1/BatchGetDocumentsRequest.php @@ -22,6 +22,8 @@ class BatchGetDocumentsRequest extends \Google\Protobuf\Internal\Message * same order as the `names` in the request. * Format: `documents/{uri_without_scheme}` * Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + * Each name must not exceed 500 characters; values longer than 500 characters + * will result in an `INVALID_ARGUMENT` error. * * Generated from protobuf field repeated string names = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -49,6 +51,8 @@ class BatchGetDocumentsRequest extends \Google\Protobuf\Internal\Message * same order as the `names` in the request. * Format: `documents/{uri_without_scheme}` * Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + * Each name must not exceed 500 characters; values longer than 500 characters + * will result in an `INVALID_ARGUMENT` error. * @type int $view * Optional. Specifies the * [DocumentView][google.developers.knowledge.v1.DocumentView] of the @@ -68,6 +72,8 @@ public function __construct($data = NULL) { * same order as the `names` in the request. * Format: `documents/{uri_without_scheme}` * Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + * Each name must not exceed 500 characters; values longer than 500 characters + * will result in an `INVALID_ARGUMENT` error. * * Generated from protobuf field repeated string names = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return RepeatedField @@ -83,6 +89,8 @@ public function getNames() * same order as the `names` in the request. * Format: `documents/{uri_without_scheme}` * Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + * Each name must not exceed 500 characters; values longer than 500 characters + * will result in an `INVALID_ARGUMENT` error. * * Generated from protobuf field repeated string names = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string[] $var diff --git a/DeveloperKnowledge/src/V1/Document.php b/DeveloperKnowledge/src/V1/Document.php index dbd870e3662..e1e36029d94 100644 --- a/DeveloperKnowledge/src/V1/Document.php +++ b/DeveloperKnowledge/src/V1/Document.php @@ -9,7 +9,9 @@ use Google\Protobuf\RepeatedField; /** - * A Document represents a piece of content from the Developer Knowledge corpus. + * A Document represents a page of documentation in the Developer Knowledge + * corpus, like the page at + * https://docs.cloud.google.com/storage/docs/creating-buckets. * * Generated from protobuf message google.developers.knowledge.v1.Document */ diff --git a/DeveloperKnowledge/src/V1/GetDocumentRequest.php b/DeveloperKnowledge/src/V1/GetDocumentRequest.php index 7004692d5f5..c257ce30098 100644 --- a/DeveloperKnowledge/src/V1/GetDocumentRequest.php +++ b/DeveloperKnowledge/src/V1/GetDocumentRequest.php @@ -20,6 +20,8 @@ class GetDocumentRequest extends \Google\Protobuf\Internal\Message * Required. Specifies the name of the document to retrieve. * Format: `documents/{uri_without_scheme}` * Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + * The name must not exceed 500 characters; values longer than 500 characters + * will result in an `INVALID_ARGUMENT` error. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -39,7 +41,10 @@ class GetDocumentRequest extends \Google\Protobuf\Internal\Message * @param string $name Required. Specifies the name of the document to retrieve. * Format: `documents/{uri_without_scheme}` * Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` - * Please see {@see DeveloperKnowledgeClient::documentName()} for help formatting this field. + * + * The name must not exceed 500 characters; values longer than 500 characters + * will result in an `INVALID_ARGUMENT` error. Please see + * {@see DeveloperKnowledgeClient::documentName()} for help formatting this field. * * @return \Google\Developers\DeveloperKnowledge\V1\GetDocumentRequest * @@ -61,6 +66,8 @@ public static function build(string $name): self * Required. Specifies the name of the document to retrieve. * Format: `documents/{uri_without_scheme}` * Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + * The name must not exceed 500 characters; values longer than 500 characters + * will result in an `INVALID_ARGUMENT` error. * @type int $view * Optional. Specifies the * [DocumentView][google.developers.knowledge.v1.DocumentView] of the @@ -78,6 +85,8 @@ public function __construct($data = NULL) { * Required. Specifies the name of the document to retrieve. * Format: `documents/{uri_without_scheme}` * Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + * The name must not exceed 500 characters; values longer than 500 characters + * will result in an `INVALID_ARGUMENT` error. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -91,6 +100,8 @@ public function getName() * Required. Specifies the name of the document to retrieve. * Format: `documents/{uri_without_scheme}` * Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + * The name must not exceed 500 characters; values longer than 500 characters + * will result in an `INVALID_ARGUMENT` error. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DeveloperKnowledge/src/V1/SearchDocumentChunksRequest.php b/DeveloperKnowledge/src/V1/SearchDocumentChunksRequest.php index 59b80acae57..cee2bad4af4 100644 --- a/DeveloperKnowledge/src/V1/SearchDocumentChunksRequest.php +++ b/DeveloperKnowledge/src/V1/SearchDocumentChunksRequest.php @@ -18,7 +18,9 @@ class SearchDocumentChunksRequest extends \Google\Protobuf\Internal\Message { /** * Required. Provides the raw query string provided by the user, such as "How - * to create a Cloud Storage bucket?". + * to create a Cloud Storage bucket?". The query must not exceed 500 + * characters; values longer than 500 characters will result in an + * `INVALID_ARGUMENT` error. * * Generated from protobuf field string query = 1 [(.google.api.field_behavior) = REQUIRED]; */ @@ -46,6 +48,8 @@ class SearchDocumentChunksRequest extends \Google\Protobuf\Internal\Message * [DocumentChunk][google.developers.knowledge.v1.DocumentChunk]s, the filter * is applied to `DocumentChunk.document` fields. * Supported fields for filtering: + * * `content_length_bytes` (INTEGER): The length of the `Document.content` + * field in bytes. * * `data_source` (STRING): The source of the document, e.g. * `docs.cloud.google.com`. See * https://developers.google.com/knowledge/reference/corpus-reference for @@ -55,6 +59,7 @@ class SearchDocumentChunksRequest extends \Google\Protobuf\Internal\Message * markdown content or metadata. * * `uri` (STRING): The document URI, e.g. * `https://docs.cloud.google.com/bigquery/docs/tables`. + * INTEGER fields support `=`, `<`, `<=`, `>`, and `>=` operators. * STRING fields support `=` (equals) and `!=` (not equals) operators for * **exact match** on the whole string. Partial match, prefix match, and * regexp match are not supported. @@ -67,6 +72,8 @@ class SearchDocumentChunksRequest extends \Google\Protobuf\Internal\Message * operators. `OR` has higher precedence than `AND`. Use parentheses for * explicit precedence grouping. * Examples: + * * Filter by `Document.content_length_bytes`: + * `content_length_bytes < 50000` * * `data_source = "docs.cloud.google.com" OR data_source = * "firebase.google.com"` * * `data_source != "firebase.google.com"` @@ -89,7 +96,9 @@ class SearchDocumentChunksRequest extends \Google\Protobuf\Internal\Message * * @type string $query * Required. Provides the raw query string provided by the user, such as "How - * to create a Cloud Storage bucket?". + * to create a Cloud Storage bucket?". The query must not exceed 500 + * characters; values longer than 500 characters will result in an + * `INVALID_ARGUMENT` error. * @type int $page_size * Optional. Specifies the maximum number of results to return. The service * may return fewer than this value. @@ -105,6 +114,8 @@ class SearchDocumentChunksRequest extends \Google\Protobuf\Internal\Message * [DocumentChunk][google.developers.knowledge.v1.DocumentChunk]s, the filter * is applied to `DocumentChunk.document` fields. * Supported fields for filtering: + * * `content_length_bytes` (INTEGER): The length of the `Document.content` + * field in bytes. * * `data_source` (STRING): The source of the document, e.g. * `docs.cloud.google.com`. See * https://developers.google.com/knowledge/reference/corpus-reference for @@ -114,6 +125,7 @@ class SearchDocumentChunksRequest extends \Google\Protobuf\Internal\Message * markdown content or metadata. * * `uri` (STRING): The document URI, e.g. * `https://docs.cloud.google.com/bigquery/docs/tables`. + * INTEGER fields support `=`, `<`, `<=`, `>`, and `>=` operators. * STRING fields support `=` (equals) and `!=` (not equals) operators for * **exact match** on the whole string. Partial match, prefix match, and * regexp match are not supported. @@ -126,6 +138,8 @@ class SearchDocumentChunksRequest extends \Google\Protobuf\Internal\Message * operators. `OR` has higher precedence than `AND`. Use parentheses for * explicit precedence grouping. * Examples: + * * Filter by `Document.content_length_bytes`: + * `content_length_bytes < 50000` * * `data_source = "docs.cloud.google.com" OR data_source = * "firebase.google.com"` * * `data_source != "firebase.google.com"` @@ -144,7 +158,9 @@ public function __construct($data = NULL) { /** * Required. Provides the raw query string provided by the user, such as "How - * to create a Cloud Storage bucket?". + * to create a Cloud Storage bucket?". The query must not exceed 500 + * characters; values longer than 500 characters will result in an + * `INVALID_ARGUMENT` error. * * Generated from protobuf field string query = 1 [(.google.api.field_behavior) = REQUIRED]; * @return string @@ -156,7 +172,9 @@ public function getQuery() /** * Required. Provides the raw query string provided by the user, such as "How - * to create a Cloud Storage bucket?". + * to create a Cloud Storage bucket?". The query must not exceed 500 + * characters; values longer than 500 characters will result in an + * `INVALID_ARGUMENT` error. * * Generated from protobuf field string query = 1 [(.google.api.field_behavior) = REQUIRED]; * @param string $var @@ -237,6 +255,8 @@ public function setPageToken($var) * [DocumentChunk][google.developers.knowledge.v1.DocumentChunk]s, the filter * is applied to `DocumentChunk.document` fields. * Supported fields for filtering: + * * `content_length_bytes` (INTEGER): The length of the `Document.content` + * field in bytes. * * `data_source` (STRING): The source of the document, e.g. * `docs.cloud.google.com`. See * https://developers.google.com/knowledge/reference/corpus-reference for @@ -246,6 +266,7 @@ public function setPageToken($var) * markdown content or metadata. * * `uri` (STRING): The document URI, e.g. * `https://docs.cloud.google.com/bigquery/docs/tables`. + * INTEGER fields support `=`, `<`, `<=`, `>`, and `>=` operators. * STRING fields support `=` (equals) and `!=` (not equals) operators for * **exact match** on the whole string. Partial match, prefix match, and * regexp match are not supported. @@ -258,6 +279,8 @@ public function setPageToken($var) * operators. `OR` has higher precedence than `AND`. Use parentheses for * explicit precedence grouping. * Examples: + * * Filter by `Document.content_length_bytes`: + * `content_length_bytes < 50000` * * `data_source = "docs.cloud.google.com" OR data_source = * "firebase.google.com"` * * `data_source != "firebase.google.com"` @@ -283,6 +306,8 @@ public function getFilter() * [DocumentChunk][google.developers.knowledge.v1.DocumentChunk]s, the filter * is applied to `DocumentChunk.document` fields. * Supported fields for filtering: + * * `content_length_bytes` (INTEGER): The length of the `Document.content` + * field in bytes. * * `data_source` (STRING): The source of the document, e.g. * `docs.cloud.google.com`. See * https://developers.google.com/knowledge/reference/corpus-reference for @@ -292,6 +317,7 @@ public function getFilter() * markdown content or metadata. * * `uri` (STRING): The document URI, e.g. * `https://docs.cloud.google.com/bigquery/docs/tables`. + * INTEGER fields support `=`, `<`, `<=`, `>`, and `>=` operators. * STRING fields support `=` (equals) and `!=` (not equals) operators for * **exact match** on the whole string. Partial match, prefix match, and * regexp match are not supported. @@ -304,6 +330,8 @@ public function getFilter() * operators. `OR` has higher precedence than `AND`. Use parentheses for * explicit precedence grouping. * Examples: + * * Filter by `Document.content_length_bytes`: + * `content_length_bytes < 50000` * * `data_source = "docs.cloud.google.com" OR data_source = * "firebase.google.com"` * * `data_source != "firebase.google.com"` diff --git a/DeveloperKnowledge/src/V1/SearchDocumentChunksResponse.php b/DeveloperKnowledge/src/V1/SearchDocumentChunksResponse.php index b1e0b7d8786..087e2ecde11 100644 --- a/DeveloperKnowledge/src/V1/SearchDocumentChunksResponse.php +++ b/DeveloperKnowledge/src/V1/SearchDocumentChunksResponse.php @@ -31,10 +31,11 @@ class SearchDocumentChunksResponse extends \Google\Protobuf\Internal\Message */ private $results; /** - * Optional. Provides a token that can be sent as `page_token` to retrieve the - * next page. If this field is omitted, there are no subsequent pages. + * Provides a token that can be sent as `page_token` to retrieve the next + * page. + * If this field is omitted, there are no subsequent pages. * - * Generated from protobuf field string next_page_token = 2 [(.google.api.field_behavior) = OPTIONAL]; + * Generated from protobuf field string next_page_token = 2; */ protected $next_page_token = ''; @@ -55,8 +56,9 @@ class SearchDocumentChunksResponse extends \Google\Protobuf\Internal\Message * [DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments] * to retrieve the full document content. * @type string $next_page_token - * Optional. Provides a token that can be sent as `page_token` to retrieve the - * next page. If this field is omitted, there are no subsequent pages. + * Provides a token that can be sent as `page_token` to retrieve the next + * page. + * If this field is omitted, there are no subsequent pages. * } */ public function __construct($data = NULL) { @@ -107,10 +109,11 @@ public function setResults($var) } /** - * Optional. Provides a token that can be sent as `page_token` to retrieve the - * next page. If this field is omitted, there are no subsequent pages. + * Provides a token that can be sent as `page_token` to retrieve the next + * page. + * If this field is omitted, there are no subsequent pages. * - * Generated from protobuf field string next_page_token = 2 [(.google.api.field_behavior) = OPTIONAL]; + * Generated from protobuf field string next_page_token = 2; * @return string */ public function getNextPageToken() @@ -119,10 +122,11 @@ public function getNextPageToken() } /** - * Optional. Provides a token that can be sent as `page_token` to retrieve the - * next page. If this field is omitted, there are no subsequent pages. + * Provides a token that can be sent as `page_token` to retrieve the next + * page. + * If this field is omitted, there are no subsequent pages. * - * Generated from protobuf field string next_page_token = 2 [(.google.api.field_behavior) = OPTIONAL]; + * Generated from protobuf field string next_page_token = 2; * @param string $var * @return $this */