QueryDocumentRequest class final

Request for querying a Document.

Inheritance
  • Object
  • ProtoMessage
  • QueryDocumentRequest

Constructors

QueryDocumentRequest({required String name, required String query, int resultsCount = 0, List<MetadataFilter> metadataFilters = const []})
QueryDocumentRequest.fromJson(Object? j)
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
metadataFilters → List<MetadataFilter>
Optional. Filter for Chunk metadata. Each MetadataFilter object should correspond to a unique key. Multiple MetadataFilter objects are joined by logical "AND"s.
final
name → String
Required. The name of the Document to query. Example: corpora/my-corpus-123/documents/the-doc-abc
final
qualifiedName → String
The fully qualified name of this message, i.e., google.protobuf.Duration or google.rpc.ErrorInfo.
finalinherited
query → String
Required. Query string to perform semantic search.
final
resultsCount → int
Optional. The maximum number of Chunks to return. The service may return fewer Chunks.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Object
override
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

fullyQualifiedName → const String