Skip to content

Commit ffe458d

Browse files
committed
docs: fix property docstrings
1 parent 551095c commit ffe458d

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

models/hybrid_search_retreiver.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ class HybridSearchRetriever:
8888
# prompting wrapper
8989
@property
9090
def chat(self):
91-
"""ChatOpenAI read-only property."""
91+
"""ChatOpenAI lazy read-only property."""
9292
if self._chat is None:
9393
self._chat = ChatOpenAI(
9494
api_key=Credentials.OPENAI_API_KEY,
@@ -103,7 +103,7 @@ def chat(self):
103103
# embeddings
104104
@property
105105
def openai_embeddings(self):
106-
"""OpenAIEmbeddings read-only property."""
106+
"""OpenAIEmbeddings lazy read-only property."""
107107
if self._openai_embeddings is None:
108108
self._openai_embeddings = OpenAIEmbeddings(
109109
api_key=Credentials.OPENAI_API_KEY, organization=Credentials.OPENAI_API_ORGANIZATION
@@ -112,14 +112,14 @@ def openai_embeddings(self):
112112

113113
@property
114114
def pinecone_index(self):
115-
"""pinecone.Index read-only property."""
115+
"""pinecone.Index lazy read-only property."""
116116
if self._pinecone_index is None:
117117
self._pinecone_index = pinecone.Index(index_name=Config.PINECONE_INDEX_NAME)
118118
return self._pinecone_index
119119

120120
@property
121121
def vector_store(self):
122-
"""Pinecone read-only property."""
122+
"""Pinecone lazy read-only property."""
123123
if self._vector_store is None:
124124
self._vector_store = Pinecone(
125125
index=self.pinecone_index,
@@ -130,14 +130,14 @@ def vector_store(self):
130130

131131
@property
132132
def text_splitter(self):
133-
"""TextSplitter read-only property."""
133+
"""TextSplitter lazy read-only property."""
134134
if self._text_splitter is None:
135135
self._text_splitter = TextSplitter()
136136
return self._text_splitter
137137

138138
@property
139139
def bm25_encoder(self):
140-
"""BM25Encoder read-only property."""
140+
"""BM25Encoder lazy read-only property."""
141141
if self._b25_encoder is None:
142142
self._b25_encoder = BM25Encoder().default()
143143
return self._b25_encoder

0 commit comments

Comments
 (0)