GroundingMetadata¶
-
class
oci.generative_ai_inference.models.
GroundingMetadata
(**kwargs)¶ Bases:
object
Grounding metadata.
Methods
__init__
(**kwargs)Initializes a new GroundingMetadata object with values from keyword arguments. Attributes
grounding_chunks
Gets the grounding_chunks of this GroundingMetadata. grounding_supports
Gets the grounding_supports of this GroundingMetadata. search_entry_point
Gets the search_entry_point of this GroundingMetadata. web_search_queries
Gets the web_search_queries of this GroundingMetadata. -
__init__
(**kwargs)¶ Initializes a new GroundingMetadata object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
Parameters: - web_search_queries (list[str]) – The value to assign to the web_search_queries property of this GroundingMetadata.
- search_entry_point (oci.generative_ai_inference.models.SearchEntryPoint) – The value to assign to the search_entry_point property of this GroundingMetadata.
- grounding_chunks (list[oci.generative_ai_inference.models.GroundingChunk]) – The value to assign to the grounding_chunks property of this GroundingMetadata.
- grounding_supports (list[oci.generative_ai_inference.models.GroundingSupport]) – The value to assign to the grounding_supports property of this GroundingMetadata.
-
grounding_chunks
¶ Gets the grounding_chunks of this GroundingMetadata. Array of objects containing the web sources.
Returns: The grounding_chunks of this GroundingMetadata. Return type: list[oci.generative_ai_inference.models.GroundingChunk]
-
grounding_supports
¶ Gets the grounding_supports of this GroundingMetadata. Array of chunks to connect model response text to the sources in groundingChunks.
Returns: The grounding_supports of this GroundingMetadata. Return type: list[oci.generative_ai_inference.models.GroundingSupport]
-
search_entry_point
¶ Gets the search_entry_point of this GroundingMetadata.
Returns: The search_entry_point of this GroundingMetadata. Return type: oci.generative_ai_inference.models.SearchEntryPoint
-
web_search_queries
¶ Gets the web_search_queries of this GroundingMetadata. The queries to be used for Search suggestions.
Returns: The web_search_queries of this GroundingMetadata. Return type: list[str]
-