Corpora

Yöntem: corpora.create

Boş bir Corpus oluşturur.

Uç nokta

post https://generativelanguage.googleapis.com/v1beta/corpora

İstek içeriği

İstek metni, Corpus öğesinin bir örneğini içerir.

Alanlar
name string

Değişmez. Tanımlayıcı. Corpus kaynak adı. Kimlik ("corpora/" ön eki hariç ad) en fazla 40 karakter içerebilir. Bu karakterler küçük harf alfanümerik veya kısa çizgi (-) olabilir. Kimlik, kısa çizgiyle başlayamaz veya bitemez. Oluşturma sırasında ad boşsa displayName öğesinden 12 karakterlik rastgele bir sonek eklenerek benzersiz bir ad türetilir. Örnek: corpora/my-awesome-corpora-123a456b789c

displayName string

İsteğe bağlı. Corpus için kullanıcılar tarafından okunabilir görünen ad. Görünen ad, boşluklar dahil olmak üzere 512 karakterden uzun olmamalıdır. Örnek: "Docs on Semantic Retriever" (Anlamsal Alıcı ile Dokümanlar)

Yanıt gövdesi

Başarılı olursa yanıt gövdesi, Corpus öğesinin yeni oluşturulmuş bir örneğini içerir.

Yöntem: corpora.query

Corpus üzerinde semantik arama yapar.

Uç nokta

post https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

Yol parametreleri

name string

Zorunlu. Sorgulanacak Corpus öğesinin adı. Örnek: corpora/my-corpus-123 corpora/{corpora} biçimindedir.

İstek içeriği

İstek metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
query string

Zorunlu. Semantik arama yapmak için kullanılan sorgu dizesi.

metadataFilters[] object (MetadataFilter)

İsteğe bağlı. Chunk ve Document meta verileri için filtreleme yapın. Her MetadataFilter nesnesi benzersiz bir anahtara karşılık gelmelidir. Birden fazla MetadataFilter nesne, mantıksal "VE" ile birleştirilir.

Belge düzeyinde örnek sorgu: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter nesne listesi: metadataFilters = [ {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]}]

Sayısal değer aralığı için parça düzeyinde örnek sorgu: (year > 2015 AND year <= 2020)

MetadataFilter nesne listesi: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

Not: Aynı anahtar için "VE" yalnızca sayısal değerlerde desteklenir. Dize değerleri yalnızca aynı anahtar için "VEYA"ları destekler.

resultsCount integer

İsteğe bağlı. Döndürülecek maksimum Chunk sayısı. Hizmet daha az Chunk döndürebilir.

Belirtilmemişse en fazla 10 Chunk döndürülür. Belirtilen maksimum sonuç sayısı 100'dür.

Yanıt gövdesi

Alakalı parçaların listesini içeren corpora.query yanıtı.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
relevantChunks[] object (RelevantChunk)

İlgili parçalar.

JSON gösterimi 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Yöntem: corpora.list

Kullanıcıya ait tüm Corpora listelenir.

Uç nokta

get https://generativelanguage.googleapis.com/v1beta/corpora

Sorgu parametreleri

pageSize integer

İsteğe bağlı. Döndürülecek maksimum Corpora sayısı (sayfa başına). Hizmet daha az Corpora döndürebilir.

Belirtilmemişse en fazla 10 Corpora döndürülür. Maksimum boyut sınırı sayfa başına 20 Corpora'tır.

pageToken string

İsteğe bağlı. Önceki bir corpora.list çağrısından alınan sayfa jetonu.

Sonraki sayfayı almak için yanıtta döndürülen nextPageToken değerini sonraki isteğe bağımsız değişken olarak iletin.

Sayfalara ayırma işlemi yapılırken corpora.list öğesine sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

corpora.list öğesinin Corpora öğelerinin sayfalandırılmış listesini içeren yanıtı. Sonuçlar artan corpus.create_time değerine göre sıralanır.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
corpora[] object (Corpus)

Döndürülen derlemeler.

nextPageToken string

Sonraki sayfayı almak için pageToken olarak gönderilebilen bir jeton. Bu alan atlanırsa başka sayfa yoktur.

JSON gösterimi 
{
  "corpora": [
    {
      object (Corpus)
    }
  ],
  "nextPageToken": string
}

Yöntem: corpora.get

Belirli bir Corpus hakkında bilgi alır.

Uç nokta

get https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

Yol parametreleri

name string

Zorunlu. Corpus adı. Örnek: corpora/my-corpus-123 corpora/{corpora} biçimindedir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt metni

