Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ChunkInfo.
Chunk information.
Generated from protobuf message google.cloud.discoveryengine.v1.Answer.Reference.ChunkInfo
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ Answer \ ReferenceMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ chunk |
string
Chunk resource name. |
↳ content |
string
Chunk textual content. |
↳ relevance_score |
float
The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. |
↳ document_metadata |
ChunkInfo\DocumentMetadata
Document metadata. |
getChunk
Chunk resource name.
| Returns | |
|---|---|
| Type | Description |
string |
|
setChunk
Chunk resource name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getContent
Chunk textual content.
| Returns | |
|---|---|
| Type | Description |
string |
|
setContent
Chunk textual content.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRelevanceScore
The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant).
This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasRelevanceScore
clearRelevanceScore
setRelevanceScore
The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant).
This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDocumentMetadata
Document metadata.
| Returns | |
|---|---|
| Type | Description |
ChunkInfo\DocumentMetadata|null |
|
hasDocumentMetadata
clearDocumentMetadata
setDocumentMetadata
Document metadata.
| Parameter | |
|---|---|
| Name | Description |
var |
ChunkInfo\DocumentMetadata
|
| Returns | |
|---|---|
| Type | Description |
$this |
|