Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class RetrievedContext.
Chunk from context retrieved by the retrieval tools.
Generated from protobuf message google.cloud.aiplatform.v1.GroundingChunk.RetrievedContext
Namespace
Google \ Cloud \ AIPlatform \ V1 \ GroundingChunkMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ rag_chunk |
Google\Cloud\AIPlatform\V1\RagChunk
Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. |
↳ uri |
string
URI reference of the attribution. |
↳ title |
string
Title of the attribution. |
↳ text |
string
Text of the attribution. |
↳ document_name |
string
Output only. The full document name for the referenced Vertex AI Search document. |
getRagChunk
Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\RagChunk|null |
|
hasRagChunk
setRagChunk
Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\RagChunk
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUri
URI reference of the attribution.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasUri
clearUri
setUri
URI reference of the attribution.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTitle
Title of the attribution.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasTitle
clearTitle
setTitle
Title of the attribution.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getText
Text of the attribution.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasText
clearText
setText
Text of the attribution.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDocumentName
Output only. The full document name for the referenced Vertex AI Search document.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDocumentName
clearDocumentName
setDocumentName
Output only. The full document name for the referenced Vertex AI Search document.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getContextDetails
| Returns | |
|---|---|
| Type | Description |
string |
|