Başarılıysa yanıt metni, Corpus öğesinin bir örneğini içerir.

Yöntem: corpora.patch

Corpus öğesini günceller.

Uç nokta

patch https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

Yol parametreleri

corpus.name string

Değişmez. Tanımlayıcı. Corpus kaynak adı. Kimlik ("corpora/" ön eki hariç ad) en fazla 40 karakter içerebilir. Bu karakterler küçük harf alfanümerik veya kısa çizgi (-) olabilir. Kimlik, kısa çizgiyle başlayamaz veya bitemez. Oluşturma sırasında ad boşsa displayName öğesinden 12 karakterlik rastgele bir sonek eklenerek benzersiz bir ad türetilir. Örnek: corpora/my-awesome-corpora-123a456b789c corpora/{corpora} biçimindedir.

Sorgu parametreleri

updateMask string (FieldMask format)

Zorunlu. Güncellenecek alanların listesi. Şu anda yalnızca displayName güncellemesi desteklenmektedir.

Bu, alanların tam nitelikli adlarının virgülle ayrılmış listesidir. Örnek: "user.displayName,photo".

İstek içeriği

İstek metni, Corpus öğesinin bir örneğini içerir.

Alanlar
displayName string

İsteğe bağlı. Corpus için kullanıcılar tarafından okunabilir görünen ad. Görünen ad, boşluklar dahil olmak üzere 512 karakterden uzun olmamalıdır. Örnek: "Docs on Semantic Retriever" (Anlamsal Alıcı ile Dokümanlar)

Yanıt gövdesi

Başarılıysa yanıt metni, Corpus öğesinin bir örneğini içerir.

Yöntem: corpora.delete

Corpus öğesini siler.

Uç nokta

delete https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

Yol parametreleri

name string

Zorunlu. Corpus öğesinin kaynak adı. Örnek: corpora/my-corpus-123 corpora/{corpora} biçimindedir.

Sorgu parametreleri

force boolean

İsteğe bağlı. Doğru olarak ayarlanırsa bu Corpus ile ilgili tüm Document'lar ve nesneler de silinir.

Yanlış (varsayılan) ise Corpus, Document içeriyorsa FAILED_PRECONDITION hatası döndürülür.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Başarılı olursa yanıt gövdesi boş bir JSON nesnesi olur.

REST Kaynağı: corpora.permissions

Kaynak: İzin

İzin kaynağı, kullanıcıya, gruba veya dünyanın geri kalanına PaLM API kaynağına (ör. ayarlanmış bir model, derlem) erişim izni verir.

Rol, kullanıcıların PaLM API kaynaklarında belirli işlemleri gerçekleştirmesine olanak tanıyan, izin verilen işlemlerden oluşan bir koleksiyondur. Bu kaynakları kullanıcılara, gruplara veya hizmet hesaplarına sunmak için roller atarsınız. Bir rol atadığınızda, rolün içerdiği izinleri vermiş olursunuz.

Üç eşmerkezli rol vardır. Her rol, önceki rolün izin verilen işlemlerinin üst kümesidir:

  • Okuyucu, çıkarım için kaynağı (ör.ayarlanmış model, derlem) kullanabilir.
  • yazarın okuyucu izinleri vardır ve ayrıca düzenleme ve paylaşma izni de vardır
  • sahibi, yazma izinlerine sahiptir ve ayrıca silebilir
Alanlar
name string

Yalnızca çıkış. Tanımlayıcı. İzin adı. Oluşturma sırasında benzersiz bir ad oluşturulur. Örnekler: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Yalnızca çıkış.

granteeType enum (GranteeType)

İsteğe bağlı. Değişmez. Hak sahibinin türü.

emailAddress string

İsteğe bağlı. Değişmez. Bu iznin ait olduğu kullanıcı veya grubun e-posta adresi. İzin verilenin türü EVERYONE (HERKES) olduğunda alan ayarlanmaz.

role enum (Role)

Zorunlu. Bu izinle verilen rol.

JSON gösterimi 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

Bu iznin hak sahibinin türlerini tanımlar.

Sıralamalar
GRANTEE_TYPE_UNSPECIFIED Varsayılan değer. Bu değer kullanılmıyor.
USER Bir kullanıcıyı temsil eder. Bu ayar belirlendiğinde kullanıcı için emailAddress'i sağlamanız gerekir.
GROUP Bir grubu temsil eder. Ayarlanmışsa grup için emailAddress değerini sağlamanız gerekir.
EVERYONE Herkese erişimi temsil eder. Ek bilgi gerekmez.

Rol

Bu izinle verilen rolü tanımlar.

