Show / Hide Table of Contents

Class IndexSchema

The index schema details.

Inheritance
object
IndexSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.GenerativeaiagentService.Models
Assembly: OCI.DotNetSDK.Generativeaiagent.dll
Syntax
public class IndexSchema

Properties

BodyKey

Declaration
[Required(ErrorMessage = "BodyKey is required.")]
[JsonProperty(PropertyName = "bodyKey")]
public string BodyKey { get; set; }
Property Value
Type Description
string

Body key name.

Remarks

Required

EmbeddingBodyKey

Declaration
[JsonProperty(PropertyName = "embeddingBodyKey")]
public string EmbeddingBodyKey { get; set; }
Property Value
Type Description
string

Field within customer managed OCI OpenSearch document containing the vector embedding for queries.

TitleKey

Declaration
[JsonProperty(PropertyName = "titleKey")]
public string TitleKey { get; set; }
Property Value
Type Description
string

Title key that stores the Title of a document, if available.

UrlKey

Declaration
[JsonProperty(PropertyName = "urlKey")]
public string UrlKey { get; set; }
Property Value
Type Description
string

URL key that stores the URL of a document, if available.

In this article
Back to top