IndexSchema¶

class oci.generative_ai_agent.models.IndexSchema(**kwargs)¶

Bases: object

IndexSchema

The index schema details.

Methods

__init__(**kwargs) Initializes a new IndexSchema object with values from keyword arguments.

Attributes

`body_key`	[Required] Gets the body_key of this IndexSchema.
`embedding_body_key`	Gets the embedding_body_key of this IndexSchema.
`title_key`	Gets the title_key of this IndexSchema.
`url_key`	Gets the url_key of this IndexSchema.

__init__(**kwargs)¶

Initializes a new IndexSchema object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:	body_key (str) – The value to assign to the body_key property of this IndexSchema. url_key (str) – The value to assign to the url_key property of this IndexSchema. title_key (str) – The value to assign to the title_key property of this IndexSchema. embedding_body_key (str) – The value to assign to the embedding_body_key property of this IndexSchema.

body_key¶

[Required] Gets the body_key of this IndexSchema. Body key name.

Returns:	The body_key of this IndexSchema.
Return type:	str

embedding_body_key¶

Gets the embedding_body_key of this IndexSchema. Field within customer managed OCI OpenSearch document containing the vector embedding for queries.

Returns:	The embedding_body_key of this IndexSchema.
Return type:	str

title_key¶

Gets the title_key of this IndexSchema. Title key that stores the Title of a document, if available.

Returns:	The title_key of this IndexSchema.
Return type:	str

url_key¶

Gets the url_key of this IndexSchema. URL key that stores the URL of a document, if available.

Returns:	The url_key of this IndexSchema.
Return type:	str