Sıralamalar
ROLE_UNSPECIFIED Varsayılan değer. Bu değer kullanılmıyor.
OWNER Sahip, kaynağı kullanabilir, güncelleyebilir, paylaşabilir ve silebilir.
WRITER Yazar, kaynağı kullanabilir, güncelleyebilir ve paylaşabilir.
READER Okuyucu, kaynağı kullanabilir.

MetadataFilter

Kullanıcı tarafından sağlanan filtre, Chunk veya Document düzeyindeki meta veri değerlerine göre almayı sınırlar. Örnek (tür = drama VEYA tür = aksiyon): key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]

Alanlar
key string

Zorunlu. Filtrelenecek meta verilerin anahtarı.

conditions[] object (Condition)

Zorunlu. Belirli bir anahtar için bu filtreyi tetikleyecek Condition. Birden fazla Condition, mantıksal VEYA'larla birleştirilir.

JSON gösterimi 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}

Koşul

Tek bir anahtar için geçerli olan filtre koşulu.

Alanlar
operation enum (Operator)

Zorunlu. Koşulu tetiklemek için belirli anahtar/değer çiftine uygulanan operatör.

value Union type
Değer türü, ilgili anahtarın alanında tanımlanan değer türüyle tutarlı olmalıdır. Değer türleri tutarlı değilse sonuç boş bir küme olur. CustomMetadata, StringList değer türüne sahip olduğunda filtreleme koşulu, INCLUDES/EXCLUDES işlemiyle birlikte string_value kullanmalıdır. Aksi takdirde sonuç da boş bir küme olur. value yalnızca aşağıdakilerden biri olabilir:
stringValue string

Meta verilerin filtreleneceği dize değeri.

numericValue number

Meta verilerin filtreleneceği sayısal değer.

JSON gösterimi 
{
  "operation": enum (Operator),

  // value
  "stringValue": string,
  "numericValue": number
  // Union type
}

Operatör

Bir anahtar/değer çiftine uygulanabilecek geçerli operatörleri tanımlar.

Sıralamalar
OPERATOR_UNSPECIFIED Varsayılan değer. Bu değer kullanılmıyor.
LESS Sayısal değerler desteklenir.
LESS_EQUAL Sayısal değerler desteklenir.
EQUAL Sayısal ve dize tarafından desteklenir.
GREATER_EQUAL Sayısal değerler desteklenir.
GREATER Sayısal değerler desteklenir.
NOT_EQUAL Sayısal ve dize tarafından desteklenir.
INCLUDES Yalnızca, belirli bir anahtarın CustomMetadata değer türü stringListValue içerdiğinde dize tarafından desteklenir.
EXCLUDES Yalnızca, belirli bir anahtarın CustomMetadata değer türü stringListValue içerdiğinde dize tarafından desteklenir.

RelevantChunk

Bir sorguyla alakalı bir parça hakkındaki bilgiler.

Alanlar
chunkRelevanceScore number

Chunk sorguyla alaka düzeyi.

chunk object (Chunk)

Chunk sorguyla ilişkilendirilir.

document object (Document)

Parçayla ilişkilendirilmiş Document.

JSON gösterimi 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  },
  "document": {
    object (Document)
  }
}

REST Kaynağı: corpora

Kaynak: Corpus

Corpus, Document koleksiyonudur. Bir proje en fazla 5 korpus oluşturabilir.

Alanlar
name string

Değişmez. Tanımlayıcı. Corpus kaynak adı. Kimlik ("corpora/" ön eki hariç ad) en fazla 40 karakter içerebilir. Bu karakterler küçük harf alfanümerik veya kısa çizgi (-) olabilir. Kimlik, kısa çizgiyle başlayamaz veya bitemez. Oluşturma sırasında ad boşsa displayName öğesinden 12 karakterlik rastgele bir sonek eklenerek benzersiz bir ad türetilir. Örnek: corpora/my-awesome-corpora-123a456b789c

displayName string

İsteğe bağlı. Corpus için kullanıcılar tarafından okunabilir görünen ad. Görünen ad, boşluklar dahil olmak üzere 512 karakterden uzun olmamalıdır. Örnek: "Docs on Semantic Retriever" (Anlamsal Alıcı ile Dokümanlar)

createTime string (Timestamp format)

Yalnızca çıkış. Corpus oluşturulduğu zamanın zaman damgası.

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanır. "Z" dışındaki saat farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Yalnızca çıkış. Corpus öğesinin en son güncellendiği zamanın zaman damgası.

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanır. "Z" dışındaki saat farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

JSON gösterimi 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}